CreateStruct

CreateStruct.php : 11 Copy path

Extends ValueObject

Base SPI Value object.

All properties of SPI\ValueObject must be serializable for cache & NoSQL use.

Properties¶

$alwaysAvailable ¶

CreateStruct.php : 46 Copy path

public bool $alwaysAvailable = false

Always available flag

$fields ¶

CreateStruct.php : 43 Copy path

Contains *all* fields of the object to be created.

public array<string|int, Field> $fields = []

This attribute should contain all fields (in all language) of the object to be created. If a field is not translatable, it may only occur once. The storage layer will automatically take care that such fields are assigned to each language version.

$initialLanguageId ¶

CreateStruct.php : 56 Copy path

Language id the content was initially created in.

public mixed $initialLanguageId

$isHidden ¶

CreateStruct.php : 79 Copy path

Is hidden flag.

public bool $isHidden

$locations ¶

CreateStruct.php : 31 Copy path

ContentId, contentVersion and mainLocationId are allowed to be left empty when used on with this struct as these values are created by the create method.

public array<string|int, CreateStruct> $locations = []

$mainLanguageId ¶

CreateStruct.php : 65 Copy path

Optional, main language of the content, if not set $initialLanguageId will be used instead.

public mixed|null $mainLanguageId

Typical use is copy operations where content main language and version initial language might differ.

$modified ¶

CreateStruct.php : 72 Copy path

Modification date.

public int $modified

$name ¶

CreateStruct.php : 14 Copy path

public array<string|int, string> $name

Eg. array( 'eng-GB' => "New Article" )

$ownerId ¶

CreateStruct.php : 23 Copy path

public int $ownerId

$remoteId ¶

CreateStruct.php : 49 Copy path

public string $remoteId

Remote identifier used as a custom identifier for the object

$sectionId ¶

CreateStruct.php : 20 Copy path

public int $sectionId

$typeId ¶

CreateStruct.php : 17 Copy path

public int $typeId

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

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>