Copied!

UpdateStruct

UpdateStruct.php : 11
Extends ValueObject

Base SPI Value object.

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

Properties

public $defaultAlwaysAvailable

UpdateStruct.php : 116 
public bool $defaultAlwaysAvailable
Tags
Todo:

Document.

public $description

UpdateStruct.php : 35

Human readable description of the content type.

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

The structure of this field is: array( 'eng' => '<description_eng>', 'de' => '<description_de>' );

public $identifier

UpdateStruct.php : 42

String identifier of a type.

 
public string $identifier

public $initialLanguageId

UpdateStruct.php : 91

Initial language.

 
public mixed $initialLanguageId

public $isContainer

UpdateStruct.php : 84

Determines if the type is a container.

 
public bool $isContainer

public $modified

UpdateStruct.php : 49

Modification date (timestamp).

 
public int $modified

public $modifierId

UpdateStruct.php : 56

Modifier user id.

 
public mixed $modifierId

public $name

UpdateStruct.php : 23

Human readable name of the content type.

 
public array<string|int, string> $name

The structure of this field is: array( 'eng' => '<name_eng>', 'de' => '<name_de>' );

public $nameSchema

UpdateStruct.php : 77

Name schema.

 
public string $nameSchema

public $remoteId

UpdateStruct.php : 63

Unique remote ID.

 
public string $remoteId

public $sortField

UpdateStruct.php : 100

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

 
public mixed $sortField

Valid values are found at

public $sortOrder

UpdateStruct.php : 109

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

 
public mixed $sortOrder

Valid values are

public $urlAliasSchema

UpdateStruct.php : 70

URL alias schema.

 
public string $urlAliasSchema

Methods

public__construct()

ValueObject.php : 30

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

protectedgetProperties()

ValueObject.php : 50

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>