CRM_Core_Selector_Base

class CRM_Core_Selector_Base

A simple base class for objects that need to implement the selector api interface. This class provides common functionality with regard to actions and display names

Properties

protected array $_order The sort order which is computed from the columnHeaders
protected string $_permission The permission mask for this selector
protected string $_key The qfKey of the underlying search

Methods

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

This function gets the attribute for the action that.

static 
links()

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

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

Details

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

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

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

at line 154
setPermission($permission)

Setter for permission.

Parameters

$permission

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

at line 175
null getSummary()

Return Value

null

at line 182
setKey($key)

Parameters

$key

at line 189
string getKey()

Return Value

string