ContentType

ContentType.php : 37 Copy path

Extends ValueObject

Implements MultiLanguageName, MultiLanguageDescription

this class represents a content type value.

Constants¶

STATUS_DEFINED ¶

ContentType.php : 40 Copy path

public int STATUS_DEFINED = 0

Status constant for defined (aka "published") Type

STATUS_DRAFT ¶

ContentType.php : 43 Copy path

public int STATUS_DRAFT = 1

Status constant for draft (aka "temporary") Type

STATUS_MODIFIED ¶

ContentType.php : 46 Copy path

public int STATUS_MODIFIED = 2

Status constant for modified (aka "deferred for publishing") Type

Properties¶

$contentTypeGroups read-only ¶

ContentType.php Copy path

public array<string|int, ContentTypeGroup> $contentTypeGroups

calls getContentTypeGroups

$creationDate read-only ¶

ContentType.php Copy path

public DateTime $creationDate

the date of the creation of this content type

$creatorId read-only ¶

ContentType.php Copy path

public mixed $creatorId

the user id of the creator of this content type

$defaultAlwaysAvailable read-only ¶

ContentType.php Copy path

public bool $defaultAlwaysAvailable

if an instance of a content type is created the always available flag is set by default this this value.

$defaultSortField read-only ¶

ContentType.php Copy path

public int $defaultSortField

Specifies which property the child locations should be sorted on by default when created. Valid values are found at

$defaultSortOrder read-only ¶

ContentType.php Copy path

public int $defaultSortOrder

Specifies whether the sort order should be ascending or descending by default when created. Valid values are

$fieldDefinitions read-only ¶

ContentType.php Copy path

public FieldDefinitionCollection $fieldDefinitions

calls getFieldDefinitions() or on access getFieldDefinition($fieldDefIdentifier)

$id read-only ¶

ContentType.php Copy path

public mixed $id

the id of the content type

$identifier read-only ¶

ContentType.php Copy path

public string $identifier

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use ContentType::getIdentifier() instead.

$isContainer read-only ¶

ContentType.php Copy path

public bool $isContainer

@deprecated use strict getter ContentType::isContainer instead.

$languageCodes read-only ¶

ContentType.php Copy path

public array<string|int, string> $languageCodes

array of language codes used by content type translations.

$mainLanguageCode read-only ¶

ContentType.php Copy path

public string $mainLanguageCode

the main language of the content type names and description used for fallback.

$modificationDate read-only ¶

ContentType.php Copy path

public DateTime $modificationDate

the date of the last modification of this content type

$modifierId read-only ¶

ContentType.php Copy path

public mixed $modifierId

the user id of the user which has last modified this content type

$nameSchema read-only ¶

ContentType.php Copy path

public string $nameSchema

The name schema.

$remoteId read-only ¶

ContentType.php Copy path

public string $remoteId

a global unique id of the content object

$status read-only ¶

ContentType.php Copy path

public int $status

the status of the content type. One of ContentType::STATUS_DEFINED|ContentType::STATUS_DRAFT|ContentType::STATUS_MODIFIED

$urlAliasSchema read-only ¶

ContentType.php Copy path

public string $urlAliasSchema

URL alias schema. If nothing is provided, $nameSchema will be used instead.

$creationDate ¶

ContentType.php : 74 Copy path

Creation date of the content type.

protected DateTime $creationDate

$creatorId ¶

ContentType.php : 88 Copy path

Creator user id of the content type.

protected mixed $creatorId

$defaultAlwaysAvailable ¶

ContentType.php : 140 Copy path

If an instance of a content type is created the always available flag is set by default to this value.

protected bool $defaultAlwaysAvailable = true

$defaultSortField ¶

ContentType.php : 149 Copy path

Specifies which property the child locations should be sorted on by default when created.

protected int $defaultSortField

Valid values are found at

$defaultSortOrder ¶

ContentType.php : 158 Copy path

Specifies whether the sort order should be ascending or descending by default when created.

protected int $defaultSortOrder

Valid values are

$id ¶

ContentType.php : 53 Copy path

Content type ID.

protected mixed $id

$identifier ¶

ContentType.php : 67 Copy path

