CRM_Member_BAO_Query
extends CRM_Core_BAO_Query
in package
Tags
Table of Contents
Methods
- addCustomFormFields() : mixed
- buildSearchForm() : mixed
- Build the search form.
- defaultReturnProperties() : array<string|int, mixed>|null
- Get default return properties.
- from() : string
- Generate from clause.
- getFields() : array<string|int, mixed>
- Get available fields.
- getSearchFieldMetadata() : mixed
- Get the metadata for fields to be included on the grant search form.
- qill() : string
- Getter for the qill object.
- searchAction() : mixed
- Possibly unnecessary function.
- select() : mixed
- If membership are involved, add the specific membership fields.
- tableNames() : mixed
- Add membership table.
- where() : mixed
- Generate where clause.
- whereClauseSingle() : mixed
- Generate where for a single parameter.
- getFieldName() : string
- Get the name of the field.
- getLegacySupportedFields() : array<string|int, mixed>
- Get legacy fields which we still maybe support.
Methods
addCustomFormFields()
public
static addCustomFormFields(CRM_Core_Form &$form, array<string|int, mixed> $extends) : mixed
Parameters
- $form : CRM_Core_Form
- $extends : array<string|int, mixed>
buildSearchForm()
Build the search form.
public
static buildSearchForm(CRM_Core_Form &$form) : mixed
Parameters
- $form : CRM_Core_Form
Tags
defaultReturnProperties()
Get default return properties.
public
static defaultReturnProperties(string $mode[, bool $includeCustomFields = TRUE ]) : array<string|int, mixed>|null
Parameters
- $mode : string
- $includeCustomFields : bool = TRUE
Return values
array<string|int, mixed>|nullfrom()
Generate from clause.
public
static from(string $name, int $mode, string $side) : string
Parameters
- $name : string
- $mode : int
- $side : string
Return values
stringgetFields()
Get available fields.
public
static & getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getSearchFieldMetadata()
Get the metadata for fields to be included on the grant search form.
public
static getSearchFieldMetadata() : mixed
Tags
qill()
Getter for the qill object.
public
qill() : string
Return values
stringsearchAction()
Possibly unnecessary function.
public
static searchAction(mixed &$row, int $id) : mixed
Parameters
- $row : mixed
- $id : int
select()
If membership are involved, add the specific membership fields.
public
static select(CRM_Contact_BAO_Query &$query) : mixed
Parameters
- $query : CRM_Contact_BAO_Query
tableNames()
Add membership table.
public
static tableNames(array<string|int, mixed> &$tables) : mixed
Parameters
- $tables : array<string|int, mixed>
where()
Generate where clause.
public
static where(CRM_Contact_BAO_Query &$query) : mixed
Parameters
- $query : CRM_Contact_BAO_Query
whereClauseSingle()
Generate where for a single parameter.
public
static whereClauseSingle(array<string|int, mixed> &$values, CRM_Contact_BAO_Query &$query) : mixed
Parameters
- $values : array<string|int, mixed>
- $query : CRM_Contact_BAO_Query
getFieldName()
Get the name of the field.
protected
static getFieldName(array<string|int, mixed> $values) : string
Parameters
- $values : array<string|int, mixed>
Return values
stringgetLegacySupportedFields()
Get legacy fields which we still maybe support.
protected
static getLegacySupportedFields() : array<string|int, mixed>
These are contribution specific but I think it's ok to have one list of legacy supported params in a central place.