ActionConfigurationCreateStruct

ActionConfigurationCreateStruct.php : 16 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() ¶

ActionConfigurationCreateStruct.php : 38 Copy path

Construct object optionally with a set of properties.

public __construct(string $identifier)

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
$identifier	string	-	-

getActionHandler() ¶

ActionConfigurationCreateStruct.php : 138 Copy path

public getActionHandler() : string|null

Return values

string|null

getActionHandlerOptions() ¶

ActionConfigurationCreateStruct.php : 115 Copy path

public getActionHandlerOptions() : MapInterface<string, mixed>

Return values

MapInterface<string, mixed>

getActionType() ¶

ActionConfigurationCreateStruct.php : 60 Copy path

public getActionType() : ActionTypeInterface

Return values

ActionTypeInterface

getActionTypeOptions() ¶

ActionConfigurationCreateStruct.php : 99 Copy path

public getActionTypeOptions() : MapInterface<string, mixed>

Return values

MapInterface<string, mixed>

getDescriptions() ¶

ActionConfigurationCreateStruct.php : 86 Copy path

public getDescriptions() : array<string, string>

Return values

array<string, string>

getIdentifier() ¶

ActionConfigurationCreateStruct.php : 50 Copy path

public getIdentifier() : string

Return values

string

getNames() ¶

ActionConfigurationCreateStruct.php : 73 Copy path

public getNames() : array<string, string>

Return values

array<string, string>

isEnabled() ¶

ActionConfigurationCreateStruct.php : 128 Copy path

public isEnabled() : bool

Return values

bool

setActionHandler() ¶

ActionConfigurationCreateStruct.php : 143 Copy path

public setActionHandler(string|null $actionHandler) : void

Parameters

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

setActionHandlerOptions() ¶

ActionConfigurationCreateStruct.php : 123 Copy path

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

Parameters

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

setActionTypeOptions() ¶

ActionConfigurationCreateStruct.php : 107 Copy path

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

Parameters

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

setDescription() ¶

ActionConfigurationCreateStruct.php : 91 Copy path

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

Parameters

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

setEnabled() ¶

ActionConfigurationCreateStruct.php : 133 Copy path

public setEnabled(bool $enabled) : void

Parameters

Name	Type	Default value	Description
$enabled	bool	-	-

setIdentifier() ¶

ActionConfigurationCreateStruct.php : 55 Copy path

public setIdentifier(string $identifier) : void

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

setName() ¶

ActionConfigurationCreateStruct.php : 78 Copy path

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

Parameters

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

setType() ¶

ActionConfigurationCreateStruct.php : 65 Copy path

public setType(ActionTypeInterface $actionType) : void

Parameters

Name	Type	Default value	Description
$actionType	ActionTypeInterface	-	-

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>