eZPublishCommunityProject  2013.4
eZ\Publish\Core\REST\Server\Controller\ContentType Class Reference

ContentType controller. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Server\Controller\ContentType:
+ Collaboration diagram for eZ\Publish\Core\REST\Server\Controller\ContentType:

Public Member Functions

 __construct (ContentTypeService $contentTypeService)
 Construct controller. More...
 
 addFieldDefinition ()
 Creates a new field definition for the given content type. More...
 
 copyContentType ()
 Copies a content type. More...
 
 createContentType ()
 Creates a new content type draft in the given content type group. More...
 
 createContentTypeDraft ()
 Creates a draft and updates it with the given data. More...
 
 createContentTypeGroup ()
 Creates a new content type group. More...
 
 deleteContentType ()
 The given content type is deleted. More...
 
 deleteContentTypeDraft ()
 The given content type draft is deleted. More...
 
 deleteContentTypeGroup ()
 The given content type group is deleted. More...
 
 linkContentTypeToGroup ()
 Links a content type group to the content type and returns the updated group list. More...
 
 listContentTypes ()
 Returns a list of content types. More...
 
 listContentTypesForGroup ()
 Returns a list of content types of the group. More...
 
 loadContentType ()
 Loads a content type. More...
 
 loadContentTypeByIdentifier ()
 Loads a content type by its identifier. More...
 
 loadContentTypeByRemoteId ()
 Loads a content type by its remote ID. More...
 
 loadContentTypeDraft ()
 Loads a content type draft. More...
 
 loadContentTypeGroup ()
 Returns the content type group given by id. More...
 
 loadContentTypeGroupList ()
 Returns a list of all content type groups. More...
 
 loadDraftFieldDefinition ()
 Returns the draft field definition given by id. More...
 
 loadDraftFieldDefinitionList ()
 Loads field definitions for a given content type draft. More...
 
 loadFieldDefinition ()
 Returns the field definition given by id. More...
 
 loadFieldDefinitionList ()
 Loads field definitions for a given content type. More...
 
 loadGroupsOfContentType ()
 Returns the content type groups the content type belongs to. More...
 
 publishContentTypeDraft ()
 Publishes a content type draft. More...
 
 removeFieldDefinition ()
 The given field definition is deleted. More...
 
 unlinkContentTypeFromGroup ()
 Removes the given group from the content type and returns the updated group list. More...
 
 updateContentTypeDraft ()
 Updates meta data of a draft. More...
 
 updateContentTypeGroup ()
 Updates a content type group. More...
 
 updateFieldDefinition ()
 Updates the attributes of a field definition. More...
 
- Public Member Functions inherited from eZ\Publish\Core\REST\Server\Controller
 setContainer (Container $container)
 
 setInputDispatcher (InputDispatcher $inputDispatcher)
 
 setRequest (HttpRequest $request)
 
 setUrlHandler (UrlHandler $urlHandler)
 

Protected Attributes

 $contentTypeService
 
- Protected Attributes inherited from eZ\Publish\Core\REST\Server\Controller
 $container
 
 $inputDispatcher
 
 $request
 
 $urlHandler
 

Private Member Functions

 getMediaType ()
 Extracts the requested media type from $request. More...
 
 mapToGroupUpdateStruct (ContentTypeGroupCreateStruct $createStruct)
 Converts the provided ContentTypeGroupCreateStruct to ContentTypeGroupUpdateStruct. More...
 

Detailed Description

ContentType controller.

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Server\Controller\ContentType::__construct ( ContentTypeService  $contentTypeService)

Construct controller.

Parameters
\eZ\Publish\API\Repository\ContentTypeService$contentTypeService

Member Function Documentation

eZ\Publish\Core\REST\Server\Controller\ContentType::addFieldDefinition ( )

Creates a new field definition for the given content type.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::copyContentType ( )

Copies a content type.

The identifier of the copy is changed to copy_of_<identifier> and a new remoteId is generated.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::createContentType ( )

Creates a new content type draft in the given content type group.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::createContentTypeDraft ( )

Creates a draft and updates it with the given data.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::createContentTypeGroup ( )

Creates a new content type group.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::deleteContentType ( )

The given content type is deleted.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::deleteContentTypeDraft ( )

The given content type draft is deleted.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::deleteContentTypeGroup ( )

The given content type group is deleted.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::getMediaType ( )
private
eZ\Publish\Core\REST\Server\Controller\ContentType::linkContentTypeToGroup ( )

Links a content type group to the content type and returns the updated group list.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::listContentTypes ( )

Returns a list of content types.

Returns
|
eZ\Publish\Core\REST\Server\Controller\ContentType::listContentTypesForGroup ( )

Returns a list of content types of the group.

Returns
|
eZ\Publish\Core\REST\Server\Controller\ContentType::loadContentType ( )

Loads a content type.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::loadContentTypeByIdentifier ( )

Loads a content type by its identifier.

Returns

Referenced by eZ\Publish\Core\REST\Server\Controller\ContentType\listContentTypes().

eZ\Publish\Core\REST\Server\Controller\ContentType::loadContentTypeByRemoteId ( )

Loads a content type by its remote ID.

Returns

Referenced by eZ\Publish\Core\REST\Server\Controller\ContentType\listContentTypes().

eZ\Publish\Core\REST\Server\Controller\ContentType::loadContentTypeDraft ( )

Loads a content type draft.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::loadContentTypeGroup ( )

Returns the content type group given by id.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::loadContentTypeGroupList ( )

Returns a list of all content type groups.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::loadDraftFieldDefinition ( )

Returns the draft field definition given by id.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::loadDraftFieldDefinitionList ( )

Loads field definitions for a given content type draft.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::loadFieldDefinition ( )

Returns the field definition given by id.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::loadFieldDefinitionList ( )

Loads field definitions for a given content type.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::loadGroupsOfContentType ( )

Returns the content type groups the content type belongs to.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::mapToGroupUpdateStruct ( ContentTypeGroupCreateStruct  $createStruct)
private

Converts the provided ContentTypeGroupCreateStruct to ContentTypeGroupUpdateStruct.

Parameters
\eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroupCreateStruct$createStruct
Returns

Referenced by eZ\Publish\Core\REST\Server\Controller\ContentType\updateContentTypeGroup().

eZ\Publish\Core\REST\Server\Controller\ContentType::publishContentTypeDraft ( )

Publishes a content type draft.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::removeFieldDefinition ( )

The given field definition is deleted.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::unlinkContentTypeFromGroup ( )

Removes the given group from the content type and returns the updated group list.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::updateContentTypeDraft ( )

Updates meta data of a draft.

This method does not handle field definitions

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::updateContentTypeGroup ( )

Updates a content type group.

Returns
eZ\Publish\Core\REST\Server\Controller\ContentType::updateFieldDefinition ( )

Updates the attributes of a field definition.

Returns

Member Data Documentation

eZ\Publish\Core\REST\Server\Controller\ContentType::$contentTypeService
protected

The documentation for this class was generated from the following file: