CSMassActionDefinition
in package
The base class for the mass action definition
Tags
Table of Contents
- __construct() : mixed
- getContext() : CSMassActionContext
- Returns the context of the mass action processing
- getDataForKey() : mixed
- Returns the value for the key
- getGroup() : CSMassActionGroupDefinition
- Returns the group definition of the mass action processing
- getName() : string
- Returns the name of the mass action
- isAvailable() : bool
- Returns whether the mass action is available for the given context
- setDataForKey() : void
- Sets the value for the key
- toArray() : array<string|int, mixed>
- Provides array representation of the mass action definition
Methods
__construct()
public
__construct(string $sName, bool $bAvailable, CSMassActionContext $oContext[, CSMassActionGroupDefinition $oGroup = new CSMassActionGroupDefinition(CSMassActionGroupDefinition::GROUP_UNSORTED) ]) : mixed
Parameters
- $sName : string
- $bAvailable : bool
- $oContext : CSMassActionContext
- $oGroup : CSMassActionGroupDefinition = new CSMassActionGroupDefinition(CSMassActionGroupDefinition::GROUP_UNSORTED)
Tags
Return values
mixed —getContext()
Returns the context of the mass action processing
public
getContext() : CSMassActionContext
Tags
Return values
CSMassActionContext —getDataForKey()
Returns the value for the key
public
getDataForKey(string $sKey) : mixed
Parameters
- $sKey : string
Tags
Return values
mixed —The value for the key, NULL if value is not set.
getGroup()
Returns the group definition of the mass action processing
public
getGroup() : CSMassActionGroupDefinition
Tags
Return values
CSMassActionGroupDefinition —getName()
Returns the name of the mass action
public
getName() : string
Tags
Return values
string —isAvailable()
Returns whether the mass action is available for the given context
public
isAvailable() : bool
Tags
Return values
bool —setDataForKey()
Sets the value for the key
public
setDataForKey(string $sKey, mixed $sValue) : void
Parameters
- $sKey : string
- $sValue : mixed
Tags
Return values
void —toArray()
Provides array representation of the mass action definition
public
toArray() : array<string|int, mixed>