CRM_Contact_Form_Search_Interface

interface CRM_Contact_Form_Search_Interface

Methods

__construct(array $formValues)

The constructor gets the submitted form values.

array
buildTaskList( $form)

Builds the list of tasks or actions that a searcher can perform on a result set.

buildForm(CRM_Core_Form $form)

Builds the quickform for this search.

count()

Count of records that match the current input parameters.

summary()

Summary information for the query that can be displayed in the template.

contactIDs(int $offset, int $rowcount, null $sort = NULL)

List of contact ids that match the current input parameters.

all(int $offset, int $rowcount, null $sort = NULL, bool $includeContactIDs = FALSE, bool $justIDs = FALSE)

Retrieve all the values that match the current input parameters.

from()

The from clause for the query.

where(bool $includeContactIDs = FALSE)

The where clause for the query.

templateFile()

The template FileName to use to display the results.

columns()

Returns an array of column headers and field names and sort options.

Details

at line 40
__construct(array $formValues)

The constructor gets the submitted form values.

Parameters

array $formValues

at line 48
array buildTaskList( $form)

Builds the list of tasks or actions that a searcher can perform on a result set.

Parameters

$form

Return Value

array

at line 55
buildForm(CRM_Core_Form $form)

Builds the quickform for this search.

Parameters

CRM_Core_Form $form

at line 69
count()

Count of records that match the current input parameters.

Used by pager.

at line 76
summary()

Summary information for the query that can be displayed in the template.

This is useful to pass total / sub total information if needed

at line 88
contactIDs(int $offset, int $rowcount, null $sort = NULL)

List of contact ids that match the current input parameters.

Used by different tasks. Will be also used to optimize the 'all' query below to avoid excessive LEFT JOIN blowup

Parameters

int $offset
int $rowcount
null $sort

at line 101
all(int $offset, int $rowcount, null $sort = NULL, bool $includeContactIDs = FALSE, bool $justIDs = FALSE)

Retrieve all the values that match the current input parameters.

Used by the selector

Parameters

int $offset
int $rowcount
null $sort
bool $includeContactIDs
bool $justIDs

at line 115
from()

The from clause for the query.

at line 122
where(bool $includeContactIDs = FALSE)

The where clause for the query.

Parameters

bool $includeContactIDs

at line 127
templateFile()

The template FileName to use to display the results.

at line 132
columns()

Returns an array of column headers and field names and sort options.