Documentation

CRM_Contact_BAO_Query_Interface
in package

AbstractYes

Abstract class for search BAO query objects

Table of Contents

Methods

alterSearchBuilderOptions()  : mixed
Describe options for available for use in the search-builder.
buildAdvancedSearchPaneForm()  : null
defaultReturnProperties()  : array<string|int, mixed>|null
from()  : mixed
getFields()  : mixed
registerAdvancedSearchPane()  : mixed
select()  : mixed
setAdvancedSearchPaneTemplatePath()  : null
setTableDependency()  : mixed
where()  : mixed

Methods

alterSearchBuilderOptions()

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

public alterSearchBuilderOptions(array<string|int, mixed> &$apiEntities, array<string|int, mixed> &$fieldOptions) : mixed

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
$apiEntities : array<string|int, mixed>

List of entities whose options should be automatically scanned using API metadata.

$fieldOptions : array<string|int, mixed>

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

Tags
void

buildAdvancedSearchPaneForm()

public buildAdvancedSearchPaneForm(CRM_Core_Form &$form, mixed $type) : null
Parameters
$form : CRM_Core_Form
$type : mixed
Return values
null

defaultReturnProperties()

public static defaultReturnProperties(mixed $mode) : array<string|int, mixed>|null
Parameters
$mode : mixed
Return values
array<string|int, mixed>|null

from()

public abstract static from(string $fieldName, mixed $mode, mixed $side) : mixed
Parameters
$fieldName : string
$mode : mixed
$side : mixed

getFields()

public abstract & getFields() : mixed

registerAdvancedSearchPane()

public registerAdvancedSearchPane(mixed &$panes) : mixed
Parameters
$panes : mixed

select()

public static select(mixed &$query) : mixed
Parameters
$query : mixed

setAdvancedSearchPaneTemplatePath()

public setAdvancedSearchPaneTemplatePath(mixed &$paneTemplatePathArray, mixed $type) : null
Parameters
$paneTemplatePathArray : mixed
$type : mixed
Return values
null

setTableDependency()

public setTableDependency(mixed &$tables) : mixed
Parameters
$tables : mixed

where()

public static where(mixed &$query) : mixed
Parameters
$query : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results