Documentation

CRM_Contact_Form_Search_Custom_ActivitySearch extends CRM_Contact_Form_Search_Custom_Base
in package
implements CRM_Contact_Form_Search_Interface

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Interfaces

CRM_Contact_Form_Search_Interface

Properties

$searchClassHandlesPrevNextCache  : bool
Does the search class handle the prev next cache saving.
$_aclFrom  : mixed
$_aclWhere  : mixed
$_columns  : mixed
$_formValues  : mixed
$_stateID  : mixed
$_title  : string
The title of this form

Methods

__construct()  : mixed
Class constructor.
addSortOffset()  : mixed
all()  : string
Construct the search query.
alterRow()  : mixed
Alters the date display in the Activity Date Column. We do this after we already have the result so that sorting on the date column stays pertinent to the numeric date value
buildACLClause()  : mixed
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()  : array<string|int, mixed>
contactIDs()  : string
count()  : null|string
fillPrevNextCache()  : bool
Fill the prevNextCache with the found contacts
formatSavedSearchFields()  : array<string|int, mixed>
Format saved search fields for this custom group.
formRule()  : array<string|int, mixed>
Validate form input.
from()  : string
Regular JOIN statements here to limit results to contacts who have activities.
getQueryObj()  : null
override this method to define the contact query object used for creating $sql
includeContactIDs()  : mixed
setTitle()  : mixed
Setter function for title.
sql()  : string
summary()  : null
templateFile()  : null
Define the smarty template used to layout the search form and results listings.
validateUserSQL()  : void
where()  : string
WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values.
whereClause()  : string

Properties

$searchClassHandlesPrevNextCache

Does the search class handle the prev next cache saving.

public bool $searchClassHandlesPrevNextCache = \FALSE

This can be set to yes as long as a UI test works, and the deprecation notice will disappear.

$_columns

protected mixed $_columns

$_stateID

protected mixed $_stateID

$_title

The title of this form

protected string $_title = \NULL

Methods

__construct()

Class constructor.

public __construct(array<string|int, mixed> &$formValues) : mixed
Parameters
$formValues : array<string|int, mixed>
Tags
throws
CRM_Core_Exception

addSortOffset()

public addSortOffset(mixed &$sql, mixed $offset, mixed $rowcount, mixed $sort) : mixed
Parameters
$sql : mixed
$offset : mixed
$rowcount : mixed
$sort : mixed

all()

Construct the search query.

public all([int $offset = 0 ][, int $rowcount = 0 ][, null $sort = NULL ][, bool $includeContactIDs = FALSE ][, bool $justIDs = FALSE ]) : string
Parameters
$offset : int = 0
$rowcount : int = 0
$sort : null = NULL
$includeContactIDs : bool = FALSE
$justIDs : bool = FALSE
Tags
throws
CRM_Core_Exception
Return values
string

alterRow()

Alters the date display in the Activity Date Column. We do this after we already have the result so that sorting on the date column stays pertinent to the numeric date value

public alterRow(mixed &$row) : mixed
Parameters
$row : mixed

buildACLClause()

public buildACLClause([string $tableAlias = 'contact' ]) : mixed
Parameters
$tableAlias : string = 'contact'

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>

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.

Parameters
$form : CRM_Core_Form_Search
Return values
array<string|int, mixed>

columns()

public & columns() : array<string|int, mixed>
Return values
array<string|int, mixed>

contactIDs()

public contactIDs([int $offset = 0 ][, int $rowcount = 0 ][, null $sort = NULL ][, bool $returnSQL = TRUE ]) : string
Parameters
$offset : int = 0
$rowcount : int = 0
$sort : null = NULL
$returnSQL : bool = TRUE

Not used; included for consistency with parent; SQL is always returned

Return values
string

fillPrevNextCache()

Fill the prevNextCache with the found contacts

public fillPrevNextCache(mixed $cacheKey, mixed $start, mixed $end, mixed $sort) : bool
Parameters
$cacheKey : mixed
$start : mixed
$end : mixed
$sort : mixed
Return values
bool —

TRUE if the search was able to process it.

formatSavedSearchFields()

Format saved search fields for this custom group.

public static formatSavedSearchFields(array<string|int, mixed> $formValues) : array<string|int, mixed>

Note this is a function to facilitate the transition to jcalendar for saved search groups. In time it can be stripped out again.

Parameters
$formValues : array<string|int, mixed>
Return values
array<string|int, mixed>

formRule()

Validate form input.

public formRule(array<string|int, mixed> $fields, array<string|int, mixed> $files, CRM_Core_Form $self) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed>
$files : array<string|int, mixed>
$self : CRM_Core_Form
Return values
array<string|int, mixed> —

Input errors from the form.

from()

Regular JOIN statements here to limit results to contacts who have activities.

public from() : string
Return values
string

getQueryObj()

override this method to define the contact query object used for creating $sql

public getQueryObj() : null
Return values
null

includeContactIDs()

public static includeContactIDs(mixed &$sql, mixed &$formValues) : mixed
Parameters
$sql : mixed
$formValues : mixed

setTitle()

Setter function for title.

public setTitle(string $title) : mixed
Parameters
$title : string

The title of the form.

sql()

public sql(mixed $selectClause[, int $offset = 0 ][, int $rowcount = 0 ][, null $sort = NULL ][, bool $includeContactIDs = FALSE ][, null $groupBy = NULL ]) : string
Parameters
$selectClause : mixed
$offset : int = 0
$rowcount : int = 0
$sort : null = NULL
$includeContactIDs : bool = FALSE
$groupBy : null = NULL
Return values
string

templateFile()

Define the smarty template used to layout the search form and results listings.

public templateFile() : null
Return values
null

validateUserSQL()

public validateUserSQL(mixed $sql[, bool $onlyWhere = FALSE ]) : void
Parameters
$sql : mixed
$onlyWhere : bool = FALSE

where()

WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values.

public where([bool $includeContactIDs = FALSE ]) : string
Parameters
$includeContactIDs : bool = FALSE
Return values
string

whereClause()

public whereClause(mixed &$where, array<string|int, mixed> &$params) : string
Parameters
$where : mixed
$params : array<string|int, mixed>
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results