CRM_Contribute_Form_Contribution_Confirm

Constructor for the basic form page.

We should not use QuickForm directly. This class provides a lot of default convenient functions, rules and buttons

Add one or more css classes to the form.

Register all the standard rules that most forms potentially use.

Simple easy to use wrapper around addElement.

Deal with simple validation rules.

Set variables up before form is built.

Process the form.

Main process wrapper.

Implemented so that we can call all the hook functions.

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

Build the form object.

Set default values for the form.

Note that in edit/view mode the default values are retrieved from the database

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

Performs the server side validation.

Core function that builds the form.

We redefine this function here and expect all CRM forms to build their form in the function buildQuickForm.

Add default Next / Back buttons.

Getter function for Name.

Getter function for State.

Getter function for StateType.

Getter function for title.

Should be over-ridden by derived class.

Setter function for title.

Assign billing type id to bltID.

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.

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.

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.

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.

Setter function for options.

Render form and return contents.

Getter function for renderer.

If renderer is not set create one and initialize it.

Use the form name to create the tpl file name.

A wrapper for getTemplateFileName.

This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.

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?

Error reporting mechanism.

Store the variable with the value in the form scope.

Get the variable from the form scope.

Overwrite action.

Since we are only showing elements in frozen mode no help display needed.

Setter for action.

Assign value to name in template.

Assign value to name in template by reference.

Appends values to template variables.

Returns an array containing template variables.

Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit

Classes extending CRM_Core_Form should implement this method.

Classes extending CRM_Core_Form should implement this method.

TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation.

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

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

Function that can be defined in Form to override or.

perform specific action on cancel action

Helper function to verify that required fields have been filled.

Typically called within the scope of a FormRule function

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?)

Get the contact id that the form is being submitted for.

Get the contact id of the logged in user.

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}

Add the options appropriate to cid = zero - ie. autocomplete

Set default values on form for given contact (or no contact defaults)

Sets form attribute.

Sets form attribute.

Sets page title based on entity and action.

Create a chain-select target field. All settings are optional; the defaults usually work.

Add actions menu to results form.

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.

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.

Build Membership Block in Contribution Pages.

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.

Set the parameters to be passed to contribution create function.

Get non-deductible amount.

This is a bit too much about wierd form interpretation to be this deep.

CRM-11885 if non_deductible_amount exists i.e. Additional Details fieldset was opened [and staff typed something] -> keep it.

Wrangle financial type ID.

This wrangling of the financialType ID was happening in a shared function rather than in the form it relates to & hence has been moved to that form Pledges are not relevant to the membership code so that portion will not go onto the membership form.

Comments from previous refactor indicate doubt as to what was going on.

Process the form.

Process the contribution.

Create the recurring contribution record.

Add on behalf of organization and it's location.

This situation occurs when on behalf of is enabled for the contribution page and the person signing up does so on behalf of an organization.

Function used to send notification mail to pcp owner.

This is used by contribution and also event PCPs.

Function used to se pcp related defaults / params.

This is used by contribution and also event PCPs

Process membership.

Process the Memberships.

Turn array of errors into message string.

Where a second separate financial transaction is supported we will process it here.

Is the payment a pending payment.

We are moving towards always creating as pending and updating at the end (based on payment), so this should be an interim refactoring. It was shared with another unrelated form & some parameters may not apply to this form.

Are we going to do 2 financial transactions.

Ie the membership block supports a separate transactions AND the contribution form has been configured for a contribution transaction AND a membership transaction AND the payment processor supports double financial transactions (ie. NOT doTransferPayment style)

This function sets the fields.

• $this->_params['amount_level']
• $this->_params['selectMembership'] And under certain circumstances sets $this->_params['amount'] = null;

Submit function.

Helper function for static submit function.

Set relevant params - help us to build up an array that we can pass in.

Post form submission handling.

This is also called from the test suite.

Membership processing section.

This is in a separate function as part of a move towards refactoring.

Complete transaction if payment has been processed.

Check the result for a success outcome & if paid then complete the transaction.

Completing will trigger update of related entities and emails.