CRM_Contribute_Form_Contribution_Main
class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_ContributionBase
This class generates form components for processing a Contribution.
Constants
ATTR_SPACING |
Constants for attributes for various form elements attempt to standardize on the number of variations that we use of the below form elements |
CB_PREFIX |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIY |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIZ |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIX_LEN |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
Properties
protected object | $_state | The state object that this form belongs to | from CRM_Core_Form |
protected string | $_name | The name of this form | from CRM_Core_Form |
protected string | $_title | The title of this form | from CRM_Core_Form |
array | $_defaults | The default values for the form. | from CRM_Core_Form |
mixed | $_options | (QUASI-PROTECTED) The options passed into this form | from CRM_Core_Form |
$_action | from CRM_Contribute_Form_ContributionBase | ||
$_paymentProcessors | |||
array | $_paymentProcessorIDs | Available payment processors (IDS). | from CRM_Core_Form |
protected | $_paymentProcessorID | ||
protected int | $_is_pay_later_enabled | Is pay later enabled for the form. | from CRM_Core_Form |
protected object | $_renderer | The renderer used for this form | from CRM_Core_Form |
protected array | $_dateFields | An array to hold a list of datefields on the form so that they can be converted to ISO in a consistent manner | from CRM_Core_Form |
static protected CRM_Core_Smarty | $_template | Cache the smarty template for efficiency reasons | from CRM_Core_Form |
protected | $unsavedChangesWarn | Indicate if this form should warn users of unsaved changes | from CRM_Core_Form |
array | $ajaxResponse | What to return to the client if in ajax mode (snippet=json) | from CRM_Core_Form |
array | $urlPath | Url path used to reach this page | from CRM_Core_Form |
CRM_Core_Controller | $controller | from CRM_Core_Form | |
static array | $html5Types | Extra input types we support via the "add" method | from CRM_Core_Form |
int | $_id | The id of the contribution page that we are processing. | from CRM_Contribute_Form_ContributionBase |
string | $_mode | The mode that we are in | from CRM_Contribute_Form_ContributionBase |
int | $_membershipContactID | The contact id related to a membership | from CRM_Contribute_Form_ContributionBase |
array | $_values | The values for the contribution db object | from CRM_Contribute_Form_ContributionBase |
array | $_paymentProcessor | The paymentProcessor attributes for this page | from CRM_Contribute_Form_ContributionBase |
$_paymentObject | from CRM_Contribute_Form_ContributionBase | ||
array | $_membershipBlock | The membership block for this page | from CRM_Contribute_Form_ContributionBase |
protected bool | $_separateMembershipPayment | Does this form support a separate membership payment | from CRM_Contribute_Form_ContributionBase |
array | $_params | The params submitted by the form and computed by the app | from CRM_Contribute_Form_ContributionBase |
array | $_fields | The fields involved in this contribution page | from CRM_Contribute_Form_ContributionBase |
int | $_bltID | The billing location id for this contribution page. | from CRM_Contribute_Form_ContributionBase |
float | $_amount | Cache the amount to make things easier | from CRM_Contribute_Form_ContributionBase |
integer | $_pcpId | Pcp id | from CRM_Contribute_Form_ContributionBase |
array | $_pcpBlock | Pcp block | from CRM_Contribute_Form_ContributionBase |
array | $_pcpInfo | Pcp info | from CRM_Contribute_Form_ContributionBase |
int | $_contactID | The contact id of the person for whom membership is being added or renewed based on the cid in the url, checksum, or session | from CRM_Contribute_Form_ContributionBase |
protected | $_userID | from CRM_Contribute_Form_ContributionBase | |
int | $_membershipId | The Membership ID for membership renewal | from CRM_Contribute_Form_ContributionBase |
int | $_priceSetId | Price Set ID, if the new price set method is used | from CRM_Contribute_Form_ContributionBase |
array | $_priceSet | Array of fields for the price set | from CRM_Contribute_Form_ContributionBase |
string | $_contributeMode | Contribution mode e.g express for payment express, notify for off-site + notification back to CiviCRM | from CRM_Contribute_Form_ContributionBase |
$_useForMember | |||
$_isBillingAddressRequiredForPayLater | from CRM_Contribute_Form_ContributionBase | ||
bool | $_emailExists | Flag if email field exists in embedded profile | from CRM_Contribute_Form_ContributionBase |
bool | $isBackOffice | Is this a backoffice form (this will affect whether paypal express code is displayed) | from CRM_Contribute_Form_ContributionBase |
int | $paymentInstrumentID | Payment instrument if for the transaction. | from CRM_Contribute_Form_ContributionBase |
$_defaultMemTypeId | Define default MembershipType Id. | ||
$_membershipTypeValues | |||
array | $_paymentFields | Array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl | |
protected | $_snippet |
Methods
Constructor for the basic form page.
Simple easy to use wrapper around addElement.
Set variables up before form is built.
Process the form submission.
Build the form object.
Set the default values.
This is a virtual function that adds group and global rules to the form.
This if a front end form function for setting the payment processor.
Format the fields for the payment processor.
Handle Payment Processor switching for contribution and event registration forms.
Use the form name to create the tpl file name.
Add the extra.tpl in.
Store the variable with the value in the form scope.
Assign value to name in template by reference.
Appends values to template variables.
Returns an array containing template variables.
No description
No description
No description
Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit
No description
Classes extending CRM_Core_Form should implement this method.
Adds a select based on field metadata.
Adds a field based on metadata.
Add a widget for selecting/editing/creating/copying a profile form
Add date.
Function that will add date and time.
Add a currency and money element to the form.
Add currency element to the form.
Create a single or multiple entity ref field.
Convert all date fields within the params to mysql date ready for the BAO layer. In this case fields are checked against the $_datefields defined for the form and if time is defined it is incorporated
Helper function to verify that required fields have been filled.
Get contact if for a form object. Prioritise - cid in URL if 0 (on behalf on someoneelse) (@todo consider setting a variable if onbehalf for clarity of downstream 'if's - logged in user id if it matches the one in the cid in the URL - contact id validated from a checksum from a checksum - cid from the url if the caller has ACL permission to view - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)
Add autoselector field -if user has permission to view contacts If adding this to a form you also need to add to the tpl e.g
Add the options appropriate to cid = zero - ie. autocomplete
Set default values on form for given contact (or no contact defaults)
Create a chain-select target field. All settings are optional; the defaults usually work.
Assign billing name to the template.
Assign the minimal set of variables to the template.
Add the custom fields.
Add onbehalf/honoree profile fields and native module fields.
Check template file exists.
Authenticate pledge user during online payment.
Build Membership Block in Contribution Pages.
Determine if recurring parameters need to be added to the form parameters.
Compute amount to be paid.
Submit function.
Assign the billing mode to the template.
Process confirm function and pass browser to the thank you page.
Function for unit tests on the postProcess function.
Details
in CRM_Core_Form at line 239
CRM_Core_Form
__construct(object $state = NULL, const|enum|int $action = CRM_Core_Action::NONE, string $method = 'post', string $name = NULL)
Constructor for the basic form page.
We should not use QuickForm directly. This class provides a lot of default convenient functions, rules and buttons
in CRM_Core_Form at line 279
addClass(string $className)
Add one or more css classes to the form.
in CRM_Core_Form at line 287
registerRules()
Register all the standard rules that most forms potentially use.
in CRM_Core_Form at line 340
HTML_QuickForm_Element
add(string $type, string $name, string $label = '', string|array $attributes = '', bool $required = FALSE, array $extra = NULL)
Simple easy to use wrapper around addElement.
Deal with simple validation rules.
at line 62
preProcess()
Set variables up before form is built.
at line 1039
postProcess()
Process the form submission.
in CRM_Core_Form at line 446
mainProcess(bool $allowAjax = TRUE)
Main process wrapper.
Implemented so that we can call all the hook functions.
in CRM_Core_Form at line 473
postProcessHook()
The postProcess hook is typically called by the framework.
However in a few cases, the form exits or redirects early in which case it needs to call this function so other modules can do the needful Calling this function directly should be avoided if possible. In general a better way is to do setUserContext so the framework does the redirect
at line 318
buildQuickForm()
Build the form object.
at line 127
array|NULL
setDefaultValues()
Set the default values.
in CRM_Core_Form at line 502
addRules()
This is a virtual function that adds group and global rules to the form.
Keeping it distinct from the form to keep code small and localized in the form building code
in CRM_Core_Form at line 512
bool
validate()
Performs the server side validation.
in CRM_Core_Form at line 540
buildForm()
Core function that builds the form.
We redefine this function here and expect all CRM forms to build their form in the function buildQuickForm.
in CRM_Core_Form at line 599
addButtons(array $params)
Add default Next / Back buttons.
in CRM_Core_Form at line 668
string
getName()
Getter function for Name.
in CRM_Core_Form at line 677
object
getState()
Getter function for State.
in CRM_Core_Form at line 686
int
getStateType()
Getter function for StateType.
in CRM_Core_Form at line 697
string
getTitle()
Getter function for title.
Should be over-ridden by derived class.
in CRM_Core_Form at line 707
setTitle(string $title)
Setter function for title.
in CRM_Core_Form at line 716
assignBillingType()
Assign billing type id to bltID.
in CRM_Core_Form at line 731
protected
assignPaymentProcessor(bool $is_pay_later_enabled)
This if a front end form function for setting the payment processor.
It would be good to sync it with the back-end function on abstractEditPayment & use one everywhere.
in CRM_Core_Form at line 769
protected array
formatParamsForPaymentProcessor(array $fields)
Format the fields for the payment processor.
In order to pass fields to the payment processor in a consistent way we add some renamed parameters.
in CRM_Core_Form at line 807
protected
preProcessPaymentOptions()
Handle Payment Processor switching for contribution and event registration forms.
This function is shared between contribution & event forms & this is their common class.
However, this should be seen as an in-progress refactor, the end goal being to also align the backoffice forms that action payments.
This function overlaps assignPaymentProcessor, in a bad way.
in CRM_Core_Form at line 860
protected
handlePreApproval(array $params)
Handle pre approval for processors.
This fits with the flow where a pre-approval is done and then confirmed in the next stage when confirm is hit.
This function is shared between contribution & event forms & this is their common class.
However, this should be seen as an in-progress refactor, the end goal being to also align the backoffice forms that action payments.
in CRM_Core_Form at line 885
setOptions(mixed $options)
Setter function for options.
in CRM_Core_Form at line 894
string
toSmarty()
Render form and return contents.
in CRM_Core_Form at line 912
object
getRenderer()
Getter function for renderer.
If renderer is not set create one and initialize it.
in CRM_Contribute_Form_ContributionBase at line 973
string
getTemplateFileName()
Use the form name to create the tpl file name.
in CRM_Core_Form at line 947
getHookedTemplateFileName()
A wrapper for getTemplateFileName.
This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.
in CRM_Contribute_Form_ContributionBase at line 986
string
overrideExtraTemplateFileName()
Add the extra.tpl in.
Default extra tpl file basically just replaces .tpl with .extra.tpl i.e. we do not override - why isn't this done at the CRM_Core_Form level?
in CRM_Core_Form at line 974
error(string $message, int $code = NULL, CRM_Core_DAO $dao = NULL)
Error reporting mechanism.
in CRM_Core_Form at line 992
set(string $name, mixed $value)
Store the variable with the value in the form scope.
in CRM_Core_Form at line 1004
mixed
get(string $name)
Get the variable from the form scope.
in CRM_Core_Form at line 1013
int
getAction()
Getter for action.
in CRM_Core_Form at line 1023
setAction(int $action)
Setter for action.
in CRM_Core_Form at line 1035
assign(string $var, mixed $value = NULL)
Assign value to name in template.
in CRM_Core_Form at line 1047
assign_by_ref(string $var, mixed $value)
Assign value to name in template by reference.
in CRM_Core_Form at line 1059
append(array|string $tpl_var, mixed $value = NULL, bool $merge = FALSE)
Appends values to template variables.
in CRM_Core_Form at line 1070
array
get_template_vars(string $name = NULL)
Returns an array containing template variables.
in CRM_Core_Form at line 1084
HTML_QuickForm_group
addRadio(string $name, $title, $values, array $attributes = array(), null $separator = NULL, bool $required = FALSE)
in CRM_Core_Form at line 1110
addYesNo(int $id, $title, bool $allowClear = FALSE, null $required = NULL, array $attributes = array())
in CRM_Core_Form at line 1136
addCheckBox(int $id, $title, $values, null $other = NULL, null $attributes = NULL, null $required = NULL, null $javascriptMethod = NULL, string $separator = '<br />', bool $flipValues = FALSE)
in CRM_Core_Form at line 1179
resetValues()
in CRM_Core_Form at line 1195
addDefaultButtons(string $title, string $nextType = 'next', string $backType = 'back', bool|string $submitOnce = FALSE)
Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit
in CRM_Core_Form at line 1226
addDateRange(string $name, string $from = '_from', string $to = '_to', string $label = 'From:', string $dateFormat = 'searchDate', bool $required = FALSE, bool $displayTime = FALSE)
in CRM_Core_Form at line 1259
getDefaultEntity()
Classes extending CRM_Core_Form should implement this method.
in CRM_Core_Form at line 1269
getDefaultContext()
Classes extending CRM_Core_Form should implement this method.
TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation.
in CRM_Core_Form at line 1291
HTML_QuickForm_Element
addSelect($name, array $props = array(), bool $required = FALSE)
Adds a select based on field metadata.
TODO: This could be even more generic and widget type (select in this case) could also be read from metadata Perhaps a method like $form->bind($name) which would look up all metadata for named field
in CRM_Core_Form at line 1372
HTML_QuickForm_Element
addField($name, array $props = array(), bool $required = FALSE, bool $legacyDate = TRUE)
Adds a field based on metadata.
in CRM_Core_Form at line 1553
addProfileSelector(string $name, string $label, string $allowCoreTypes, string $allowSubTypes, array $entities, bool $default = FALSE, string $usedFor = NULL)
Add a widget for selecting/editing/creating/copying a profile form
in CRM_Core_Form at line 1572
null
getRootTitle()
in CRM_Core_Form at line 1579
string
getCompleteTitle()
in CRM_Core_Form at line 1586
static CRM_Core_Smarty
getTemplate()
in CRM_Core_Form at line 1593
addUploadElement($elementName)
in CRM_Core_Form at line 1623
null
getVar($name)
in CRM_Core_Form at line 1631
setVar($name, $value)
in CRM_Core_Form at line 1650
addDate(string $name, string $label, bool $required = FALSE, array $attributes = NULL)
deprecated
deprecated
Add date.
in CRM_Core_Form at line 1739
addDateTime(string $name, string $label, bool $required = FALSE, null $attributes = NULL)
deprecated
deprecated
Function that will add date and time.
in CRM_Core_Form at line 1765
HTML_QuickForm_Element
addMoney(string $name, string $label, bool $required = FALSE, null $attributes = NULL, bool $addCurrency = TRUE, string $currencyName = 'currency', null $defaultCurrency = NULL, bool $freezeCurrency = FALSE)
Add a currency and money element to the form.
in CRM_Core_Form at line 1795
addCurrency(string $name = 'currency', null $label = NULL, bool $required = TRUE, string $defaultCurrency = NULL, bool $freezeCurrency = FALSE, bool $setDefaultCurrency = TRUE)
Add currency element to the form.
in CRM_Core_Form at line 1845
HTML_QuickForm_Element
addEntityRef(string $name, string $label = '', array $props = array(), bool $required = FALSE)
Create a single or multiple entity ref field.
in CRM_Core_Form at line 1894
convertDateFieldsToMySQL(array $params)
Convert all date fields within the params to mysql date ready for the BAO layer. In this case fields are checked against the $_datefields defined for the form and if time is defined it is incorporated
in CRM_Core_Form at line 1914
removeFileRequiredRules($elementName)
in CRM_Core_Form at line 1932
cancelAction()
Function that can be defined in Form to override or.
perform specific action on cancel action
in CRM_Core_Form at line 1944
static
validateMandatoryFields(array $fields, array $values, array $errors)
Helper function to verify that required fields have been filled.
Typically called within the scope of a FormRule function
in CRM_Core_Form at line 1963
protected NULL|int
setContactID()
Get contact if for a form object. Prioritise - cid in URL if 0 (on behalf on someoneelse) (@todo consider setting a variable if onbehalf for clarity of downstream 'if's - logged in user id if it matches the one in the cid in the URL - contact id validated from a checksum from a checksum - cid from the url if the caller has ACL permission to view - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)
in CRM_Core_Form at line 2018
int|NULL
getContactID()
Get the contact id that the form is being submitted for.
in CRM_Core_Form at line 2025
getLoggedInUserContactID()
Get the contact id of the logged in user.
in CRM_Core_Form at line 2054
addAutoSelector(array $profiles = array(), array $autoCompleteField = array())
Add autoselector field -if user has permission to view contacts If adding this to a form you also need to add to the tpl e.g
{if !empty($selectable)}
{/if}
in CRM_Core_Form at line 2079
canUseAjaxContactLookups()
in CRM_Core_Form at line 2097
addCIDZeroOptions($onlinePaymentProcessorEnabled)
Add the options appropriate to cid = zero - ie. autocomplete
in CRM_Core_Form at line 2123
array
getProfileDefaults(mixed $profile_id = 'Billing', int $contactID = NULL)
Set default values on form for given contact (or no contact defaults)
in CRM_Core_Form at line 2142
preventAjaxSubmit()
Sets form attribute.
in CRM_Core_Form at line 2150
allowAjaxSubmit()
Sets form attribute.
in CRM_Core_Form at line 2158
setPageTitle(string $entityLabel)
Sets page title based on entity and action.
in CRM_Core_Form at line 2187
HTML_QuickForm_Element
addChainSelect(string $elementName, array $settings = array())
Create a chain-select target field. All settings are optional; the defaults usually work.
in CRM_Core_Form at line 2222
addTaskMenu(array $tasks)
Add actions menu to results form.
in CRM_Core_Form at line 2337
string
assignBillingName(array $params = array())
Assign billing name to the template.
in CRM_Contribute_Form_ContributionBase at line 504
assignToTemplate()
Assign the minimal set of variables to the template.
in CRM_Contribute_Form_ContributionBase at line 620
buildCustom(int $id, string $name, bool $viewOnly = FALSE, null $profileContactType = NULL, array $fieldTypes = NULL)
Add the custom fields.
in CRM_Contribute_Form_ContributionBase at line 772
buildComponentForm(int $id, CRM_Core_Form $form)
Add onbehalf/honoree profile fields and native module fields.
in CRM_Contribute_Form_ContributionBase at line 957
null|string
checkTemplateFileExists(string $suffix = NULL)
Check template file exists.
in CRM_Contribute_Form_ContributionBase at line 994
authenticatePledgeUser()
Authenticate pledge user during online payment.
in CRM_Contribute_Form_ContributionBase at line 1047
cancelRecurring()
Cancel recurring contributions.
In case user cancel recurring contribution, When we get the control back from payment gate way lets delete the recurring and related contribution.
in CRM_Contribute_Form_ContributionBase at line 1080
protected bool
buildMembershipBlock(int $cid, bool $isContributionMainPage = FALSE, int $selectedMembershipTypeID = NULL, bool $thankPage = FALSE, null $isTest = NULL)
Build Membership Block in Contribution Pages.
in CRM_Contribute_Form_ContributionBase at line 1282
protected
setRecurringMembershipParams()
Determine if recurring parameters need to be added to the form parameters.
- is_recur
- frequency_interval
- frequency_unit
For membership this is based on the membership type.
This needs to be done before processing the pre-approval redirect where relevant on the main page or before any payment processing.
Arguably the form should start to build $this->_params in the pre-process main page & use that array consistently throughout.
at line 565
static
buildRecur(CRM_Core_Form $form)
Build elements to collect information for recurring contributions.
at line 650
static bool|array
formRule(array $fields, array $files, CRM_Core_Form $self)
Global form rule.
at line 1004
static int|mixed|null|string
computeAmount(array $params, array $formValues)
Compute amount to be paid.
at line 1061
submit(array $params)
Submit function.
This is the guts of the postProcess made also accessible to the test suite.
at line 1279
protected
setContributeMode()
Assign the billing mode to the template.
This is required for legacy support for contributeMode in templates.
The goal is to remove this parameter & use more relevant parameters.
at line 1299
protected
skipToThankYouPage()
Process confirm function and pass browser to the thank you page.
at line 1326
testSubmit(array $params)
Function for unit tests on the postProcess function.