CRM_Pledge_Form_PledgeFormTrait uses trait:short
Trait implements getContactValue + overridable getContactID functions.
These are commonly used on forms - although getContactID() would often
be overridden. By using these functions it is not necessary to know
if the Contact ID has already been defined as getContactID() will retrieve
them form the values available (unless it is yet to be created).
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
- getPledgeID() : int|null
- Get id of Pledge being acted on.
- getPledgeValue() : mixed
- Get a value from the Pledge being acted on.
- 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
getPledgeID()
Get id of Pledge being acted on.
public
getPledgeID() : int|null
Return values
int|nullgetPledgeValue()
Get a value from the Pledge being acted on.
public
getPledgeValue(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