PHP Class eZ\Publish\Core\REST\Server\Controller\ContentType

Inheritance: extends eZ\Publish\Core\REST\Server\Controller
Afficher le fichier Open project: ezsystems/ezpublish-kernel

Protected Properties

Свойство Type Description
$contentTypeService eZ\Publish\API\Repository\ContentTypeService Content type service.

Méthodes publiques

Méthode Description
__construct ( eZ\Publish\API\Repository\ContentTypeService $contentTypeService ) Construct controller.
addContentTypeDraftFieldDefinition ( $contentTypeId, Request $request ) : CreatedFieldDefinition Creates a new field definition for the given content type draft.
copyContentType ( $contentTypeId ) : ResourceCreated Copies a content type. The identifier of the copy is changed to copy_of__ and a new remoteId is generated.
createContentType ( $contentTypeGroupId, Request $request ) : CreatedContentType Creates a new content type draft in the given content type group.
createContentTypeDraft ( $contentTypeId, Request $request ) : CreatedContentType Creates a draft and updates it with the given data.
createContentTypeGroup ( Request $request ) : CreatedContentTypeGroup Creates a new content type group.
deleteContentType ( $contentTypeId ) : eZ\Publish\Core\REST\Server\Values\NoContent The given content type is deleted.
deleteContentTypeDraft ( $contentTypeId ) : eZ\Publish\Core\REST\Server\Values\NoContent The given content type draft is deleted.
deleteContentTypeGroup ( mixed $contentTypeGroupId ) : eZ\Publish\Core\REST\Server\Values\NoContent The given content type group is deleted.
linkContentTypeToGroup ( mixed $contentTypeId, Request $request ) : ContentTypeGroupRefList Links a content type group to the content type and returns the updated group list.
listContentTypes ( Request $request ) : ContentTypeList | ContentTypeInfoList Returns a list of content types.
listContentTypesForGroup ( string $contentTypeGroupId, Request $request ) : ContentTypeList | ContentTypeInfoList Returns a list of content types of the group.
loadContentType ( $contentTypeId ) : RestContentType Loads a content type.
loadContentTypeByIdentifier ( Request $request ) : eZ\Publish\API\Repository\Values\ContentType\ContentType Loads a content type by its identifier.
loadContentTypeByRemoteId ( Request $request ) : eZ\Publish\API\Repository\Values\ContentType\ContentType Loads a content type by its remote ID.
loadContentTypeDraft ( $contentTypeId ) : RestContentType Loads a content type draft.
loadContentTypeDraftFieldDefinition ( $contentTypeId, $fieldDefinitionId, Request $request ) : RestFieldDefinition Returns the draft field definition given by id.
loadContentTypeDraftFieldDefinitionList ( $contentTypeId ) : FieldDefinitionList Loads field definitions for a given content type draft.
loadContentTypeFieldDefinition ( $contentTypeId, $fieldDefinitionId, Request $request ) : RestFieldDefinition Returns the field definition given by id.
loadContentTypeFieldDefinitionList ( $contentTypeId ) : FieldDefinitionList Loads field definitions for a given content type.
loadContentTypeGroup ( $contentTypeGroupId ) : eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup Returns the content type group given by id.
loadContentTypeGroupList ( Request $request ) : ContentTypeGroupList Returns a list of all content type groups.
loadGroupsOfContentType ( $contentTypeId ) : ContentTypeGroupRefList Returns the content type groups the content type belongs to.
publishContentTypeDraft ( $contentTypeId ) : RestContentType Publishes a content type draft.
removeContentTypeDraftFieldDefinition ( $contentTypeId, $fieldDefinitionId, Request $request ) : eZ\Publish\Core\REST\Server\Values\NoContent Deletes a field definition from a content type draft.
unlinkContentTypeFromGroup ( $contentTypeId, $contentTypeGroupId ) : ContentTypeGroupRefList Removes the given group from the content type and returns the updated group list.
updateContentTypeDraft ( $contentTypeId, Request $request ) : RestContentType Updates meta data of a draft. This method does not handle field definitions.
updateContentTypeDraftFieldDefinition ( $contentTypeId, $fieldDefinitionId, Request $request ) : FieldDefinitionList Updates the attributes of a field definition.
updateContentTypeGroup ( $contentTypeGroupId, Request $request ) : eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup Updates a content type group.

