CRM_Contact_Selector

class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Selector_API

Class is to retrieve and display a range of contacts that match the given criteria.

It is specifically for results of advanced search options.

Constants

CACHE_SIZE

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 $_links This defines two actions- View and Edit.
static array $_columnHeaders We use desc to remind us what that column is, name is used in the tpl
static array $_properties Properties of contact we're interested in displaying
array $_formValues FormValues is the array returned by exportValues called on the HTML_QuickForm_Controller for that page.
protected array $_contextMenu The contextMenu
array $_params Params is the array in a value used by the search query creator
protected array $_returnProperties The return properties used for search
protected int $_action Represent the type of selector
protected $_searchContext
protected CRM_Contact_BAO_Query $_query Query object for this selector.
protected int $_ufGroupID Group id
protected array $_fields The public visible fields to be shown to the user

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 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.

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)

This method set cache key, later used in test environment

string
getKey()

No description

from CRM_Core_Selector_Base
CRM_Contact_BAO_Query
getQueryObject()

Get the query object for this selector.

CRM_Contact_Selector
__construct($customSearchClass, array $formValues = NULL, array $params = NULL, null $returnProperties = NULL, const|int $action = CRM_Core_Action::NONE, bool $includeContactIds = FALSE, bool $searchDescendentGroups = TRUE, string $searchContext = 'search', null $contextMenu = NULL)

Class constructor.

getPagerParams(string $action, array $params)

Getter for array of the parameters required for creating pager.

array
getColHeads(null $action = NULL, null $output = NULL)

No description

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
buildPrevNextCache(CRM_Utils_Sort $sort)

No description

addActions($rows)

No description

removeActions($rows)

No description

fillupPrevNextCache(CRM_Utils_Sort $sort, string $cacheKey, int $start = 0, int $end = self::CACHE_SIZE)

No description

rebuildPreNextCache(int $start, int $end, CRM_Utils_Sort $sort, string $cacheKey)

called to rebuild prev next cache using full sql in case of core search ( excluding custom search)

getQILL()

No description

string
getExportFileName(string $output = 'csv')

Name of export file.

CRM_Contact_BAO_Query
getQuery()

No description

CRM_Contact_DAO_Contact
alphabetQuery()

No description

CRM_Contact_DAO_Contact
contactIDQuery(array $params, int $sortID, null $displayRelationshipType = NULL, string $queryOperator = 'AND')

No description

array
makeProperties($returnProperties)

No description

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

currently the links added for each row are

  • View
  • Edit

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

at line 247
setKey($key)

This method set cache key, later used in test environment

Parameters

$key

in CRM_Core_Selector_Base at line 189
string getKey()

Return Value

string

at line 133
CRM_Contact_BAO_Query getQueryObject()

Get the query object for this selector.

Return Value

CRM_Contact_BAO_Query

at line 169
CRM_Contact_Selector __construct($customSearchClass, array $formValues = NULL, array $params = NULL, null $returnProperties = NULL, const|int $action = CRM_Core_Action::NONE, bool $includeContactIds = FALSE, bool $searchDescendentGroups = TRUE, string $searchContext = 'search', null $contextMenu = NULL)

Class constructor.

Parameters

$customSearchClass
array $formValues Array of form values imported.
array $params Array of parameters for query.
null $returnProperties
const|int $action
  • action of search basic or advanced.
bool $includeContactIds
bool $searchDescendentGroups
string $searchContext
null $contextMenu

Return Value

CRM_Contact_Selector

at line 334
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 349
array getColHeads(null $action = NULL, null $output = NULL)

Parameters

null $action
null $output

Return Value

array

at line 367
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 535
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 564
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 864
string buildPrevNextCache(CRM_Utils_Sort $sort)

Parameters

CRM_Utils_Sort $sort

Return Value

string

at line 918
addActions($rows)

Parameters

$rows

at line 1007
removeActions($rows)

Parameters

$rows

at line 1022
fillupPrevNextCache(CRM_Utils_Sort $sort, string $cacheKey, int $start = 0, int $end = self::CACHE_SIZE)

Parameters

CRM_Utils_Sort $sort
string $cacheKey
int $start
int $end

Exceptions

CRM_Core_Exception

at line 1086
rebuildPreNextCache(int $start, int $end, CRM_Utils_Sort $sort, string $cacheKey)

called to rebuild prev next cache using full sql in case of core search ( excluding custom search)

Parameters

int $start Start for limit clause.
int $end End for limit clause.
CRM_Utils_Sort $sort
string $cacheKey Cache key.

at line 1110
getQILL()

at line 1123
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 1191
CRM_Contact_BAO_Query getQuery()

Return Value

CRM_Contact_BAO_Query

at line 1198
CRM_Contact_DAO_Contact alphabetQuery()

Return Value

CRM_Contact_DAO_Contact

at line 1210
CRM_Contact_DAO_Contact contactIDQuery(array $params, int $sortID, null $displayRelationshipType = NULL, string $queryOperator = 'AND')

Parameters

array $params
int $sortID
null $displayRelationshipType
string $queryOperator

Return Value

CRM_Contact_DAO_Contact

at line 1244
array makeProperties($returnProperties)

Parameters

$returnProperties

Return Value

array