ContentInfo

ContentInfo.php : 35 Copy path

Extends ValueObject

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

Constants¶

STATUS_DRAFT ¶

ContentInfo.php : 37 Copy path

public mixed STATUS_DRAFT = 0

STATUS_PUBLISHED ¶

ContentInfo.php : 38 Copy path

public mixed STATUS_PUBLISHED = 1

STATUS_TRASHED ¶

ContentInfo.php : 39 Copy path

public mixed STATUS_TRASHED = 2

Properties¶

$alwaysAvailable ¶

ContentInfo.php : 92 Copy path

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

protected bool $alwaysAvailable = false

$contentType ¶

ContentInfo.php : 121 Copy path

protected ContentType $contentType

$contentTypeId ¶

ContentInfo.php : 49 Copy path

The content type id of the Content object.

protected int $contentTypeId

$currentVersionNo ¶

ContentInfo.php : 67 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 : 44 Copy path

The unique id of the Content object.

protected int $id

$isHidden ¶

ContentInfo.php : 119 Copy path

protected bool $isHidden

$mainLanguage ¶

ContentInfo.php : 125 Copy path

protected Language $mainLanguage

$mainLanguageCode ¶

ContentInfo.php : 102 Copy path

The main language code of the Content object.

protected string $mainLanguageCode

$mainLocation ¶

ContentInfo.php : 127 Copy path

protected Location|null $mainLocation

$mainLocationId ¶

ContentInfo.php : 110 Copy path

Identifier of the main location.

protected int|null $mainLocationId = null

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

$modificationDate ¶

ContentInfo.php : 82 Copy path

Content modification date.

protected DateTimeInterface|null $modificationDate

$name ¶

ContentInfo.php : 56 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 : 129 Copy path

protected User $owner

$ownerId ¶

ContentInfo.php : 77 Copy path

The owner of the Content object.

protected int $ownerId

$published ¶

ContentInfo.php : 72 Copy path

True if there exists a published version, false otherwise.

protected bool $published

$publishedDate ¶

ContentInfo.php : 87 Copy path

Content publication date.

protected DateTimeInterface|null $publishedDate

$remoteId ¶

ContentInfo.php : 97 Copy path

Remote identifier used as a custom identifier for the object.

protected string $remoteId

$section ¶

ContentInfo.php : 123 Copy path

protected Section $section

$sectionId ¶

ContentInfo.php : 61 Copy path

The section to which the Content object is assigned.

protected int $sectionId

$status ¶

ContentInfo.php : 117 Copy path

Status of the content.

protected int $status

Replaces deprecated API\ContentInfo::$published.

Methods¶

__construct() ¶

ValueObject.php : 32 Copy path

Construct object optionally with a set of properties.

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

Readonly properties values must be set using $properties as they aren't writable anymore after object has been created.

Parameters

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

getContentType() ¶

ContentInfo.php : 151 Copy path

public getContentType() : ContentType

Return values

ContentType

getId() ¶

ContentInfo.php : 191 Copy path

public getId() : int

Return values

int

getMainLanguage() ¶

ContentInfo.php : 166 Copy path

public getMainLanguage() : Language

Return values

Language

getMainLanguageCode() ¶

ContentInfo.php : 171 Copy path

public getMainLanguageCode() : string

Return values

string

getMainLocation() ¶

ContentInfo.php : 176 Copy path

public getMainLocation() : Location|null

Return values

Location|null

getMainLocationId() ¶

ContentInfo.php : 186 Copy path

public getMainLocationId() : int|null

Return values

int|null

getName() ¶

ContentInfo.php : 196 Copy path

public getName() : string

Return values

string

getOwner() ¶

ContentInfo.php : 181 Copy path

public getOwner() : User

Return values

User

getSection() ¶

ContentInfo.php : 156 Copy path

public getSection() : Section

Return values

Section

getSectionId() ¶

ContentInfo.php : 161 Copy path

public getSectionId() : int

Return values

int

isDraft() ¶

ContentInfo.php : 131 Copy path

public isDraft() : bool

Return values

bool

isHidden() ¶

ContentInfo.php : 146 Copy path

public isHidden() : bool

Return values

bool

isPublished() ¶

ContentInfo.php : 136 Copy path

public isPublished() : bool

Return values

bool

isTrashed() ¶

ContentInfo.php : 141 Copy path

public isTrashed() : bool

Return values

bool

getProperties() ¶

ValueObject.php : 53 Copy path

Returns list of available properties' names.

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

Override to add dynamic properties.

Parameters

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

Return values

array<int, string>

#[Ignore]

ContentInfo

Constants¶

STATUS_DRAFT ¶

STATUS_PUBLISHED ¶

STATUS_TRASHED ¶

Properties¶

$alwaysAvailable ¶

$contentType ¶

$contentTypeId ¶

$currentVersionNo ¶

$id ¶

$isHidden ¶

$mainLanguage ¶

$mainLanguageCode ¶

$mainLocation ¶

$mainLocationId ¶

$modificationDate ¶

$name ¶

$owner ¶

$ownerId ¶

$published ¶

$publishedDate ¶

$remoteId ¶

$section ¶

$sectionId ¶

$status ¶

Methods¶

__construct() ¶

Parameters

getContentType() ¶

Return values

getId() ¶

Return values

getMainLanguage() ¶

Return values

getMainLanguageCode() ¶

Return values

getMainLocation() ¶

Return values

getMainLocationId() ¶

Return values

getName() ¶

Return values

getOwner() ¶

Return values

getSection() ¶

Return values

getSectionId() ¶

Return values

isDraft() ¶

Return values

isHidden() ¶

Return values

isPublished() ¶

Return values

isTrashed() ¶

Return values

getProperties() ¶

Parameters

Return values

Attributes