Méthodes protégées

Méthode Description
getContentTypeList ( ) : ContentType[]
sortContentTypeList ( array &$contentTypes, string $orderby, $sort = 'asc' ) : mixed

Private Methods

Méthode Description
mapToGroupUpdateStruct ( eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroupCreateStruct $createStruct ) : eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroupUpdateStruct Converts the provided ContentTypeGroupCreateStruct to ContentTypeGroupUpdateStruct.

Method Details

__construct() public méthode

Construct controller.
public __construct ( eZ\Publish\API\Repository\ContentTypeService $contentTypeService )
$contentTypeService eZ\Publish\API\Repository\ContentTypeService

addContentTypeDraftFieldDefinition() public méthode

Creates a new field definition for the given content type draft.
public addContentTypeDraftFieldDefinition ( $contentTypeId, Request $request ) : CreatedFieldDefinition
$contentTypeId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\CreatedFieldDefinition

copyContentType() public méthode

Copies a content type. The identifier of the copy is changed to copy_of__ and a new remoteId is generated.
public copyContentType ( $contentTypeId ) : ResourceCreated
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\ResourceCreated

createContentType() public méthode

Creates a new content type draft in the given content type group.
public createContentType ( $contentTypeGroupId, Request $request ) : CreatedContentType
$contentTypeGroupId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\CreatedContentType

createContentTypeDraft() public méthode

Creates a draft and updates it with the given data.
public createContentTypeDraft ( $contentTypeId, Request $request ) : CreatedContentType
$contentTypeId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\CreatedContentType

createContentTypeGroup() public méthode

Creates a new content type group.
public createContentTypeGroup ( Request $request ) : CreatedContentTypeGroup
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\CreatedContentTypeGroup

deleteContentType() public méthode

The given content type is deleted.
public deleteContentType ( $contentTypeId ) : eZ\Publish\Core\REST\Server\Values\NoContent
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\NoContent

deleteContentTypeDraft() public méthode

The given content type draft is deleted.
public deleteContentTypeDraft ( $contentTypeId ) : eZ\Publish\Core\REST\Server\Values\NoContent
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\NoContent

deleteContentTypeGroup() public méthode

The given content type group is deleted.
public deleteContentTypeGroup ( mixed $contentTypeGroupId ) : eZ\Publish\Core\REST\Server\Values\NoContent
$contentTypeGroupId mixed
Résultat eZ\Publish\Core\REST\Server\Values\NoContent

getContentTypeList() protected méthode

protected getContentTypeList ( ) : ContentType[]
Résultat ContentType[]

linkContentTypeToGroup() public méthode

Links a content type group to the content type and returns the updated group list.
public linkContentTypeToGroup ( mixed $contentTypeId, Request $request ) : ContentTypeGroupRefList
$contentTypeId mixed
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\ContentTypeGroupRefList

listContentTypes() public méthode

Returns a list of content types.
public listContentTypes ( Request $request ) : ContentTypeList | ContentTypeInfoList
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\ContentTypeList | eZ\Publish\Core\REST\Server\Values\ContentTypeInfoList

listContentTypesForGroup() public méthode

Returns a list of content types of the group.
public listContentTypesForGroup ( string $contentTypeGroupId, Request $request ) : ContentTypeList | ContentTypeInfoList
$contentTypeGroupId string
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\ContentTypeList | eZ\Publish\Core\REST\Server\Values\ContentTypeInfoList

loadContentType() public méthode

Loads a content type.
public loadContentType ( $contentTypeId ) : RestContentType
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\RestContentType

loadContentTypeByIdentifier() public méthode

Loads a content type by its identifier.
public loadContentTypeByIdentifier ( Request $request ) : eZ\Publish\API\Repository\Values\ContentType\ContentType
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\API\Repository\Values\ContentType\ContentType

loadContentTypeByRemoteId() public méthode

