CRM_Contact_BAO_Query_Interface

class CRM_Contact_BAO_Query_Interface

Abstract class for search BAO query objects

Methods

getFields()

No description

mixed
from(string $fieldName, $mode, $side)

No description

null
select($query)

No description

null
where($query)

No description

null
setTableDependency($tables)

No description

null
registerAdvancedSearchPane($panes)

No description

null
buildAdvancedSearchPaneForm(CRM_Core_Form $form, $type)

No description

null
setAdvancedSearchPaneTemplatePath($paneTemplatePathArray, $type)

No description

alterSearchBuilderOptions(array $apiEntities, array $fieldOptions)

Describe options for available for use in the search-builder.

Details

at line 39
abstract getFields()

at line 48
abstract mixed from(string $fieldName, $mode, $side)

Parameters

string $fieldName
$mode
$side

Return Value

mixed

at line 55
null select($query)

Parameters

$query

Return Value

null

at line 64
null where($query)

Parameters

$query

Return Value

null

at line 73
null setTableDependency($tables)

Parameters

$tables

Return Value

null

at line 82
null registerAdvancedSearchPane($panes)

Parameters

$panes

Return Value

null

at line 92
null buildAdvancedSearchPaneForm(CRM_Core_Form $form, $type)

Parameters

CRM_Core_Form $form
$type

Return Value

null

at line 102
null setAdvancedSearchPaneTemplatePath($paneTemplatePathArray, $type)

Parameters

$paneTemplatePathArray
$type

Return Value

null

at line 121
alterSearchBuilderOptions(array $apiEntities, array $fieldOptions)

Describe options for available for use in the search-builder.

The search builder determines its options by examining the API metadata corresponding to each search field. This approach assumes that each field has a unique-name (ie that the field's unique-name in the API matches the unique-name in the search-builder).

Parameters

array $apiEntities List of entities whose options should be automatically scanned using API metadata.
array $fieldOptions Keys are field unique-names; values describe how to lookup the options. For boolean options, use value "yesno". For pseudoconstants/FKs, use the name of an API entity from which the metadata of the field may be queried. (Yes - that is a mouthful.)