CRM_Activity_Selector_Activity

class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements CRM_Core_Selector_API

This class is used to retrieve and display activities for a contact.

Properties

protected array $_order The sort order which is computed from the columnHeaders from CRM_Core_Selector_Base
protected string $_permission The permission mask for this selector from CRM_Core_Selector_Base
protected string $_key The qfKey of the underlying search from CRM_Core_Selector_Base
static array $_columnHeaders We use desc to remind us what that column is, name is used in the tpl
protected int $_contactId ContactId - contact id of contact whose activies are displayed
protected $_admin
protected $_context
protected $_activityTypeIDs
protected $_viewOptions

Methods

string
getActionAttribute(string $match, string $attribute = 'name')

This function gets the attribute for the action that.

from CRM_Core_Selector_Base
static 
links()

This is a static virtual function returning reference on links array. Each inherited class must redefine this function

from CRM_Core_Selector_Base
string
getTemplateFileName(string $action = NULL)

Compose the template file name from the class name.

from CRM_Core_Selector_Base
array
getSortOrder(string $action)

Getter for the sorting direction for the fields which will be displayed on the form.

from CRM_Core_Selector_Base
setPermission($permission)

Setter for permission.

from CRM_Core_Selector_Base
array
getQill()

Get the display text in plain language for the search to display on the results page

from CRM_Core_Selector_Base
null
getSummary()

No description

from CRM_Core_Selector_Base
setKey($key)

No description

from CRM_Core_Selector_Base
string
getKey()

No description

from CRM_Core_Selector_Base
CRM_Activity_Selector_Activity
__construct(int $contactId, int $permission, bool $admin = FALSE, string $context = 'activity', null $activityTypeIDs = NULL)

Class constructor.

static array
actionLinks(int $activityTypeId, int $sourceRecordId = NULL, bool $accessMailingReport = FALSE, int $activityId = NULL, null $key = NULL, null $compContext = NULL)

This method returns the action links that are given for each search row.

getPagerParams(string $action, array $params)

Getter for array of the parameters required for creating pager.

array
getColumnHeaders(string $action = NULL, string $output = NULL)

Returns the column headers as an array of tuples: (name, sortName (key to the sort array))

int
getTotalCount(string $action, null $case = NULL)

Returns total number of rows for the query.

int
getRows(string $action, int $offset, int $rowCount, string $sort, string $output = NULL, null $case = NULL)

Returns all the rows in the given offset and rowCount.

string
getExportFileName(string $output = 'csv')

Name of export file.

Details

in CRM_Core_Selector_Base at line 72
string getActionAttribute(string $match, string $attribute = 'name')

This function gets the attribute for the action that.

it matches.

Parameters

string $match the action to match against
string $attribute the attribute to return ( name, link, title )

Return Value

string the attribute that matches the action if any

This is a static virtual function returning reference on links array. Each inherited class must redefine this function

links is an array of associative arrays. Each element of the array has at least 3 fields

name : the name of the link url : the URI to be used for this link qs : the parameters to the above url along with any dynamic substitutions title : A more descriptive name, typically used in breadcrumbs / navigation

in CRM_Core_Selector_Base at line 108
string getTemplateFileName(string $action = NULL)

Compose the template file name from the class name.

Parameters

string $action The action being performed.

Return Value

string template file name

in CRM_Core_Selector_Base at line 120
array getSortOrder(string $action)

Getter for the sorting direction for the fields which will be displayed on the form.

Parameters

string $action the action being performed

Return Value

array the elements that can be sorted along with their properties

in CRM_Core_Selector_Base at line 154
setPermission($permission)

Setter for permission.

Parameters

$permission

in CRM_Core_Selector_Base at line 168
array getQill()

Get the display text in plain language for the search to display on the results page

FIXME: the current internationalisation is bad, but should more or less work on most of "European" languages

Return Value

array array of strings

in CRM_Core_Selector_Base at line 175
null getSummary()

Return Value

null

in CRM_Core_Selector_Base at line 182
setKey($key)

Parameters

$key

in CRM_Core_Selector_Base at line 189
string getKey()

Return Value

string

at line 75
CRM_Activity_Selector_Activity __construct(int $contactId, int $permission, bool $admin = FALSE, string $context = 'activity', null $activityTypeIDs = NULL)

Class constructor.

Parameters

int $contactId Contact whose activities we want to display.
int $permission The permission we have for this contact.
bool $admin
string $context
null $activityTypeIDs

Return Value

CRM_Activity_Selector_Activity

This method returns the action links that are given for each search row.

currently the action links added for each row are

  • View

Parameters

int $activityTypeId
int $sourceRecordId
bool $accessMailingReport
int $activityId
null $key
null $compContext

Return Value

array

at line 301
getPagerParams(string $action, array $params)

Getter for array of the parameters required for creating pager.

Parameters

string $action The action being performed.
array $params The array that the pagerParams will be inserted into.

at line 322
array getColumnHeaders(string $action = NULL, string $output = NULL)

Returns the column headers as an array of tuples: (name, sortName (key to the sort array))

Parameters

string $action The action being performed.
string $output What should the result set include (web/email/csv).

Return Value

array the column headers that need to be displayed

at line 348
int getTotalCount(string $action, null $case = NULL)

Returns total number of rows for the query.

Parameters

string $action The action being performed.
null $case

Return Value

int the total number of rows for this action

at line 381
int getRows(string $action, int $offset, int $rowCount, string $sort, string $output = NULL, null $case = NULL)

Returns all the rows in the given offset and rowCount.

Parameters

string $action The action being performed.
int $offset The row number to start from.
int $rowCount The number of rows to return.
string $sort The sql string that describes the sort order.
string $output What should the result set include (web/email/csv).
null $case

Return Value

int the total number of rows for this action

at line 503
string getExportFileName(string $output = 'csv')

Name of export file.

Parameters

string $output Type of output.

Return Value

string the fileName which we will munge to skip spaces and special characters to avoid various browser issues