CRM_Activity_BAO_Query
in package
Tags
Table of Contents
Methods
- buildSearchForm() : mixed
- Add all the elements shared between case activity search and advanced search.
- defaultReturnProperties() : array<string|int, mixed>|null
- from() : null|string
- getSearchFieldMetadata() : mixed
- Get the metadata for fields to be included on the activity search form.
- select() : mixed
- Build select for Case.
- selectorReturnProperties() : mixed
- Get the list of fields required to populate the selector.
- where() : mixed
- Given a list of conditions in query generate the required where clause.
- whereClauseSingle() : mixed
- Where clause for a single field.
- whereClauseSingleActivityText() : mixed
- Where/qill clause for notes
Methods
buildSearchForm()
Add all the elements shared between case activity search and advanced search.
public
static buildSearchForm(CRM_Core_Form_Search &$form) : mixed
Parameters
- $form : CRM_Core_Form_Search
Tags
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>|nullfrom()
public
static from(string $name, int $mode, string $side[, int $onlyDeleted = 0 ]) : null|string
Parameters
- $name : string
- $mode : int
- $side : string
- $onlyDeleted : int = 0
Return values
null|stringgetSearchFieldMetadata()
Get the metadata for fields to be included on the activity search form.
public
static getSearchFieldMetadata() : mixed
Tags
select()
Build select for Case.
public
static select(CRM_Contact_BAO_Query &$query) : mixed
Parameters
- $query : CRM_Contact_BAO_Query
selectorReturnProperties()
Get the list of fields required to populate the selector.
public
static selectorReturnProperties() : mixed
The default return properties array returns far too many fields for 'everyday use. Every field you add to this array kills a small kitten so add carefully.
where()
Given a list of conditions in query generate the required where clause.
public
static where(CRM_Contact_BAO_Query &$query) : mixed
Parameters
- $query : CRM_Contact_BAO_Query
Tags
whereClauseSingle()
Where clause for a single field.
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
Tags
whereClauseSingleActivityText()
Where/qill clause for notes
public
static whereClauseSingleActivityText(array<string|int, mixed> &$values, CRM_Contact_BAO_Query &$query) : mixed
Parameters
- $values : array<string|int, mixed>
- $query : CRM_Contact_BAO_Query