CRM_Contribute_Form_ContributeFormTrait
Trait implements functions to retrieve contribution related values.
Table of Contents
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.
Methods
getContributionID()
Get the selected Contribution ID.
public
getContributionID() : int|null
APIYes
Tags
Return values
int|nullgetContributionPageID()
Get id of contribution page being acted on.
public
getContributionPageID() : int|null
APIYes
Tags
Return values
int|nullgetContributionPageValue()
Get a value from the contribution being acted on.
public
getContributionPageValue(string $fieldName) : mixed
APIYes
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
APIYes
Tags
Return values
int|nullgetContributionRecurValue()
Get the value for a field relating to the contribution recur record.
public
getContributionRecurValue(string $fieldName) : mixed
APIYes
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
APIYes
All values returned in apiv4 format. Escaping may be required.
Parameters
- $fieldName : string