ContentInfo

ContentInfo.php : 34 Copy path

Extends ValueObject

This class provides all version independent information of the Content object.

Constants¶

STATUS_DRAFT ¶

ContentInfo.php : 36 Copy path

public mixed STATUS_DRAFT = 0

STATUS_PUBLISHED ¶

ContentInfo.php : 37 Copy path

public mixed STATUS_PUBLISHED = 1

STATUS_TRASHED ¶

ContentInfo.php : 38 Copy path

public mixed STATUS_TRASHED = 2

Properties¶

$alwaysAvailable read-only ¶

ContentInfo.php Copy path

public bool $alwaysAvailable

Indicates if the Content object is shown in the mainlanguage if its not present in an other requested language

$contentTypeId read-only ¶

ContentInfo.php Copy path

public int $contentTypeId

The unique id of the content type item the Content object is an instance of

$currentVersionNo read-only ¶

ContentInfo.php Copy path

public int $currentVersionNo

Current Version number is the version number of the published version or the version number of a newly created draft (which is 1).

$id read-only ¶

ContentInfo.php Copy path

public int $id

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

$isHidden read-only ¶

ContentInfo.php Copy path

public bool $isHidden

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

$mainLanguageCode read-only ¶

ContentInfo.php Copy path

public string $mainLanguageCode

The main language code of the Content object. If the available flag is set to true the Content is shown in this language if the requested language does not exist.

$mainLocationId read-only ¶

ContentInfo.php Copy path

public int|null $mainLocationId

@deprecated Use ContentInfo::getMainLocationId instead

$modificationDate read-only ¶

ContentInfo.php Copy path

public DateTime $modificationDate

Content object modification date

$name read-only ¶

ContentInfo.php Copy path

public string $name

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

$ownerId read-only ¶

ContentInfo.php Copy path

public int $ownerId

the user id of the owner of the Content object

$published read-only ¶

ContentInfo.php Copy path

public bool $published

true if there exists a published version false otherwise

$publishedDate read-only ¶

ContentInfo.php Copy path

public DateTime $publishedDate

date of the first publish

$remoteId read-only ¶

ContentInfo.php Copy path

public string $remoteId

a global unique id of the Content object

$sectionId read-only ¶

ContentInfo.php Copy path

public int $sectionId

@deprecated 4.6.2 Use ContentInfo::getSectionId instead. The section to which the Content object is assigned

$status read-only ¶

ContentInfo.php Copy path

public int $status

status of the Content object

$alwaysAvailable ¶

ContentInfo.php : 111 Copy path

Indicates if the Content object is shown in the mainlanguage if its not present in an other requested language.

protected bool $alwaysAvailable

$contentType ¶

ContentInfo.php : 150 Copy path

protected ContentType $contentType

$contentTypeId ¶

ContentInfo.php : 52 Copy path

The content type id of the Content object.

protected int $contentTypeId

$currentVersionNo ¶

ContentInfo.php : 76 Copy path

Current Version number is the version number of the published version or the version number of a newly created draft (which is 1).

protected int $currentVersionNo

$id ¶

ContentInfo.php : 45 Copy path

The unique id of the Content object.

protected int $id

$isHidden ¶

ContentInfo.php : 147 Copy path

protected bool $isHidden

$mainLanguage ¶

ContentInfo.php : 156 Copy path

protected Language $mainLanguage

$mainLanguageCode ¶

ContentInfo.php : 125 Copy path

The main language code of the Content object.

protected string $mainLanguageCode

$mainLocation ¶

ContentInfo.php : 159 Copy path

protected Location|null $mainLocation

$mainLocationId ¶

ContentInfo.php : 135 Copy path

Identifier of the main location.

protected int|null $mainLocationId

If the Content object has multiple locations, $mainLocationId will point to the main one.

$modificationDate ¶

ContentInfo.php : 97 Copy path

Content modification date.

protected DateTime $modificationDate

$name ¶

ContentInfo.php : 61 Copy path

The computed name (via name schema) in the main language of the Content object.

protected string $name

For names in other languages then main see VersionInfo

$owner ¶

ContentInfo.php : 162 Copy path

protected User $owner

$ownerId ¶

ContentInfo.php : 90 Copy path

The owner of the Content object.

protected int $ownerId

$published ¶

ContentInfo.php : 83 Copy path

True if there exists a published version, false otherwise.

protected bool $published

Constant.

$publishedDate ¶

ContentInfo.php : 104 Copy path

Content publication date.

protected DateTime $publishedDate

$remoteId ¶

ContentInfo.php : 118 Copy path

Remote identifier used as a custom identifier for the object.

protected string $remoteId

$section ¶

ContentInfo.php : 153 Copy path

protected Section $section

$sectionId ¶

ContentInfo.php : 68 Copy path

The section to which the Content object is assigned.

protected int $sectionId

$status ¶

ContentInfo.php : 144 Copy path

Status of the content.

protected int $status

Replaces deprecated API\ContentInfo::$published.

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>	[]	-

getContentType() ¶

ContentInfo.php : 193 Copy path

public getContentType() : ContentType

Return values

ContentType

getId() ¶

ContentInfo.php : 233 Copy path

public getId() : int

Return values

int

getMainLanguage() ¶

ContentInfo.php : 208 Copy path

public getMainLanguage() : Language

Return values

Language

getMainLanguageCode() ¶

ContentInfo.php : 213 Copy path

public getMainLanguageCode() : string

Return values

string

getMainLocation() ¶

ContentInfo.php : 218 Copy path

public getMainLocation() : Location|null

Return values

Location|null

getMainLocationId() ¶

ContentInfo.php : 228 Copy path

public getMainLocationId() : int|null

Return values

int|null

getName() ¶

ContentInfo.php : 238 Copy path

public getName() : string

Return values

string

getOwner() ¶

ContentInfo.php : 223 Copy path

public getOwner() : User

Return values

User

getSection() ¶

ContentInfo.php : 198 Copy path

public getSection() : Section

Return values

Section

getSectionId() ¶

ContentInfo.php : 203 Copy path

public getSectionId() : int

Return values

int

isDraft() ¶

ContentInfo.php : 167 Copy path

public isDraft() : bool

Return values

bool

isHidden() ¶

ContentInfo.php : 188 Copy path

public isHidden() : bool

Return values

bool

isPublished() ¶

ContentInfo.php : 175 Copy path

public isPublished() : bool

Return values

bool

isTrashed() ¶

ContentInfo.php : 183 Copy path

public isTrashed() : 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>