LocationCreateStruct

LocationCreateStruct.php : 16 Copy path

Extends ValueObject

This class is used to create a new Location for a content object.

Properties¶

LocationCreateStruct.php : 33 Copy path

Indicates that the Location entity has been explicitly marked as hidden.

public bool $hidden = false

LocationCreateStruct.php : 73 Copy path

The id of the parent location under which the new location should be created.

public mixed $parentLocationId

Required.

LocationCreateStruct.php : 26 Copy path

Location priority.

public int $priority = 0

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

LocationCreateStruct.php : 42 Copy path

An universally unique string identifier.

public mixed $remoteId

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

LocationCreateStruct.php : 53 Copy path

Specifies which property the child locations should be sorted on.

public mixed $sortField = null

Valid values are found at

If not set, will be taken out of ContentType's default sort field

LocationCreateStruct.php : 64 Copy path

Specifies whether the sort order should be ascending or descending.

public mixed $sortOrder = null

Valid values are

If not set, will be taken out of ContentType's default sort order

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>