Documentation

CRM_Grant_BAO_Query extends CRM_Contact_BAO_Query_Interface
in package

Class CRM_Grant_BAO_Query

Table of Contents

Methods

alterSearchBuilderOptions()  : mixed
Describe options for available for use in the search-builder.
buildAdvancedSearchPaneForm()  : void
Add all the elements shared between grant search and advanaced search.
defaultReturnProperties()  : array<string|int, mixed>|null
from()  : null|string
getContactFields()  : array<string|int, mixed>
Get the fields that are available in the 'contact context'.
getFields()  : array<string|int, mixed>
Get available fields.
getPanesMapper()  : mixed
getSearchFieldMetadata()  : mixed
Get the metadata for fields to be included on the grant search form.
getTemplateHandlableSearchFields()  : mixed
Transitional function for specifying which fields the tpl can iterate through.
registerAdvancedSearchPane()  : mixed
select()  : mixed
Build select for CiviGrant.
setAdvancedSearchPaneTemplatePath()  : null
setTableDependency()  : mixed
where()  : mixed
Given a list of conditions in params generate the required.
whereClauseSingle()  : 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
Parameters
$apiEntities : array<string|int, mixed>
$fieldOptions : array<string|int, mixed>

buildAdvancedSearchPaneForm()

Add all the elements shared between grant search and advanaced search.

public buildAdvancedSearchPaneForm(CRM_Grant_Form_Search &$form, mixed $type) : void
Parameters
$form : CRM_Grant_Form_Search
$type : mixed

defaultReturnProperties()

public static defaultReturnProperties(mixed $mode[, bool $includeCustomFields = TRUE ]) : array<string|int, mixed>|null
Parameters
$mode : mixed
$includeCustomFields : bool = TRUE
Return values
array<string|int, mixed>|null

from()

public static from(string $name, int $mode, string $side) : null|string
Parameters
$name : string
$mode : int
$side : string
Return values
null|string

getContactFields()

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>

getFields()

Get available fields.

public & getFields() : array<string|int, mixed>

Important for exports & relative date filters.

Return values
array<string|int, mixed>

getPanesMapper()

public getPanesMapper(array<string|int, string> &$panes) : mixed
Parameters
$panes : array<string|int, string>

getSearchFieldMetadata()

Get the metadata for fields to be included on the grant search form.

public static getSearchFieldMetadata() : mixed
Tags
throws
CRM_Core_Exception

getTemplateHandlableSearchFields()

Transitional function for specifying which fields the tpl can iterate through.

public static getTemplateHandlableSearchFields() : mixed

registerAdvancedSearchPane()

public registerAdvancedSearchPane(array<string|int, string> &$panes) : mixed
Parameters
$panes : array<string|int, string>

select()

Build select for CiviGrant.

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

Given a list of conditions in params generate the required.

public static where(mixed &$query) : mixed

where clause

Parameters
$query : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results