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 $priority

UpdateStruct.php : 21

Location priority.

public int $priority = 0

Position of the Location among its siblings when sorted using priority sort order.

public $remoteId

UpdateStruct.php : 30

Remote ID.

public mixed $remoteId

A universally unique identifier.

public $sortField

UpdateStruct.php : 39

Specifies which property the child locations should be sorted on.

public mixed $sortField

Valid values are found at

public $sortOrder

UpdateStruct.php : 48

Specifies whether the sort order should be ascending or descending.

public mixed $sortOrder

Valid values are

Methods

public__construct()

ValueObject.php : 31

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

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>

Tags
Serializerignore

()