VersionInfo

VersionInfo.php : 31 Copy path

Extends ValueObject

Implements MultiLanguageName

This class holds version information data.

It also contains the corresponding Content to which the version belongs to.

Constants¶

STATUS_ARCHIVED ¶

VersionInfo.php : 35 Copy path

public mixed STATUS_ARCHIVED = 3

STATUS_DRAFT ¶

VersionInfo.php : 33 Copy path

public mixed STATUS_DRAFT = 0

STATUS_PUBLISHED ¶

VersionInfo.php : 34 Copy path

public mixed STATUS_PUBLISHED = 1

Properties¶

$contentInfo read-only ¶

VersionInfo.php Copy path

public ContentInfo $contentInfo

calls getContentInfo()

$creationDate read-only ¶

VersionInfo.php Copy path

public DateTime $creationDate

the creation date of this version

$creatorId read-only ¶

VersionInfo.php Copy path

public mixed $creatorId

the user id of the user which created this version

$id read-only ¶

VersionInfo.php Copy path

public mixed $id

the internal id of the version

$initialLanguageCode read-only ¶

VersionInfo.php Copy path

public string $initialLanguageCode

the language code of the version. This value is used to flag a version as a translation to specific language

$languageCodes read-only ¶

VersionInfo.php Copy path

public array<string|int, string> $languageCodes

a collection of all languages which exist in this version.

$modificationDate read-only ¶

VersionInfo.php Copy path

public DateTime $modificationDate

the last modified date of this version

$status read-only ¶

VersionInfo.php Copy path

public int $status

the status of this version. One of VersionInfo::STATUS_DRAFT, VersionInfo::STATUS_PUBLISHED, VersionInfo::STATUS_ARCHIVED

$versionNo read-only ¶

VersionInfo.php Copy path

public int $versionNo

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

$creationDate ¶

VersionInfo.php : 71 Copy path

protected DateTime $creationDate

$creatorId ¶

VersionInfo.php : 68 Copy path

Creator user ID.

protected mixed $creatorId

Creator of the version, in the search API this is referred to as the modifier of the published content.

$id ¶

VersionInfo.php : 42 Copy path

Version ID.

protected mixed $id

$initialLanguageCode ¶

VersionInfo.php : 85 Copy path

In 4.x this is the language code which is used for labeling a translation.

protected string $initialLanguageCode

$languageCodes ¶

VersionInfo.php : 94 Copy path

List of languages in this version.

protected array<string|int, string> $languageCodes = []

Reflects which languages fields exists in for this version.

$modificationDate ¶

VersionInfo.php : 59 Copy path

the last modified date of this version.

protected DateTime $modificationDate

$status ¶

VersionInfo.php : 78 Copy path

One of VersionInfo::STATUS_DRAFT, VersionInfo::STATUS_PUBLISHED, VersionInfo::STATUS_ARCHIVED.

protected int $status

Constant.

$versionNo ¶

VersionInfo.php : 52 Copy path

Version number.

protected int $versionNo

In contrast to VersionInfo::$id, this is the version number, which only increments in scope of a single Content object.

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

getContentInfo() ¶

VersionInfo.php : 101 Copy path

Content of the content this version belongs to.

public abstract getContentInfo() : ContentInfo

Return values

ContentInfo

getCreator() ¶

VersionInfo.php : 103 Copy path

public abstract getCreator() : User

Return values

User

getInitialLanguage() ¶

VersionInfo.php : 105 Copy path

public abstract getInitialLanguage() : Language

Return values

Language

getLanguageCodes() ¶

VersionInfo.php : 115 Copy path

public getLanguageCodes() : array<string|int, string>

Return values

array<string|int, string>

getLanguages() ¶

VersionInfo.php : 110 Copy path

public abstract getLanguages() : array<string|int, Language>

Return values

array<string|int, Language>

getVersionNo() ¶

VersionInfo.php : 120 Copy path

public getVersionNo() : int

Return values

int

isArchived() ¶

VersionInfo.php : 150 Copy path

Returns true if version is archived.

public isArchived() : bool

Return values

bool

isDraft() ¶

VersionInfo.php : 130 Copy path

Returns true if version is a draft.

public isDraft() : bool

Return values

bool

isPublished() ¶

VersionInfo.php : 140 Copy path

Returns true if version is published.

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