Copied!

UpdateStruct

UpdateStruct.php : 12
Extends ValueObject

Base SPI Value object.

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

Properties

public $defaultAlwaysAvailable

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

Document.

public $description

UpdateStruct.php : 36

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 : 43

String identifier of a type.

public string $identifier

public $initialLanguageId

UpdateStruct.php : 92

Initial language.

public mixed $initialLanguageId

public $isContainer

UpdateStruct.php : 85

Determines if the type is a container.

public bool $isContainer

public $modified

UpdateStruct.php : 50

Modification date (timestamp).

public int $modified

public $modifierId

UpdateStruct.php : 57

Modifier user id.

public mixed $modifierId

public $name

UpdateStruct.php : 24

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 : 78

Name schema.

public string $nameSchema

public $remoteId

UpdateStruct.php : 64

Unique remote ID.

public string $remoteId

public $sortField

UpdateStruct.php : 101

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 : 110

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

public mixed $sortOrder

Valid values are

public $urlAliasSchema

UpdateStruct.php : 71

URL alias schema.

public string|null $urlAliasSchema

Methods

public__construct()

ValueObject.php : 32

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

protectedgetProperties()

ValueObject.php : 53

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>

Attributes
#[Ignore]