CRM_Core_Task

abstract class CRM_Core_Task

Class to represent the actions that can be performed on a group of contacts used by the search forms.

Constants

GROUP_REMOVE

These constants are only used as enumerators for each of the batch tasks.
GROUP_ADD

These constants are only used as enumerators for each of the batch tasks.
PDF_LETTER

These constants are only used as enumerators for each of the batch tasks.
TASK_DELETE

These constants are only used as enumerators for each of the batch tasks.
TASK_PRINT

These constants are only used as enumerators for each of the batch tasks.
BATCH_UPDATE

These constants are only used as enumerators for each of the batch tasks.
TASK_SMS

These constants are only used as enumerators for each of the batch tasks.
TASK_EXPORT

These constants are only used as enumerators for each of the batch tasks.
TASK_EMAIL

These constants are only used as enumerators for each of the batch tasks.
TAG_ADD

These constants are only used as enumerators for each of the batch tasks.
TAG_REMOVE

These constants are only used as enumerators for each of the batch tasks.
SAVE_SEARCH

These constants are only used as enumerators for each of the batch tasks.
SAVE_SEARCH_UPDATE

These constants are only used as enumerators for each of the batch tasks.
CREATE_MAILING

These constants are only used as enumerators for each of the batch tasks.
DELETE_PERMANENTLY

These constants are only used as enumerators for each of the batch tasks.
LABEL_CONTACTS

These constants are only used as enumerators for each of the batch tasks.

Properties

static array $_tasks The task array
static string $objectType

Methods

static 
tasks()

Generates a list of batch tasks available for the current entities.

static array
taskTitles()

These tasks are the core set of tasks that the user can perform on a contact / group of contacts

static array
permissionedTaskTitles(int $permission, array $params)

Show tasks selectively based on the permission level of the user This function should be overridden by the child class which would normally call parent::corePermissionedTaskTitles

static array
corePermissionedTaskTitles(array $tasks, int $permission, array $params)

Show tasks selectively based on the permission level of the user This function should be called by permissionedTaskTitles in children

static array
getTask(int $value)

These tasks are the core set of tasks that the user can perform on participants

static array
getTaskAndTitleByClass(string $className)

Function to return the task information on basis of provided task's form name

Details

at line 84
static tasks()

Generates a list of batch tasks available for the current entities.

Each child class should populate $_tasks array and then call this parent function for shared functionality. * @return array The set of tasks for a group of contacts [ 'title' => The Task title, 'class' => The Task Form class name, 'result => Boolean. FIXME: Not sure what this is for ]

at line 98
static array taskTitles()

These tasks are the core set of tasks that the user can perform on a contact / group of contacts

Return Value

array the set of tasks for a group of contacts

at line 132
static array permissionedTaskTitles(int $permission, array $params)

Show tasks selectively based on the permission level of the user This function should be overridden by the child class which would normally call parent::corePermissionedTaskTitles

Parameters

int $permission
array $params "ssID: Saved Search ID": If !empty we are in saved search context

Return Value

array set of tasks that are valid for the user

at line 149
static array corePermissionedTaskTitles(array $tasks, int $permission, array $params)

Show tasks selectively based on the permission level of the user This function should be called by permissionedTaskTitles in children

Parameters

array $tasks The array of tasks generated by permissionedTaskTitles
int $permission
array $params "ssID: Saved Search ID": If !empty we are in saved search context

Return Value

array set of tasks that are valid for the user

at line 171
static array getTask(int $value)

These tasks are the core set of tasks that the user can perform on participants

Parameters

int $value

Return Value

array the set of tasks for a group of participants

at line 191
static array getTaskAndTitleByClass(string $className)

Function to return the task information on basis of provided task's form name

Parameters

string $className

Return Value

array [ 0 => Task ID, 1 => Task Title ]