class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_Core_Selector_API

This class is used to retrieve and display a range of contacts that match the given criteria (specifically for results of advanced search options.

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
$_links Array of supported links, currently null
array $_columnHeaders We use desc to remind us what that column is, name is used in the tpl

Methods

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

This function gets the attribute for the action that.

static 
links()

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

string
getTemplateFileName(string $action = NULL)

Compose the template file name from the class name.

array
getSortOrder(string $action)

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

setPermission($permission)

Setter for permission.

array
getQill()

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

null
getSummary()

No description

setKey($key)

No description

string
getKey()

No description

__construct(string $event, bool $distinct, int $mailing, int $job = NULL, int $url = NULL)

Class constructor.

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)

Returns total number of rows for the query.

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

Returns all the rows in the given offset and rowCount.

string
getExportFileName(string $output = 'csv')

Name of export file.

string
eventToTitle()

Get the title for the mailing event type.

string
getTitle()

Get the title of the event.

Details

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 method returns the links that are given for each search row.

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 96
CRM_Mailing_Selector_Event __construct(string $event, bool $distinct, int $mailing, int $job = NULL, int $url = NULL)

Class constructor.

Parameters

string $event The event type (queue/delivered/open...).
bool $distinct Count only distinct contact events?.
int $mailing ID of the mailing to query.
int $job ID of the job to query. If null, all jobs from $mailing are queried.
int $url If the event type is a click-through, do we want only those from a specific url?.

Return Value

CRM_Mailing_Selector_Event

at line 119
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 139
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 262
int getTotalCount(string $action)

Returns total number of rows for the query.

Parameters

string $action The action being performed.

Return Value

int the total number of rows for this action

at line 359
int getRows(string $action, int $offset, int $rowCount, string $sort, string $output = 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).

Return Value

int the total number of rows for this action

at line 438
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

at line 447
string eventToTitle()

Get the title for the mailing event type.

Return Value

string

at line 471
string getTitle()

Get the title of the event.

Return Value

string