CRM_Contact_Form_Search_Custom_Base
class CRM_Contact_Form_Search_Custom_Base
Properties
protected | $_formValues | ||
protected | $_columns | ||
protected | $_stateID |
Methods
__construct(array $formValues)
Class constructor.
array
buildTaskList(CRM_Core_Form_Search $form)
Builds the list of tasks or actions that a searcher can perform on a result set.
null|string
count()
No description
null
summary()
No description
string
contactIDs(int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $returnSQL = FALSE)
No description
string
sql($selectClause, int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $includeContactIDs = FALSE, null $groupBy = NULL)
No description
null
templateFile()
No description
columns()
No description
static
includeContactIDs($sql, $formValues)
No description
addSortOffset($sql, $offset, $rowcount, $sort)
No description
validateUserSQL($sql, bool $onlyWhere = FALSE)
No description
string
whereClause($where, array $params)
No description
null
getQueryObj()
override this method to define the contact query object used for creating $sql
setTitle(string $title)
Set the title.
array
Details
at line 46
__construct(array $formValues)
Class constructor.
at line 59
array
buildTaskList(CRM_Core_Form_Search $form)
Builds the list of tasks or actions that a searcher can perform on a result set.
The returned array completely replaces the task list, so a child class that wants to modify the existing list should manipulate the result of this method.
at line 66
null|string
count()
at line 73
null
summary()
at line 85
string
contactIDs(int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $returnSQL = FALSE)
at line 111
string
sql($selectClause, int $offset = 0, int $rowcount = 0, null $sort = NULL, bool $includeContactIDs = FALSE, null $groupBy = NULL)
at line 143
null
templateFile()
at line 147
columns()
at line 155
static
includeContactIDs($sql, $formValues)
at line 177
addSortOffset($sql, $offset, $rowcount, $sort)
at line 202
validateUserSQL($sql, bool $onlyWhere = FALSE)
at line 233
string
whereClause($where, array $params)
at line 242
null
getQueryObj()
override this method to define the contact query object used for creating $sql
at line 251
setTitle(string $title)
Set the title.
at line 270
array
formRule(array $fields, array $files, CRM_Core_Form $self)
Validate form input.