Loads a content type by its remote ID.
public loadContentTypeByRemoteId ( Request $request ) : eZ\Publish\API\Repository\Values\ContentType\ContentType
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\API\Repository\Values\ContentType\ContentType

loadContentTypeDraft() public méthode

Loads a content type draft.
public loadContentTypeDraft ( $contentTypeId ) : RestContentType
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\RestContentType

loadContentTypeDraftFieldDefinition() public méthode

Returns the draft field definition given by id.
public loadContentTypeDraftFieldDefinition ( $contentTypeId, $fieldDefinitionId, Request $request ) : RestFieldDefinition
$contentTypeId
$fieldDefinitionId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\RestFieldDefinition

loadContentTypeDraftFieldDefinitionList() public méthode

Loads field definitions for a given content type draft.
public loadContentTypeDraftFieldDefinitionList ( $contentTypeId ) : FieldDefinitionList
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\FieldDefinitionList

loadContentTypeFieldDefinition() public méthode

Returns the field definition given by id.
public loadContentTypeFieldDefinition ( $contentTypeId, $fieldDefinitionId, Request $request ) : RestFieldDefinition
$contentTypeId
$fieldDefinitionId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\RestFieldDefinition

loadContentTypeFieldDefinitionList() public méthode

Loads field definitions for a given content type.
public loadContentTypeFieldDefinitionList ( $contentTypeId ) : FieldDefinitionList
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\FieldDefinitionList

loadContentTypeGroup() public méthode

Returns the content type group given by id.
public loadContentTypeGroup ( $contentTypeGroupId ) : eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup
$contentTypeGroupId
Résultat eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup

loadContentTypeGroupList() public méthode

Returns a list of all content type groups.
public loadContentTypeGroupList ( Request $request ) : ContentTypeGroupList
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\ContentTypeGroupList

loadGroupsOfContentType() public méthode

Returns the content type groups the content type belongs to.
public loadGroupsOfContentType ( $contentTypeId ) : ContentTypeGroupRefList
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\ContentTypeGroupRefList

publishContentTypeDraft() public méthode

Publishes a content type draft.
public publishContentTypeDraft ( $contentTypeId ) : RestContentType
$contentTypeId
Résultat eZ\Publish\Core\REST\Server\Values\RestContentType

removeContentTypeDraftFieldDefinition() public méthode

Deletes a field definition from a content type draft.
public removeContentTypeDraftFieldDefinition ( $contentTypeId, $fieldDefinitionId, Request $request ) : eZ\Publish\Core\REST\Server\Values\NoContent
$contentTypeId
$fieldDefinitionId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\NoContent

sortContentTypeList() protected méthode

protected sortContentTypeList ( array &$contentTypes, string $orderby, $sort = 'asc' ) : mixed
$contentTypes array
$orderby string
Résultat mixed

unlinkContentTypeFromGroup() public méthode

Removes the given group from the content type and returns the updated group list.
public unlinkContentTypeFromGroup ( $contentTypeId, $contentTypeGroupId ) : ContentTypeGroupRefList
$contentTypeId
$contentTypeGroupId
Résultat eZ\Publish\Core\REST\Server\Values\ContentTypeGroupRefList

updateContentTypeDraft() public méthode

Updates meta data of a draft. This method does not handle field definitions.
public updateContentTypeDraft ( $contentTypeId, Request $request ) : RestContentType
$contentTypeId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\RestContentType

updateContentTypeDraftFieldDefinition() public méthode

Updates the attributes of a field definition.
public updateContentTypeDraftFieldDefinition ( $contentTypeId, $fieldDefinitionId, Request $request ) : FieldDefinitionList
$contentTypeId
$fieldDefinitionId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\Core\REST\Server\Values\FieldDefinitionList

updateContentTypeGroup() public méthode

Updates a content type group.
public updateContentTypeGroup ( $contentTypeGroupId, Request $request ) : eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup
$contentTypeGroupId
$request Symfony\Component\HttpFoundation\Request
Résultat eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup

Property Details

$contentTypeService protected_oe property

Content type service.
protected ContentTypeService,eZ\Publish\API\Repository $contentTypeService
Résultat eZ\Publish\API\Repository\ContentTypeService