CRM_Contact_Form_Search_Interface
in
Tags
Table of Contents
Methods
- __construct() : mixed
- The constructor gets the submitted form values.
- all() : mixed
- Retrieve all the values that match the current input parameters.
- buildForm() : mixed
- Builds the quickform for this search.
- buildTaskList() : array<string|int, mixed>
- Builds the list of tasks or actions that a searcher can perform on a result set.
- columns() : mixed
- Returns an array of column headers and field names and sort options.
- contactIDs() : mixed
- List of contact ids that match the current input parameters.
- count() : mixed
- Count of records that match the current input parameters.
- from() : mixed
- The from clause for the query.
- summary() : mixed
- Summary information for the query that can be displayed in the template.
- templateFile() : mixed
- The template FileName to use to display the results.
- where() : mixed
- The where clause for the query.
Methods
__construct()
The constructor gets the submitted form values.
public
__construct(array<string|int, mixed> &$formValues) : mixed
Parameters
- $formValues : array<string|int, mixed>
all()
Retrieve all the values that match the current input parameters.
public
all([int $offset = 0 ][, int $rowcount = 0 ][, null $sort = NULL ][, bool $includeContactIDs = FALSE ][, bool $justIDs = FALSE ]) : mixed
Used by the selector
Parameters
- $offset : int = 0
- $rowcount : int = 0
- $sort : null = NULL
- $includeContactIDs : bool = FALSE
- $justIDs : bool = FALSE
buildForm()
Builds the quickform for this search.
public
buildForm(CRM_Core_Form &$form) : mixed
Parameters
- $form : CRM_Core_Form
buildTaskList()
Builds the list of tasks or actions that a searcher can perform on a result set.
public
buildTaskList(CRM_Core_Form_Search $form) : array<string|int, mixed>
Parameters
- $form : CRM_Core_Form_Search
Return values
array<string|int, mixed>columns()
Returns an array of column headers and field names and sort options.
public
& columns() : mixed
contactIDs()
List of contact ids that match the current input parameters.
public
contactIDs([int $offset = 0 ][, int $rowcount = 0 ][, null $sort = NULL ]) : mixed
Used by different tasks. Will be also used to optimize the 'all' query below to avoid excessive LEFT JOIN blowup
Parameters
- $offset : int = 0
- $rowcount : int = 0
- $sort : null = NULL
count()
Count of records that match the current input parameters.
public
count() : mixed
Used by pager.
from()
The from clause for the query.
public
from() : mixed
summary()
Summary information for the query that can be displayed in the template.
public
summary() : mixed
This is useful to pass total / sub total information if needed
templateFile()
The template FileName to use to display the results.
public
templateFile() : mixed
where()
The where clause for the query.
public
where([bool $includeContactIDs = FALSE ]) : mixed
Parameters
- $includeContactIDs : bool = FALSE