Documentation

CRM_Contact_Form_Search_Custom_Proximity extends CRM_Contact_Form_Search_Custom_Base
in package
implements CRM_Contact_Form_Search_Interface

This search now functions as a subset of advanced search since at some point it was added to advanced search.

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
Retrieve all the values that match the current input parameters.
alterRow()  : 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()  : mixed
contactIDs()  : string
count()  : null|string
fillPrevNextCache()  : bool
Fill the prevNextCache with the found contacts
formRule()  : array<string|int, mixed>
Validate form input.
from()  : string
The from clause for the query.
getQueryObj()  : CRM_Contact_BAO_Query
Get the query object for this selector.
includeContactIDs()  : mixed
setDefaultValues()  : array<string|int, mixed>
setTitle()  : mixed
Setter function for title.
sql()  : string
Override sql() function to use the Query object rather than generating on the form.
summary()  : null
templateFile()  : string
validateUserSQL()  : void
where()  : string
The where clause for the query.
whereClause()  : string
addGeocodingData()  : mixed
Add the geocoding data to the fields supplied.

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.

$_aclWhere

protected mixed $_aclWhere = \NULL

$_columns

protected mixed $_columns

$_formValues

protected mixed $_formValues

$_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
Exception

addSortOffset()

public addSortOffset(mixed &$sql, mixed $offset, mixed $rowcount, mixed $sort) : mixed
Parameters
$sql : mixed
$offset : mixed
$rowcount : mixed
$sort : 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 ]) : string
Parameters
$offset : int = 0
$rowcount : int = 0
$sort : null = NULL
$includeContactIDs : bool = FALSE
$justIDs : bool = FALSE
Return values
string

alterRow()

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

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() : mixed

contactIDs()

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

Deprecated parameter

Return values
string

count()

public count() : null|string
Return values
null|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.

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()

The from clause for the query.

public from() : string
Return values
string

includeContactIDs()

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

setDefaultValues()

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

setTitle()

Setter function for title.

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

The title of the form.

sql()

Override sql() function to use the Query object rather than generating on the form.

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

summary()

public summary() : null
Return values
null

templateFile()

public templateFile() : string
Return values
string

validateUserSQL()

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

where()

The where clause for the query.

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

addGeocodingData()

Add the geocoding data to the fields supplied.

protected addGeocodingData(array<string|int, mixed> &$fields) : mixed
Parameters
$fields : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results