PHP Class eZ\Publish\Core\REST\Client\Values\ContentType\ContentType

Inheritance: extends eZ\Publish\API\Repository\Values\ContentType\ContentType

Show file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property	Type	Description
$contentTypeGroupListReference	string	Contains the URL for the list of ContentTypeGroups for the ContentType.
$contentTypeService	eZ\Publish\Core\REST\Client\ContentTypeService	Content type service to fetch additional information from.
$descriptions	string[]	Contains the human readable description of the content type.
$fieldDefinitionListReference	string	Carries the URL for the list of FieldDefinitions for the type.
$names	string[]	Contains the human readable name in all provided languages of the content type.

Public Methods

Method	Description
__construct ( ContentTypeService $contentTypeService, array $data = [] )
__get ( string $property ) : mixed	Magic getter for retrieving convenience properties.
__isset ( string $property ) : boolean	Magic isset for signaling existence of convenience properties.
getContentTypeGroups ( ) : eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup[]	This method returns the content type groups this content type is assigned to.
getDescription ( string $languageCode ) : string	This method returns the name of the content type in the given language.
getDescriptions ( ) : string[]	This method returns the human readable description of the content type.
getFieldDefinition ( string $fieldDefinitionIdentifier ) : FieldDefinition	This method returns the field definition for the given identifier.
getFieldDefinitions ( ) : eZ\Publish\API\Repository\Values\ContentType\FieldDefinition[]	This method returns the content type field definitions from this type.
getName ( string $languageCode ) : string	This method returns the name of the content type in the given language.
getNames ( ) : string[]	This method returns the human readable name in all provided languages of the content type.

Method Details

__construct() public method

public __construct ( ContentTypeService $contentTypeService, array $data = [] )
$contentTypeService	eZ\Publish\Core\REST\Client\ContentTypeService
$data	array

__get() public method

Magic getter for retrieving convenience properties.

public __get ( string $property ) : mixed
$property	string	The name of the property to retrieve
return	mixed

__isset() public method

Magic isset for signaling existence of convenience properties.

public __isset ( string $property ) : boolean
$property	string
return	boolean

getContentTypeGroups() public method

This method returns the content type groups this content type is assigned to.

public getContentTypeGroups ( ) : eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup[]
return	eZ\Publish\API\Repository\Values\ContentType\ContentTypeGroup[]

getDescription() public method

This method returns the name of the content type in the given language.

public getDescription ( string $languageCode ) : string
$languageCode	string
return	string	the description for the given language or null if none exists.

getDescriptions() public method

The structure of this field is:


array( 'eng' => '', 'de' => '' );

public getDescriptions ( ) : string[]
return	string[]

getFieldDefinition() public method

This method returns the field definition for the given identifier.

public getFieldDefinition ( string $fieldDefinitionIdentifier ) : FieldDefinition
$fieldDefinitionIdentifier	string
return	FieldDefinition

getFieldDefinitions() public method

This method returns the content type field definitions from this type.

public getFieldDefinitions ( ) : eZ\Publish\API\Repository\Values\ContentType\FieldDefinition[]
return	eZ\Publish\API\Repository\Values\ContentType\FieldDefinition[]

getName() public method

This method returns the name of the content type in the given language.

public getName ( string $languageCode ) : string
$languageCode	string
return	string	the name for the given language or null if none exists.

getNames() public method

The structure of the return value is:


array( 'eng' => '', 'de' => '' );

public getNames ( ) : string[]
return	string[]

Property Details

$contentTypeGroupListReference protected property

Contains the URL for the list of ContentTypeGroups for the ContentType.

protected string $contentTypeGroupListReference
return	string

$contentTypeService protected property

Content type service to fetch additional information from.

protected ContentTypeService,eZ\Publish\Core\REST\Client $contentTypeService
return	eZ\Publish\Core\REST\Client\ContentTypeService

$descriptions protected property

Contains the human readable description of the content type.

protected string[] $descriptions
return	string[]

$fieldDefinitionListReference protected property

Carries the URL for the list of FieldDefinitions for the type.

protected string $fieldDefinitionListReference
return	string

$names protected property

Contains the human readable name in all provided languages of the content type.

protected string[] $names
return	string[]