CRM_Contact_BAO_Query_Hook
in package
Delegate query functions based on hook system.
Table of Contents
Properties
- $_queryObjects : array<string|int, CRM_Contact_BAO_Query_Interface>
- Query objects.
Methods
- alterSearchBuilderOptions() : mixed
- alterSearchQuery() : mixed
- Alter search query.
- buildAdvancedSearchPaneForm() : mixed
- buildSearchfrom() : string
- getContactFields() : array<string|int, mixed>
- Get the fields that are available in the 'contact context'.
- getDefaultReturnProperties() : array<string|int, mixed>|null
- This gives the opportunity for a single hook to return default fields.
- getFields() : array<string|int, mixed>
- getPanesMapper() : mixed
- getSearchQueryObjects() : array<string|int, CRM_Contact_BAO_Query_Interface>
- Get or build the list of search objects (via hook).
- registerAdvancedSearchPane() : mixed
- setAdvancedSearchPaneTemplatePath() : mixed
- setTableDependency() : mixed
- singleton() : object
- Singleton function used to manage this object.
Properties
$_queryObjects
Query objects.
protected
array<string|int, CRM_Contact_BAO_Query_Interface>
$_queryObjects
= \NULL
Methods
alterSearchBuilderOptions()
public
alterSearchBuilderOptions(mixed &$apiEntities, mixed &$fieldOptions) : mixed
Parameters
- $apiEntities : mixed
- $fieldOptions : mixed
alterSearchQuery()
Alter search query.
public
alterSearchQuery(string &$query, string $fnName) : mixed
Parameters
- $query : string
- $fnName : string
buildAdvancedSearchPaneForm()
public
buildAdvancedSearchPaneForm(CRM_Core_Form &$form, mixed $type) : mixed
Parameters
- $form : CRM_Core_Form
- $type : mixed
buildSearchfrom()
public
buildSearchfrom(string $fieldName, mixed $mode, mixed $side) : string
Parameters
- $fieldName : string
- $mode : mixed
- $side : mixed
Return values
stringgetContactFields()
Get the fields that are available in the 'contact context'.
public
getContactFields() : array<string|int, mixed>
For example exporting contacts should not include fields for grants etc.
Return values
array<string|int, mixed>getDefaultReturnProperties()
This gives the opportunity for a single hook to return default fields.
public
getDefaultReturnProperties(mixed $mode) : array<string|int, mixed>|null
It only runs if no core components have defaults for this $mode. The expectation is that only one hook will handle this mode, so just the first one to return a value is used.
Parameters
- $mode : mixed
Return values
array<string|int, mixed>|nullgetFields()
public
& getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getPanesMapper()
public
getPanesMapper(mixed &$panes) : mixed
Parameters
- $panes : mixed
getSearchQueryObjects()
Get or build the list of search objects (via hook).
public
getSearchQueryObjects() : array<string|int, CRM_Contact_BAO_Query_Interface>
Return values
array<string|int, CRM_Contact_BAO_Query_Interface>registerAdvancedSearchPane()
public
registerAdvancedSearchPane(mixed &$panes) : mixed
Parameters
- $panes : mixed
setAdvancedSearchPaneTemplatePath()
public
setAdvancedSearchPaneTemplatePath(mixed &$paneTemplatePathArray, mixed $type) : mixed
Parameters
- $paneTemplatePathArray : mixed
- $type : mixed
setTableDependency()
public
setTableDependency(mixed &$tables) : mixed
Parameters
- $tables : mixed
singleton()
Singleton function used to manage this object.
public
static singleton() : object