CRM_Profile_Selector_Listings
class CRM_Profile_Selector_Listings 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 |
static array | $_links | Array of supported links, currently view and edit | |
static array | $_columnHeaders | We use desc to remind us what that column is, name is used in the tpl | |
protected string | $_params | The sql params we use to get the list of contacts. | |
protected array | $_fields | The public visible fields to be shown to the user. | |
protected array | $_customFields | The custom fields for this domain. | |
protected object | $_query | Cache the query object. | |
protected object | $_options | Cache the expanded options list if any. | |
protected int | $_gid | The group id that we are editing. | |
protected boolean | $_map | Do we enable mapping of users. | |
protected boolean | $_editLink | Do we enable edit link. | |
protected boolean | $_linkToUF | Should we link to the UF Profile. | |
protected | $_profileIds | Store profile ids if multiple profile ids are passed using comma separated. | |
protected | $_multiRecordTableName |
Methods
This function gets the attribute for the action that.
This method returns the links that are given for each search row.
Compose the template file name from the class name.
Getter for the sorting direction for the fields which will be displayed on the form.
Return the qill for this selector.
Class constructor.
Getter for array of the parameters required for creating pager.
Returns the column headers as an array of tuples: (name, sortName (key to the sort array))
Returns total number of rows for the query.
Returns all the rows in the given offset and rowCount.
Name of export file.
Set the _multiRecordTableName to display the result set.
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.
at line 212
static
links(bool $map = FALSE, bool $editLink = FALSE, bool $ufLink = FALSE, null $gids = NULL)
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.
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.
in CRM_Core_Selector_Base at line 154
setPermission($permission)
Setter for permission.
at line 421
array
getQill()
Return the qill for this selector.
in CRM_Core_Selector_Base at line 175
null
getSummary()
in CRM_Core_Selector_Base at line 182
setKey($key)
in CRM_Core_Selector_Base at line 189
string
getKey()
at line 139
CRM_Profile_Selector_Listings
__construct(array $params, array $customFields, array $ufGroupIds = NULL, bool $map = FALSE, bool $editLink = FALSE, bool $linkToUF = FALSE)
Class constructor.
at line 273
getPagerParams(string $action, array $params)
Getter for array of the parameters required for creating pager.
at line 295
array
getColumnHeaders(string $action = NULL, string $output = NULL)
Returns the column headers as an array of tuples: (name, sortName (key to the sort array))
at line 390
int
getTotalCount(string $action)
Returns total number of rows for the query.
at line 444
int
getRows(string $action, int $offset, int $rowCount, string $sort, string $output = NULL, string $extraWhereClause = NULL)
Returns all the rows in the given offset and rowCount.
at line 740
string
getExportFileName(string $output = 'csv')
Name of export file.
at line 751
setMultiRecordTableName(array $fields)
Set the _multiRecordTableName to display the result set.
(according to multi record custom field values).