class CRM_Core_BAO_CustomQuery

Constants

PREFIX

Properties

protected array $_ids The set of custom field ids.
array $_select The select clause.
array $_element The name of the elements that are in the select clause.
array $_tables The tables involved in the query.
$_whereTables
array $_where The where clause.
array $_qill The english language version of the query.
array $_options No longer needed due to CRM-17646 refactoring, but still used in some places
array $_fields The custom fields information.
protected bool $_contactSearch Searching for contacts?
protected $_locationSpecificCustomFields
static array $extendsMap This stores custom data group types and tables that it extends.

Methods

array
getFields()

No description

__construct(array $ids, bool $contactSearch = FALSE, array $locationSpecificFields = [])

Class constructor.

select()

Generate the select clause and the associated tables.

where()

Generate the where clause and also the english language equivalent.

array
query()

Function that does the actual query generation.

joinCustomTableForField(array $field)

Join the custom table for the field in (if not already in the query).

Details

at line 99
array getFields()

Return Value

array

at line 150
__construct(array $ids, bool $contactSearch = FALSE, array $locationSpecificFields = [])

Class constructor.

Takes in a set of custom field ids andsets up the data structures to generate a query

Parameters

array $ids The set of custom field ids.
bool $contactSearch
array $locationSpecificFields

at line 211
select()

Generate the select clause and the associated tables.

at line 239
where()

Generate the where clause and also the english language equivalent.

Exceptions

CRM_Core_Exception

at line 436
array query()

Function that does the actual query generation.

basically ties all the above functions together

Return Value

array array of strings

at line 466
protected joinCustomTableForField(array $field)

Join the custom table for the field in (if not already in the query).

Parameters

array $field