LocationUpdateStruct

LocationUpdateStruct.php : 16 Copy path

Extends ValueObject

This class is used for updating location meta data.

Properties¶

LocationUpdateStruct.php : 23 Copy path

If set the location priority is changed to the new value.

public int $priority

LocationUpdateStruct.php : 32 Copy path

If set the location gets a new remoteId.

public mixed $remoteId

Needs to be a unique Location->remoteId string value.

LocationUpdateStruct.php : 41 Copy path

If set the sortField is changed.

public mixed $sortField

The sort field specifies which property the child locations should be sorted on. Valid values are found at .

LocationUpdateStruct.php : 50 Copy path

If set the sortOrder is changed.

public mixed $sortOrder

The sort order specifies whether the sort order should be ascending or descending. Valid values are .

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.

Name	Type	Default value	Description
$properties	array<string\|int, mixed>	[]	-

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

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

array<string|int, mixed>