CRM_Contribute_Form_ContributeFormTrait uses trait:short
Trait implements functions to retrieve contribution related values.
Table of Contents
Properties
- $entityLookupDefinitions : array<string|int, mixed>
- Array of defined entity identifiers.
- $entityLookupValues : array<string|int, mixed>
- Array of defined entity values.
Methods
- getContributionID() : int|null
- Get the selected Contribution ID.
- getContributionPageID() : int|null
- Get id of contribution page being acted on.
- getContributionPageValue() : mixed
- Get a value from the contribution being acted on.
- getContributionRecurID() : int|null
- Get the selected Contribution Recur ID.
- getContributionRecurValue() : mixed
- Get the value for a field relating to the contribution recur record.
- getContributionValue() : mixed
- Get the value for a field relating to the contribution.
- isDefined() : bool
- Check if an entity can be looked up
- lookup() : mixed
- Retrieve a field value for a defined entity
- define() : void
- Defines a record so its values can be retrieved using `$this->lookup()`
- getDefinition() : array{entityName: string, identifier: array}|null
- Retrieve entity definition (entityName string, identifier [keys/values])
Properties
$entityLookupDefinitions
Array of defined entity identifiers.
private
array<string|int, mixed>
$entityLookupDefinitions
= []
$entityLookupValues
Array of defined entity values.
private
array<string|int, mixed>
$entityLookupValues
= []
Methods
getContributionID()
Get the selected Contribution ID.
public
getContributionID() : int|null
Tags
Return values
int|nullgetContributionPageID()
Get id of contribution page being acted on.
public
getContributionPageID() : int|null
Tags
Return values
int|nullgetContributionPageValue()
Get a value from the contribution being acted on.
public
getContributionPageValue(string $fieldName) : mixed
All values returned in apiv4 format. Escaping may be required.
Parameters
- $fieldName : string
Tags
getContributionRecurID()
Get the selected Contribution Recur ID.
public
getContributionRecurID() : int|null
Tags
Return values
int|nullgetContributionRecurValue()
Get the value for a field relating to the contribution recur record.
public
getContributionRecurValue(string $fieldName) : mixed
All values returned in apiv4 format. Escaping may be required.
Parameters
- $fieldName : string
Tags
getContributionValue()
Get the value for a field relating to the contribution.
public
getContributionValue(string $fieldName) : mixed
All values returned in apiv4 format. Escaping may be required.
Parameters
- $fieldName : string
Tags
isDefined()
Check if an entity can be looked up
public
isDefined(string $nickname) : bool
Parameters
- $nickname : string
Return values
boollookup()
Retrieve a field value for a defined entity
public
lookup(string $nickname, string $fieldName) : mixed
Parameters
- $nickname : string
-
Handle set by
$this->define() - $fieldName : string
Tags
define()
Defines a record so its values can be retrieved using `$this->lookup()`
protected
define(string $apiEntityName, string $nickname, array<string|int, mixed> $identifier) : void
Parameters
- $apiEntityName : string
- $nickname : string
-
Handle to use to retrieve values with
$this->lookup() - $identifier : array<string|int, mixed>
-
A unique key or combination of keys to uniquely identify the record (usually id) Most commonly looks like
['id' => 123]
getDefinition()
Retrieve entity definition (entityName string, identifier [keys/values])
protected
getDefinition(string $nickname) : array{entityName: string, identifier: array}|null
Parameters
- $nickname : string