Copied!

LocationUpdateStruct

LocationUpdateStruct.php : 16
Extends ValueObject

This class is used for updating location meta data.

Properties

public $priority

LocationUpdateStruct.php : 21

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

 
public int|null $priority = null

public $remoteId

LocationUpdateStruct.php : 28

If set the location gets a new remoteId.

 
public string|null $remoteId = null

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

public $sortField

LocationUpdateStruct.php : 35

If set the sortField is changed.

 
public int|null $sortField = null

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

public $sortOrder

LocationUpdateStruct.php : 42

If set the sortOrder is changed.

 
public int|null $sortOrder = null

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

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]