Copied!

ActionConfigurationCreateStruct

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

public__construct()

ActionConfigurationCreateStruct.php : 38

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 - -

publicgetActionHandler()

ActionConfigurationCreateStruct.php : 138 
public getActionHandler() : string|null

Return values

string|null

publicgetActionHandlerOptions()

ActionConfigurationCreateStruct.php : 115 
public getActionHandlerOptions() : MapInterface<string, mixed>

Return values

MapInterface<string, mixed>

publicgetActionType()

ActionConfigurationCreateStruct.php : 60 
public getActionType() : ActionTypeInterface

Return values

ActionTypeInterface

publicgetActionTypeOptions()

ActionConfigurationCreateStruct.php : 99 
public getActionTypeOptions() : MapInterface<string, mixed>

Return values

MapInterface<string, mixed>

publicgetDescriptions()

ActionConfigurationCreateStruct.php : 86 
public getDescriptions() : array<string, string>

Return values

array<string, string>

publicgetIdentifier()

ActionConfigurationCreateStruct.php : 50 
public getIdentifier() : string

Return values

string

publicgetNames()

ActionConfigurationCreateStruct.php : 73 
public getNames() : array<string, string>

Return values

array<string, string>

publicisEnabled()

ActionConfigurationCreateStruct.php : 128 
public isEnabled() : bool

Return values

bool

publicsetActionHandler()

ActionConfigurationCreateStruct.php : 143 
public setActionHandler(string|null $actionHandler) : void

Parameters

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

publicsetActionHandlerOptions()

ActionConfigurationCreateStruct.php : 123 
public setActionHandlerOptions(MapInterface<string, mixed> $actionHandlerOptions) : void

Parameters

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

publicsetActionTypeOptions()

ActionConfigurationCreateStruct.php : 107 
public setActionTypeOptions(MapInterface<string, mixed> $actionTypeOptions) : void

Parameters

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

publicsetDescription()

ActionConfigurationCreateStruct.php : 91 
public setDescription(string $languageCode, string $description) : void

Parameters

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

publicsetEnabled()

ActionConfigurationCreateStruct.php : 133 
public setEnabled(bool $enabled) : void

Parameters

Name Type Default value Description
$enabled bool - -

publicsetIdentifier()

ActionConfigurationCreateStruct.php : 55 
public setIdentifier(string $identifier) : void

Parameters

Name Type Default value Description
$identifier string - -

publicsetName()

ActionConfigurationCreateStruct.php : 78 
public setName(string $languageCode, string $name) : void

Parameters

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

publicsetType()

ActionConfigurationCreateStruct.php : 65 
public setType(ActionTypeInterface $actionType) : void

Parameters

Name Type Default value Description
$actionType ActionTypeInterface - -

protectedgetProperties()

ValueObject.php : 53

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>

Tags
Serializerignore

()