CRM_Contribute_Form_Task_TaskTrait
This class provides shared contribution task functionality.
Table of Contents
Properties
- $ids : array<string|int, mixed>
- Selected IDs for the action.
Methods
- getComponentClause() : string
- Get the clause to add to queries to hone the results.
- getIDs() : array<string|int, mixed>|bool
- Get ids selected for the task.
- getSearchQueryResults() : CRM_Core_DAO
- Get the results from the BAO_Query object based search.
- isQueryIncludesSoftCredits() : bool
- Has soft credit information been requested in the query filters.
- isSingle() : bool
- Is only one entity being processed?
- calculateIDS() : array<string|int, mixed>|bool|array<string|int, string>
- getQueryParams() : array<string|int, mixed>|null
- Get the query parameters, adding test = FALSE if needed.
Properties
$ids
Selected IDs for the action.
protected
array<string|int, mixed>
$ids
Methods
getComponentClause()
Get the clause to add to queries to hone the results.
public
getComponentClause() : string
In practice this generally means the query to limit by selected ids.
Tags
Return values
stringgetIDs()
Get ids selected for the task.
public
getIDs() : array<string|int, mixed>|bool
Tags
Return values
array<string|int, mixed>|boolgetSearchQueryResults()
Get the results from the BAO_Query object based search.
public
getSearchQueryResults() : CRM_Core_DAO
Tags
Return values
CRM_Core_DAOisQueryIncludesSoftCredits()
Has soft credit information been requested in the query filters.
public
isQueryIncludesSoftCredits() : bool
Return values
boolisSingle()
Is only one entity being processed?
public
isSingle() : bool
Return values
boolcalculateIDS()
protected
calculateIDS() : array<string|int, mixed>|bool|array<string|int, string>
Tags
Return values
array<string|int, mixed>|bool|array<string|int, string>getQueryParams()
Get the query parameters, adding test = FALSE if needed.
protected
getQueryParams() : array<string|int, mixed>|null