CSMassActionGroupDefinition
in package
The base class for the mass action group definition
Tags
Table of Contents
- TYPE_BULK_EDIT = 3
- TYPE_PROCESS = 2
- TYPE_SHARE = 4
- TYPE_STANDARD = 1
- TYPE_UNSORTED = 5
- __construct() : void
- Creates an instance of a mass action group definition.
- getSortOrder() : int
- Returns the group sort order of the group instance
- getType() : int
- Returns the group type of the group instance
- toArray() : array<string|int, mixed>
- Creates the array representation of the group definition.
Constants
TYPE_BULK_EDIT
public
mixed
TYPE_BULK_EDIT
= 3
Tags
TYPE_PROCESS
public
mixed
TYPE_PROCESS
= 2
Tags
TYPE_SHARE
public
mixed
TYPE_SHARE
= 4
Tags
TYPE_STANDARD
public
mixed
TYPE_STANDARD
= 1
Tags
TYPE_UNSORTED
public
mixed
TYPE_UNSORTED
= 5
Tags
Methods
__construct()
Creates an instance of a mass action group definition.
public
__construct(int $iType, int $iSortOrder) : void
Parameters
- $iType : int
-
The group type as one of the TYPE_* constants
- $iSortOrder : int
-
The sort order associated with the group
Tags
Return values
void —getSortOrder()
Returns the group sort order of the group instance
public
getSortOrder() : int
Tags
Return values
int —The sort order of the group instance
getType()
Returns the group type of the group instance
public
getType() : int
Tags
Return values
int —The type of the group instance
toArray()
Creates the array representation of the group definition.
public
toArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —The array representation of the group definition.
