ActionConfigurationUpdateStruct

ActionConfigurationUpdateStruct.php : 14 Copy path

Extends ValueObject

The base class for all value objects and structs.

Supports readonly properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using property-read <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Methods¶

__construct() ¶

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.

Parameters

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

getActionHandlerOptions() ¶

ActionConfigurationUpdateStruct.php : 87 Copy path

public getActionHandlerOptions() : MapInterface<string, mixed>|null

Return values

MapInterface<string, mixed>|null

getActionTypeOptions() ¶

ActionConfigurationUpdateStruct.php : 103 Copy path

public getActionTypeOptions() : MapInterface<string, mixed>|null

Return values

MapInterface<string, mixed>|null

getDescriptions() ¶

ActionConfigurationUpdateStruct.php : 66 Copy path

public getDescriptions() : array<string, string|null>|null

Return values

array<string, string|null>|null

getEnabled() ¶

ActionConfigurationUpdateStruct.php : 116 Copy path

public getEnabled() : bool|null

Return values

bool|null

getIdentifier() ¶

ActionConfigurationUpdateStruct.php : 32 Copy path

public getIdentifier() : string|null

Return values

string|null

getNames() ¶

ActionConfigurationUpdateStruct.php : 45 Copy path

public getNames() : array<string, string|null>|null

Return values

array<string, string|null>|null

setActionHandlerOptions() ¶

ActionConfigurationUpdateStruct.php : 95 Copy path

public setActionHandlerOptions(MapInterface<string, mixed>|null $actionHandlerOptions) : void

Parameters

Name	Type	Default value	Description
$actionHandlerOptions	MapInterface<string, mixed>\|null	-	-

setActionTypeOptions() ¶

ActionConfigurationUpdateStruct.php : 111 Copy path

public setActionTypeOptions(MapInterface<string, mixed>|null $actionTypeOptions) : void

Parameters

Name	Type	Default value	Description
$actionTypeOptions	MapInterface<string, mixed>\|null	-	-

setDescription() ¶

ActionConfigurationUpdateStruct.php : 79 Copy path

public setDescription(string $languageCode, string $description) : void

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-
$description	string	-	-

setDescriptions() ¶

ActionConfigurationUpdateStruct.php : 74 Copy path

public setDescriptions(array<string, string|null>|null $descriptions) : void

Parameters

Name	Type	Default value	Description
$descriptions	array<string, string\|null>\|null	-	-

setEnabled() ¶

ActionConfigurationUpdateStruct.php : 121 Copy path

public setEnabled(bool|null $enabled) : void

Parameters

Name	Type	Default value	Description
$enabled	bool\|null	-	-

setIdentifier() ¶

ActionConfigurationUpdateStruct.php : 37 Copy path

public setIdentifier(string|null $identifier) : void

Parameters

Name	Type	Default value	Description
$identifier	string\|null	-	-

setName() ¶

ActionConfigurationUpdateStruct.php : 58 Copy path

public setName(string $languageCode, string $name) : void

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-
$name	string	-	-

setNames() ¶

ActionConfigurationUpdateStruct.php : 53 Copy path

public setNames(array<string, string|null>|null $names) : void

Parameters

Name	Type	Default value	Description
$names	array<string, string\|null>\|null	-	-

getProperties() ¶

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

Parameters

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

Return values

array<string|int, mixed>