String identifier of a content type.

protected string $identifier

$isContainer ¶

ContentType.php : 132 Copy path

A flag used to hint if content of this type may have children or not. It is highly recommended to respect this flag and not create/move content below non-containers.

protected bool $isContainer

But this flag is not considered as part of the content model and the API will not in any way enforce this flag to be respected.

$languageCodes ¶

ContentType.php : 165 Copy path

List of language codes used by translations.

protected array<string|int, string> $languageCodes

$modificationDate ¶

ContentType.php : 81 Copy path

Modification date of the content type.

protected DateTime $modificationDate

$modifierId ¶

ContentType.php : 95 Copy path

Modifier user id of the content type.

protected mixed $modifierId

$nameSchema ¶

ContentType.php : 124 Copy path

Name schema.

protected string $nameSchema

Can be composed of FieldDefinition identifier place holders. These place holders must comply this pattern : <field_definition_identifier>. An OR condition can be used : <field_def|other_field_def> In this example, field_def will be used if available. If not, other_field_def will be used for content name generation

$remoteId ¶

ContentType.php : 102 Copy path

Unique remote ID of the content type.

protected string $remoteId

$status ¶

ContentType.php : 60 Copy path

The status of the content type.

protected int $status

One of Type::STATUS_DEFINED|Type::STATUS_DRAFT|Type::STATUS_MODIFIED

$urlAliasSchema ¶

ContentType.php : 111 Copy path

URL alias schema.

protected string $urlAliasSchema

If nothing is provided, $nameSchema will be used instead.

Methods¶

__construct() ¶

ValueObject.php : 30 Copy path

Construct object optionally with a set of properties.

public __construct([array<string|int, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name	Type	Default value	Description
$properties	array<string\|int, mixed>	[]	-

getContentTypeGroups() ¶

ContentType.php : 172 Copy path

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

public abstract getContentTypeGroups() : array<string|int, ContentTypeGroup>

Return values

array<string|int, ContentTypeGroup>

getFieldDefinition() ¶

ContentType.php : 191 Copy path

This method returns the field definition for the given identifier.

public getFieldDefinition(string $fieldDefinitionIdentifier) : FieldDefinition|null

Parameters

Name	Type	Default value	Description
$fieldDefinitionIdentifier	string	-	-

Return values

FieldDefinition|null

getFieldDefinitions() ¶

ContentType.php : 177 Copy path

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

public abstract getFieldDefinitions() : FieldDefinitionCollection

Return values

FieldDefinitionCollection

getFieldDefinitionsOfType() ¶

ContentType.php : 219 Copy path

Returns collection of the field definition for the given field type identifier.

public getFieldDefinitionsOfType(string $fieldTypeIdentifier) : FieldDefinitionCollection

Parameters

Name	Type	Default value	Description
$fieldTypeIdentifier	string	-	-

Return values

FieldDefinitionCollection

getFirstFieldDefinitionOfType() ¶

ContentType.php : 227 Copy path

Returns true if field definition with given field type identifier or null.

public getFirstFieldDefinitionOfType(string $fieldTypeIdentifier) : FieldDefinition|null

Parameters

Name	Type	Default value	Description
$fieldTypeIdentifier	string	-	-

Return values

FieldDefinition|null

getIdentifier() ¶

ContentType.php : 179 Copy path

public getIdentifier() : string

Return values

string

hasFieldDefinition() ¶

ContentType.php : 203 Copy path

This method returns true if the field definition for the given identifier exists.

public hasFieldDefinition(string $fieldDefinitionIdentifier) : bool

Parameters

Name	Type	Default value	Description
$fieldDefinitionIdentifier	string	-	-

Return values

bool

hasFieldDefinitionOfType() ¶

ContentType.php : 211 Copy path

Returns true if field definition with given field type identifier exists.

public hasFieldDefinitionOfType(string $fieldTypeIdentifier) : bool

Parameters

Name	Type	Default value	Description
$fieldTypeIdentifier	string	-	-

Return values

bool

isContainer() ¶

ContentType.php : 237 Copy path

public isContainer() : bool

Return values

bool

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

    
                        protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>