Documentation

CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base
in package
implements CRM_Core_Selector_API

This class is used to retrieve and display a range of contacts that match the given criteria.

Table of Contents

Interfaces

CRM_Core_Selector_API
This interface defines the set of functions a class needs to implement to use the CRM/Selector object.

Properties

$_columnHeaders  : array<string|int, mixed>
We use desc to remind us what that column is, name is used in the tpl
$_links  : array<string|int, mixed>
This defines two actions- View and Edit.
$_properties  : array<string|int, mixed>
Properties of contact we're interested in displaying
$_queryParams  : array<string|int, mixed>
QueryParams is the array returned by exportValues called on the HTML_QuickForm_Controller for that page.
$_action  : int
Represent the type of selector.
$_context  : string
What context are we being invoked from
$_key  : string
The qfKey of the underlying search
$_limit  : bool
Are we restricting ourselves to a single contact
$_order  : array<string|int, mixed>
The sort order which is computed from the columnHeaders
$_permission  : string
The permission mask for this selector
$_query  : CRM_Contact_BAO_Query
The query object.
$_single  : bool
Are we restricting ourselves to a single contact
$_surveyClause  : string
The additional clause that we restrict the search with.

Methods

__construct()  : CRM_Campaign_Selector_Search
Class constructor.
getColumnHeaders()  : array<string|int, mixed>
Returns the column headers as an array of tuples: (name, sortName (key to the sort array))
getExportFileName()  : string
Name of export file.
getKey()  : string
getPagerParams()  : mixed
Getter for array of the parameters required for creating pager.
getQill()  : array<string|int, mixed>
Get the display text in plain language for the search to display on the results page
getQILL()  : array<string|int, mixed>
getQuery()  : CRM_Contact_BAO_Query
getRows()  : int
Returns all the rows in the given offset and rowCount.
getSortOrder()  : array<string|int, mixed>
Getter for the sorting direction for the fields which will be displayed on the form.
getSummary()  : null
getTemplateFileName()  : string
Compose the template file name from the class name.
getTotalCount()  : int
Returns total number of rows for the query.
links()  : array<string|int, mixed>
This method returns the links that are given for each search row.
setKey()  : mixed
setPermission()  : mixed
Setter for permission.
buildPrevNextCache()  : mixed

Properties

$_columnHeaders

We use desc to remind us what that column is, name is used in the tpl

public static array<string|int, mixed> $_columnHeaders

$_links

This defines two actions- View and Edit.

public static array<string|int, mixed> $_links = \NULL

$_properties

Properties of contact we're interested in displaying

public static array<string|int, mixed> $_properties = ['contact_id', 'sort_name', 'street_unit', 'street_name', 'street_number', 'street_address', 'city', 'postal_code', 'state_province', 'country', 'email', 'phone', 'campaign_id', 'survey_activity_id', 'survey_activity_target_id', 'survey_activity_target_contact_id']

$_queryParams

QueryParams is the array returned by exportValues called on the HTML_QuickForm_Controller for that page.

public array<string|int, mixed> $_queryParams

$_action

Represent the type of selector.

protected int $_action

$_context

What context are we being invoked from

protected string $_context = \NULL

$_key

The qfKey of the underlying search

protected string $_key

$_limit

Are we restricting ourselves to a single contact

protected bool $_limit = \NULL

$_order

The sort order which is computed from the columnHeaders

protected array<string|int, mixed> $_order

$_permission

The permission mask for this selector

protected string $_permission = \NULL

$_single

Are we restricting ourselves to a single contact

protected bool $_single = \FALSE

$_surveyClause

The additional clause that we restrict the search with.

protected string $_surveyClause = \NULL

Methods

__construct()

Class constructor.

public __construct(array<string|int, mixed> &$queryParams[, const|int $action = CRM_Core_Action::NONE ][, string $surveyClause = NULL ][, bool $single = FALSE ][, int $limit = NULL ][, string $context = 'search' ]) : CRM_Campaign_Selector_Search
Parameters
$queryParams : array<string|int, mixed>

Array of parameters for query.

$action : const|int = CRM_Core_Action::NONE
  • action of search basic or advanced.
$surveyClause : string = NULL

If the caller wants to further restrict the search.

$single : bool = FALSE

Are we dealing only with one contact?.

$limit : int = NULL

How many voters do we want returned.

$context : string = 'search'
Return values
CRM_Campaign_Selector_Search

getColumnHeaders()

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

public & getColumnHeaders([string $action = NULL ][, string $output = NULL ]) : array<string|int, mixed>
Parameters
$action : string = NULL

The action being performed.

$output : string = NULL

What should the result set include (web/email/csv).

Return values
array<string|int, mixed> —

the column headers that need to be displayed

getExportFileName()

Name of export file.

public getExportFileName([string $output = 'csv' ]) : string
Parameters
$output : string = 'csv'

Type of output.

Return values
string —

name of the file

getKey()

public getKey() : string
Return values
string

getPagerParams()

Getter for array of the parameters required for creating pager.

public getPagerParams(mixed $action, array<string|int, mixed> &$params) : mixed
Parameters
$action : mixed
$params : array<string|int, mixed>

getQill()

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

public getQill() : array<string|int, mixed>

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

Return values
array<string|int, mixed> —

array of strings

getQILL()

public getQILL() : array<string|int, mixed>
Return values
array<string|int, mixed> —

which contains an array of strings

getRows()

Returns all the rows in the given offset and rowCount.

public & getRows(string $action, int $offset, int $rowCount, string $sort[, string $output = NULL ]) : int
Parameters
$action : string

The action being performed.

$offset : int

The row number to start from.

$rowCount : int

The number of rows to return.

$sort : string

The sql string that describes the sort order.

$output : string = NULL

What should the result set include (web/email/csv).

Return values
int —

the total number of rows for this action

getSortOrder()

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

public & getSortOrder(string $action) : array<string|int, mixed>
Parameters
$action : string

the action being performed

Return values
array<string|int, mixed> —

the elements that can be sorted along with their properties

getSummary()

public getSummary() : null
Return values
null

getTemplateFileName()

Compose the template file name from the class name.

public getTemplateFileName([string $action = NULL ]) : string
Parameters
$action : string = NULL

The action being performed.

Return values
string —

template file name

getTotalCount()

Returns total number of rows for the query.

public getTotalCount(string $action) : int
Parameters
$action : string
Return values
int —

Total number of rows

links()

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

public static & links() : array<string|int, mixed>

currently the links added for each row are

  • View
  • Edit
Return values
array<string|int, mixed>

setKey()

public setKey(mixed $key) : mixed
Parameters
$key : mixed

setPermission()

Setter for permission.

public setPermission(mixed $permission) : mixed
Parameters
$permission : mixed

buildPrevNextCache()

private buildPrevNextCache(mixed $sort) : mixed
Parameters
$sort : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results