Documentation

CRM_Contribute_Form_Task extends CRM_Core_Form_Task
in package

CRM

uses CRM_Contribute_Form_Task_TaskTrait

Class for contribute form task actions.

FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.

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 = 'mark_x_': 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 = 7: 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 = 'mark_y_': 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 = 'mark_z_': 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

$_action : int: (QUASI-PROTECTED) The mode of operation for this form
$_contactIds : array<string|int, mixed>: The array that holds all the contact ids
$_defaults : array<string|int, mixed>: The default values for the form.
$_entityIds : array<string|int, mixed>: The array that holds all the case ids
$_options : mixed: (QUASI-PROTECTED) The options passed into this form
$_paymentProcessorIDs : array<string|int, mixed>: Available payment processors (IDS).
$ajaxResponse : array<string|int, mixed>: What to return to the client if in ajax mode (snippet=json)
$controller : CRM_Core_Controller
$entityShortname : string: Must be set to entity shortname (eg. event)
$expectedSmartyVariables : array<string|int, string>: Variables smarty expects to have set.
$html5Types : array<string|int, mixed>: Extra input types we support via the "add" method
$submitOnce : bool
$tableName : string: Must be set to entity table name (eg. civicrm_participant) by child class
$urlPath : array<string|int, mixed>: Url path used to reach this page
$_actionButtonName : string: Name of action button
$_componentClause : string: The additional clause that we restrict the search with
$_componentIds : array<string|int, mixed>: The array that holds all the component ids
$_contributionIds : array<string|int, mixed>: The array that holds all the contribution ids.
$_name : string: The name of this form
$_paymentProcessorID : int: Default or selected processor id.
$_paymentProcessors : array<string|int, mixed>: Available payment processors.
$_renderer : object: The renderer used for this form
$_state : object: The state object that this form belongs to
$_task : int: The task being performed
$_template : CRM_Core_Smarty: Cache the smarty template for efficiency reasons
$_title : string: The title of this form
$context : string: Context of the form being loaded.
$exportedValues : array<string|int, mixed>: Values submitted by the user.
$ids : array<string|int, mixed>: Selected IDs for the action.
$optionalQuickFormElements : array<string|int, mixed>: Quick form elements which are conditionally added to the form.
$queryMode : int
$rows : array<string|int, mixed>: Rows to act on.
$submittableMoneyFields : array<string|int, mixed>: Monetary fields that may be submitted.
$unsavedChangesWarn : bool: Indicate if this form should warn users of unsaved changes
$authenticatedContactID : int: The contact ID that has been authenticated and can be used for checking permissions.
$isValidated : true

Methods

__construct() : CRM_Core_Form: Constructor for the basic form page.
add() : HTML_QuickForm_Element: Simple easy to use wrapper around addElement.
addAutocomplete() : HTML_QuickForm_Element
addAutoSelector() : mixed: 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
addButtons() : mixed: Add default Next / Back buttons.
addChainSelect() : HTML_QuickForm_Element: Create a chain-select target field. All settings are optional; the defaults usually work.
addCheckBox() : mixed
addCIDZeroOptions() : mixed: Add the options appropriate to cid = zero - ie. autocomplete
addClass() : mixed: Add one or more css classes to the form.
addCurrency() : mixed: Add currency element to the form.
addDate() : mixed: Add date.
addDatePickerRange() : mixed: Add a search for a range using date picker fields.
addDateRange() : mixed
addDateTime() : mixed: Function that will add date and time.
addDefaultButtons() : mixed: Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit
addEntityRef() : HTML_QuickForm_Element: Create a single or multiple entity ref field.
addExpectedSmartyVariable() : void: Add an expected smarty variable to the array.
addExpectedSmartyVariables() : void: Add an expected smarty variable to the array.
addField() : mixed: Adds a field based on metadata.
addMoney() : HTML_QuickForm_Element: Add a currency and money element to the form.
addOptionalQuickFormElement() : void: Add an optional element to the optional elements array.
addProfileSelector() : mixed: Add a widget for selecting/editing/creating/copying a profile form
addRadio() : HTML_QuickForm_group
addRules() : mixed: This is a virtual function that adds group and global rules to the form.
addSelect() : HTML_QuickForm_Element: Adds a select based on field metadata.
addTaskMenu() : mixed: Add actions menu to results form.
addUploadElement() : mixed
addYesNo() : mixed
allowAjaxSubmit() : mixed: Sets form attribute.
append() : mixed: Appends values to template variables.
assign() : mixed: Assign value to name in template.
assign_by_ref() : mixed: Assign value to name in template by reference.
assignBillingName() : string: Assign billing name to the template.
assignBillingType() : mixed: Assign billing type id to bltID.
assignVariables() : mixed: Assign an array of variables to the form/tpl
buildForm() : mixed: Core function that builds the form.
buildQuickForm() : mixed: This virtual function is used to build the form.
cancelAction() : mixed: Function that can be defined in Form to override or.
canUseAjaxContactLookups() : bool
error() : mixed: Error reporting mechanism.
get() : mixed: Get the variable from the form scope.
get_template_vars() : array<string|int, mixed>: Returns an array containing template variables.
getAction() : int|null: Getter for action.
getAuthenticatedContactID() : int: Get the authenticated contact ID.
getCompleteTitle() : string
getComponentClause() : string: Get the clause to add to queries to hone the results.
getContactID() : int|null: Get the contact id that the form is being submitted for.
getContactIDsFromComponent() : array<string|int, mixed>: Given the component id, compute the contact id since it's used for things like send email.
getContext() : string
getCurrency() : string: Get the currency for the form.
getDefaultContext() : mixed: Classes extending CRM_Core_Form should implement this method.
getDefaultEntity() : mixed: Classes extending CRM_Core_Form should implement this method.
getDistinctComponentClause() : string: Get the clause for grouping by the component.
getEntityAliasField() : string: Get the group by clause for the component.
getGroupByComponentClause() : string: Get the group by clause for the component.
getHookedTemplateFileName() : mixed: A wrapper for getTemplateFileName.
getIDs() : array<string|int, mixed>|bool: Get ids selected for the task.
getLoggedInUserContactID() : int|false: Get the contact id of the logged in user.
getName() : string: Getter function for Name.
getOptionalQuickFormElements() : array<string|int, mixed>: Get any quick-form elements that may not be present in the form.
getPaymentProcessorID() : int|null
getProfileDefaults() : array<string|int, mixed>: Set default values on form for given contact (or no contact defaults)
getQueryMode() : int: Get the query mode (eg. CRM_Core_BAO_Query::MODE_CASE) Should be overridden by child classes in most cases
getRenderer() : CRM_Core_Form_Renderer: Getter function for renderer.
getRequestedContactID() : int|null: Get the contact ID that has been requested (via url or form value).
getRootTitle() : null
getSearchFormValues() : array<string|int, mixed>: Get the submitted values for the form.
getSearchQueryResults() : CRM_Core_DAO: Get the results from the BAO_Query object based search.
getSelectedIDs() : array<string|int, mixed>: Get the ids the user has selected or an empty array if selection has not been used.
getState() : object: Getter function for State.
getStateType() : int: Getter function for StateType.
getSubmittedValue() : mixed|null: Get value submitted by the user.
getSubmittedValues() : array<string|int, mixed>: Get values submitted by the user.
getTableName() : string: Get the name of the table for the relevant entity.
getTemplate() : CRM_Core_Smarty
getTemplateFileName() : string: Use the form name to create the tpl file name.
getTemplateVars() : mixed: Get the value/s assigned to the Template Engine (Smarty).
getTitle() : string: Getter function for title.
getTokenSchema() : array<string|int, mixed>: Get the token processor schema required to list any tokens for this task.
getUFGroupIDs() : array<string|int, mixed>: Get the active UFGroups (profiles) on this form Many forms load one or more UFGroups (profiles).
getVar() : mixed
isFormInEditMode() : bool: Is the form in edit mode.
isFormInViewMode() : bool: Is the form in view mode.
isQueryIncludesSoftCredits() : bool: Has soft credit information been requested in the query filters.
isSingle() : bool: Is only one entity being processed?
listTokens() : array<string|int, mixed>: List available tokens for this form.
mainProcess() : mixed: Main process wrapper.
orderBy() : string: Default ordering for getContactIDsFromComponent. Subclasses can override.
overrideExtraTemplateFileName() : string: Default extra tpl file basically just replaces .tpl with .extra.tpl.
postProcess() : mixed: Called after the form is validated.
postProcessHook() : mixed: The postProcess hook is typically called by the framework.
preProcess() : mixed: Build all the data structures needed to build the form.
preProcessCommon() : void: Common pre-processing function.
preventAjaxSubmit() : mixed: Sets form attribute.
registerFileField() : void: Register a field with quick form as supporting a file upload.
registerRules() : mixed: Register all the standard rules that most forms potentially use.
removeFileRequiredRules() : mixed
resetValues() : mixed
set() : mixed: Store the variable with the value in the form scope.
setAction() : mixed: Setter for action.
setContactIDs() : void: Given the contribution id, compute the contact id since its used for things like send email
setContext() : mixed: Set context variable.
setContributionIds() : void: Sets contribution Ids for unit test.
setDefaultValues() : array<string|int, mixed>: This virtual function is used to set the default values of various form elements.
setNextUrl() : mixed: Set where the browser should be directed to next.
setOptions() : mixed: Setter function for options.
setPageTitle() : void: Sets page title based on entity and action.
setPurifiedDefaults() : mixed
setSelectedChild() : mixed: Set the active tab
setTitle() : mixed: Setter function for title.
setVar() : mixed
toSmarty() : string: Render form and return contents.
validate() : bool: Performs the server side validation.
validateMandatoryFields() : mixed: Helper function to verify that required fields have been filled.
assignPaymentProcessor() : mixed: This if a front end form function for setting the payment processor.
calculateIDS() : array<string|int, mixed>|bool|array<string|int, string>
formatParamsForPaymentProcessor() : array<string|int, mixed>: Format the fields in $this->_params for the payment processor.
getApiAction() : mixed: Based on form action, return a string representing the api action.
getAuthenticatedCheckSumContactID() : int: Get the contact ID authenticated as a valid by checksum.
getContactIDIfAccessingOwnRecord() : int|false: Get the contact if from the url, using the checksum or the cid if it is the logged in user.
getContactIDs() : array<string|int, mixed>: Get the relevant contact IDs.
getFieldsToExcludeFromPurification() : array<string|int, mixed>: Override this in a subclass to prevent fields intended to contain "raw html" from getting broken. E.g. system message templates
getQueryParams() : array<string|int, mixed>|null: Get the query parameters, adding test = FALSE if needed.
getRows() : array<string|int, mixed>: Get the rows from the results.
getSubmittableFields() : array<string|int, string>: Get the fields that can be submitted in this form flow.
handlePreApproval() : mixed: Handle pre approval for processors.
isFormInViewOrEditMode() : bool: Is the form in view or edit mode.
prepareParamsForPaymentProcessor() : array<string|int, mixed>: Format the fields in $params for the payment processor.
preProcessPaymentOptions() : mixed: Handle Payment Processor switching for contribution and event registration forms.
pushUrlToUserContext() : void: Push path to the userContext (defaults to current url path).
setContactID() : null|int: Get contact iD for a form object.
setTranslatedFields() : mixed: Set translated fields.
validateAuthenticatedCheckSumContactID() : int: Verify that a contact ID is authenticated as a valid contact by checksum
formatReferenceFieldAttributes() : mixed
preProcessChainSelectFields() : mixed: Set options and attributes for chain select fields based on the controlling field's value
selectOrAnyPlaceholder() : string: Handles a repeated bit supplying a placeholder for entity selection
validateChainSelectFields() : mixed: Validate country / state / county match and suppress unwanted "required" errors

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


    public
        string
    ATTR_SPACING
    = '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'

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


    public
        string|int
    CB_PREFIX
    = 'mark_x_'

CB_PREFIX_LEN


    public
        string|int
    CB_PREFIX_LEN
    = 7

CB_PREFIY


    public
        string|int
    CB_PREFIY
    = 'mark_y_'

CB_PREFIZ


    public
        string|int
    CB_PREFIZ
    = 'mark_z_'

$_action

(QUASI-PROTECTED) The mode of operation for this form


    public
        int
    $_action

This field should marked protected and is not generally intended for external callers, but some edge-cases do use it.

$_contactIds

The array that holds all the contact ids


    public
        array<string|int, mixed>
    $_contactIds

$_defaults

The default values for the form.


    public
        array<string|int, mixed>
    $_defaults
     = []

$_entityIds

The array that holds all the case ids


    public
        array<string|int, mixed>
    $_entityIds

$_options

(QUASI-PROTECTED) The options passed into this form


    public
        mixed
    $_options
     = \NULL

This field should marked protected and is not generally intended for external callers, but some edge-cases do use it.

$_paymentProcessorIDs

Available payment processors (IDS).


    public
        array<string|int, mixed>
    $_paymentProcessorIDs

As part of trying to consolidate various payment pages we store processors here & have functions at this level to manage them. An alternative would be to have a separate Form that is inherited by all forms that allow payment processing.

An array of the IDS available on this form.

$ajaxResponse

What to return to the client if in ajax mode (snippet=json)


    public
        array<string|int, mixed>
    $ajaxResponse
     = []

$controller


    public
        CRM_Core_Controller
    $controller

$entityShortname

Must be set to entity shortname (eg. event)


    public
    static    string
    $entityShortname
     = \NULL

$expectedSmartyVariables

Variables smarty expects to have set.


    public
        array<string|int, string>
    $expectedSmartyVariables
     = [
    // in CMSPrint.tpl
    'breadcrumb',
    'pageTitle',
    'urlIsPublic',
    'isDeleted',
    // in 'body.tpl
    'suppressForm',
    'beginHookFormElements',
    // required for footer.tpl
    'contactId',
    // required for info.tpl
    'infoMessage',
    'infoTitle',
    'infoType',
    'infoOptions',
    // required for attachmentjs.tpl
    'context',
    // FormButtons.tpl (adds buttons to forms).
    'linkButtons',
    // Required for contactFooter.tpl.
    // See CRM_Activity_Form_ActivityTest:testInboundEmailDisplaysWithLineBreaks.
    'external_identifier',
    'lastModified',
    'created_date',
    'changeLog',
    // Required for footer.tpl,
    // See CRM_Activity_Form_ActivityTest:testInboundEmailDisplaysWithLineBreaks.
    'footer_status_severity',
    // Required for some profiles (e.g on the Main page of the contribution form flow).
    // A bit tricky to add closer to the usage due to conditionality of inclusion
    'showCMS',
]

We ensure these are assigned (value = NULL) when Smarty is instantiated in order to avoid e-notices / having to use empty or isset in the template layer.

$html5Types

Extra input types we support via the "add" method


    public
    static    array<string|int, mixed>
    $html5Types
     = ['number', 'url', 'email', 'color']

$submitOnce


    public
        bool
    $submitOnce
     = \FALSE

$tableName

Must be set to entity table name (eg. civicrm_participant) by child class


    public
    static    string
    $tableName
     = \NULL

$urlPath

Url path used to reach this page


    public
        array<string|int, mixed>
    $urlPath
     = []

$_actionButtonName

Name of action button


    protected
        string
    $_actionButtonName

$_componentClause

The additional clause that we restrict the search with


    protected
        string
    $_componentClause
     = \NULL

$_componentIds

The array that holds all the component ids


    protected
        array<string|int, mixed>
    $_componentIds

$_contributionIds

The array that holds all the contribution ids.


    protected
        array<string|int, mixed>
    $_contributionIds

$_name

The name of this form


    protected
        string
    $_name

$_paymentProcessorID

Default or selected processor id.


    protected
        int
    $_paymentProcessorID

$_paymentProcessors

Available payment processors.


    protected
        array<string|int, mixed>
    $_paymentProcessors

As part of trying to consolidate various payment pages we store processors here & have functions at this level to manage them.

An array of payment processor details with objects loaded in the 'object' field.

$_renderer

The renderer used for this form


    protected
        object
    $_renderer

$_state

The state object that this form belongs to


    protected
        object
    $_state

$_task

The task being performed


    protected
        int
    $_task

$_template

Cache the smarty template for efficiency reasons


    protected
    static    CRM_Core_Smarty
    $_template

$_title

The title of this form


    protected
        string
    $_title
     = \NULL

$context

Context of the form being loaded.


    protected
        string
    $context

'event' or null

$exportedValues

Values submitted by the user.


    protected
        array<string|int, mixed>
    $exportedValues
     = []

These values have been checked for injection per https://pear.php.net/manual/en/package.html.html-quickform.html-quickform.exportvalues.php and are as submitted.

Once set this array should be treated as read only.

$ids

Selected IDs for the action.


    protected
        array<string|int, mixed>
    $ids

$optionalQuickFormElements

Quick form elements which are conditionally added to the form.


    protected
        array<string|int, mixed>
    $optionalQuickFormElements
     = []

Elements in this array will be added to the form at the end if not present so that smarty does not e-notice on things like '{if $form.group}' when 'group' is not added to the form (e.g when no groups exist).

$queryMode


    protected
        int
    $queryMode

$rows

Rows to act on.


    protected
        array<string|int, mixed>
    $rows
     = []

e.g [ ['contact_id' => 4, 'participant_id' => 6, 'schema' => ['contactId' => 5, 'participantId' => 6], ]

$submittableMoneyFields

Monetary fields that may be submitted.


    protected
        array<string|int, mixed>
    $submittableMoneyFields
     = []

Any fields in this list will be converted to non-localised format if retrieved by getSubmittedValue

$unsavedChangesWarn

Indicate if this form should warn users of unsaved changes


    protected
        bool
    $unsavedChangesWarn

$authenticatedContactID

The contact ID that has been authenticated and can be used for checking permissions.


    private
        int
    $authenticatedContactID

It could be a combination of cid in the url plus a checksum or the logged in user. Importantly it can be used to run permission checks on.

$isValidated


    private
        true
    $isValidated
     = \FALSE

__construct()

Constructor for the basic form page.


    public
                    __construct([object $state = NULL ][, int $action = CRM_Core_Action::NONE ][, string $method = 'post' ][, string $name = NULL ]) : CRM_Core_Form

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

Parameters

$state : object = NULL: State associated with this form.
$action : int = CRM_Core_Action::NONE: The mode the form is operating in (None/Create/View/Update/Delete)
$method : string = 'post': The type of http method used (GET/POST).
$name : string = NULL: The name of the form if different from class name.

Return values

CRM_Core_Form

add()

Simple easy to use wrapper around addElement.


    public
                &    add(string $type, string $name[, string $label = '' ][, array<string|int, mixed> $attributes = NULL ][, bool $required = FALSE ][, array<string|int, mixed> $extra = NULL ]) : HTML_QuickForm_Element

Deal with simple validation rules.

Parameters

$type : string
$name : string
$label : string = ''
$attributes : array<string|int, mixed> = NULL: (options for select elements)
$required : bool = FALSE
$extra : array<string|int, mixed> = NULL: (attributes for select elements). For datepicker elements this is consistent with the data from CRM_Utils_Date::getDatePickerExtra

Return values

HTML_QuickForm_Element —

Could be an error object

addAutocomplete()


    public
                    addAutocomplete(string $name[, string $label = '' ][, array<string|int, mixed> $props = [] ][, bool $required = FALSE ]) : HTML_QuickForm_Element

Parameters

$name : string
$label : string = ''
$props : array<string|int, mixed> = []
$required : bool = FALSE

Return values

HTML_QuickForm_Element

addAutoSelector()

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


    public
                    addAutoSelector([array<string|int, mixed> $profiles = [] ][, array<string|int, mixed> $autoCompleteField = [] ]) : mixed

{if !empty($selectable)}

{$form.select_contact.label}

{$form.select_contact.html}

{/if}

Parameters

$profiles : array<string|int, mixed> = []

Ids of profiles that are on the form (to be autofilled).

$autoCompleteField : array<string|int, mixed> = []

name_field
id_field
url (for ajax lookup)

addButtons()

Add default Next / Back buttons.


    public
                    addButtons(array<string|int, mixed> $params) : mixed

Parameters

$params : array<string|int, mixed>: Array of associative arrays in the order in which the buttons should be displayed. The associate array has 3 fields: 'type', 'name' and 'isDefault' The base form class will define a bunch of static arrays for commonly used formats.

addChainSelect()

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


    public
                    addChainSelect(string $elementName[, array<string|int, mixed> $settings = [] ]) : HTML_QuickForm_Element

Parameters

$elementName : string
$settings : array<string|int, mixed> = []

Return values

HTML_QuickForm_Element

addCheckBox()


    public
                    addCheckBox(int $id, string $title, array<string|int, mixed> $values[, null $other = NULL ][, null $attributes = NULL ][, null $required = NULL ][, null $javascriptMethod = NULL ][, string $separator = '<br />' ][, bool $flipValues = FALSE ]) : mixed

Parameters

$id : int
$title : string
$values : array<string|int, mixed>
$other : null = NULL
$attributes : null = NULL
$required : null = NULL
$javascriptMethod : null = NULL
$separator : string = '<br />'
$flipValues : bool = FALSE

addCIDZeroOptions()

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


    public
                    addCIDZeroOptions() : mixed

addClass()

Add one or more css classes to the form.


    public
                    addClass(string $className) : mixed

Parameters

$className : string

addCurrency()

Add currency element to the form.


    public
                    addCurrency([string $name = 'currency' ][, string $label = NULL ][, bool $required = TRUE ][, string $defaultCurrency = NULL ][, bool $freezeCurrency = FALSE ][, bool $setDefaultCurrency = TRUE ]) : mixed

Parameters

$name : string = 'currency'
$label : string = NULL
$required : bool = TRUE
$defaultCurrency : string = NULL
$freezeCurrency : bool = FALSE
$setDefaultCurrency : bool = TRUE

addDate()

Add date.


    public
                    addDate(string $name, string $label[, bool $required = FALSE ][, array<string|int, mixed> $attributes = NULL ]) : mixed

Use $this->add('datepicker', ...) instead.

Parameters

$name : string: Name of the element.
$label : string: Label of the element.
$required : bool = FALSE: True if required.
$attributes : array<string|int, mixed> = NULL: Key / value pair.

addDatePickerRange()

Add a search for a range using date picker fields.


    public
                    addDatePickerRange(string $fieldName, string $label[, bool $isDateTime = FALSE ][, bool $required = FALSE ][, string $fromLabel = 'From' ][, string $toLabel = 'To' ][, array<string|int, mixed> $additionalOptions = [] ][, string $to = '_high' ][, string $from = '_low' ]) : mixed

Parameters

$fieldName : string
$label : string
$isDateTime : bool = FALSE: Is this a date-time field (not just date).
$required : bool = FALSE
$fromLabel : string = 'From'
$toLabel : string = 'To'
$additionalOptions : array<string|int, mixed> = []
$to : string = '_high': string to append to the to field.
$from : string = '_low': string to append to the from field.

addDateRange()


    public
                    addDateRange(string $name[, string $from = '_from' ][, string $to = '_to' ][, string $label = 'From:' ][, string $dateFormat = 'searchDate' ][, bool $required = FALSE ][, bool $displayTime = FALSE ]) : mixed

Use $this->addDatePickerRange() instead.

Parameters

$name : string
$from : string = '_from'
$to : string = '_to'
$label : string = 'From:'
$dateFormat : string = 'searchDate'
$required : bool = FALSE
$displayTime : bool = FALSE

addDateTime()

Function that will add date and time.


    public
                    addDateTime(string $name, string $label[, bool $required = FALSE ][, array<string|int, mixed> $attributes = NULL ]) : mixed

Use $this->add('datepicker', ...) instead.

Parameters

$name : string
$label : string
$required : bool = FALSE
$attributes : array<string|int, mixed> = NULL

addDefaultButtons()

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


    public
                    addDefaultButtons(string $title[, string $nextType = 'next' ][, string $backType = 'back' ][, bool $submitOnce = FALSE ]) : mixed

Parameters

$title : string: Title of the main button.
$nextType : string = 'next': Button type for the form after processing.
$backType : string = 'back'
$submitOnce : bool = FALSE

addEntityRef()

Create a single or multiple entity ref field.


    public
                    addEntityRef(string $name[, string $label = '' ][, array<string|int, mixed> $props = [] ][, bool $required = FALSE ]) : HTML_QuickForm_Element

Parameters

$name : string

$label : string = ''

$props : array<string|int, mixed> = []

Mix of html and widget properties, including:.

select - params to give to select2 widget
entity - defaults to Contact
create - can the user create a new entity on-the-fly? Set to TRUE if entity is contact and you want the default profiles, or pass in your own set of links. @see CRM_Campaign_BAO_Campaign::getEntityRefCreateLinks for format note that permissions are checked automatically
api - array of settings for the getlist api wrapper note that it accepts a 'params' setting which will be passed to the underlying api
placeholder - string
multiple - bool
class, etc. - other html properties

$required : bool = FALSE

Return values

HTML_QuickForm_Element

addExpectedSmartyVariable()

Add an expected smarty variable to the array.


    public
                    addExpectedSmartyVariable(string $elementName) : void

Parameters

$elementName : string

addExpectedSmartyVariables()

Add an expected smarty variable to the array.


    public
                    addExpectedSmartyVariables(array<string|int, mixed> $elementNames) : void

Parameters

$elementNames : array<string|int, mixed>

addField()

Adds a field based on metadata.


    public
                    addField(mixed $name[, array<string|int, mixed> $props = [] ][, bool $required = FALSE ][, bool $legacyDate = TRUE ]) : mixed

Parameters

$name : mixed

Field name to go on the form.

$props : array<string|int, mixed> = []

Mix of html attributes and special properties, namely.

entity (api entity name, can usually be inferred automatically from the form class)
name (field name - only needed if different from name used on the form)
option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
placeholder - set to NULL to disable
multiple - bool
context - @see CRM_Core_DAO::buildOptionsContext

$required : bool = FALSE

$legacyDate : bool = TRUE

Temporary param to facilitate the conversion of fields to use the datepicker in a controlled way. To convert the field the jcalendar code needs to be removed from the tpl as well. That file is intended to be EOL.

Return values

mixed —

HTML_QuickForm_element void

addMoney()

Add a currency and money element to the form.


    public
                    addMoney(string $name, string $label[, bool $required = FALSE ][, array<string|int, mixed> $attributes = NULL ][, bool $addCurrency = TRUE ][, string $currencyName = 'currency' ][, string $defaultCurrency = NULL ][, bool $freezeCurrency = FALSE ]) : HTML_QuickForm_Element

Parameters

$name : string
$label : string
$required : bool = FALSE
$attributes : array<string|int, mixed> = NULL
$addCurrency : bool = TRUE
$currencyName : string = 'currency'
$defaultCurrency : string = NULL
$freezeCurrency : bool = FALSE

Return values

HTML_QuickForm_Element

addOptionalQuickFormElement()

Add an optional element to the optional elements array.


    public
                    addOptionalQuickFormElement(string $elementName) : void

These elements are assigned as empty (null) variables if there is no real field - allowing smarty to use them without notices.

Parameters

$elementName : string

addProfileSelector()

Add a widget for selecting/editing/creating/copying a profile form


    public
                    addProfileSelector(string $name, string $label, string $allowCoreTypes, string $allowSubTypes, array<string|int, mixed> $entities[, bool $default = FALSE ][, string $usedFor = NULL ]) : mixed

Parameters

$name : string: HTML form-element name.
$label : string: Printable label.
$allowCoreTypes : string: Only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity'.
$allowSubTypes : string: Only present a UFGroup if its group_type is compatible with $allowSubypes.
$entities : array<string|int, mixed>
$default : bool = FALSE: //CRM-15427.
$usedFor : string = NULL

addRadio()


    public
                &    addRadio(string $name, string $title, array<string|int, mixed> $values[, array<string|int, mixed> $attributes = [] ][, string $separator = NULL ][, bool $required = FALSE ][, array<string|int, mixed> $optionAttributes = [] ]) : HTML_QuickForm_group

Parameters

$name : string

$title : string

$values : array<string|int, mixed>

$attributes : array<string|int, mixed> = []

$separator : string = NULL

$required : bool = FALSE

$optionAttributes : array<string|int, mixed> = []

Option specific attributes

Return values

HTML_QuickForm_group

addRules()

This is a virtual function that adds group and global rules to the form.


    public
                    addRules() : mixed

Keeping it distinct from the form to keep code small and localized in the form building code

addSelect()

Adds a select based on field metadata.


    public
                    addSelect(string $name[, array<string|int, mixed> $props = [] ][, bool $required = FALSE ]) : HTML_QuickForm_Element

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

Parameters

$name : string

Field name to go on the form.

$props : array<string|int, mixed> = []

Mix of html attributes and special properties, namely.

entity (api entity name, can usually be inferred automatically from the form class)
field (field name - only needed if different from name used on the form)
option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
placeholder - set to NULL to disable
multiple - bool
context - @see CRM_Core_DAO::buildOptionsContext

$required : bool = FALSE

Return values

HTML_QuickForm_Element

addTaskMenu()

Add actions menu to results form.


    public
                    addTaskMenu(array<string|int, mixed> $tasks) : mixed

Parameters

$tasks : array<string|int, mixed>

addUploadElement()


    public
                    addUploadElement(array<string|int, string>|string $elementName) : mixed

Parameters

$elementName : array<string|int, string>|string

addYesNo()


    public
                    addYesNo(string $id, string $title[, bool $allowClear = FALSE ][, bool $required = NULL ][, array<string|int, mixed> $attributes = [] ]) : mixed

Parameters

$id : string
$title : string
$allowClear : bool = FALSE
$required : bool = NULL
$attributes : array<string|int, mixed> = []

allowAjaxSubmit()

Sets form attribute.


    public
                    allowAjaxSubmit() : mixed

append()

Appends values to template variables.


    public
                    append(array<string|int, mixed>|string $tpl_var[, mixed $value = NULL ][, bool $merge = FALSE ]) : mixed

Parameters

$tpl_var : array<string|int, mixed>|string: the template variable name(s)
$value : mixed = NULL: The value to append.
$merge : bool = FALSE

assign()

Assign value to name in template.


    public
                    assign(string $var[, mixed $value = NULL ]) : mixed

Parameters

$var : string: Name of variable.
$value : mixed = NULL: Value of variable.

assign_by_ref()

Assign value to name in template by reference.


    public
                    assign_by_ref(string $var, mixed &$value) : mixed

since 5.72 will be removed around 5.84

Parameters

$var : string: Name of variable.
$value : mixed: Value of variable.

assignBillingName()

Assign billing name to the template.


    public
                    assignBillingName([array<string|int, mixed> $params = [] ]) : string

Parameters

$params : array<string|int, mixed> = []: Form input params, default to $this->_params.

Return values

string

assignBillingType()

Assign billing type id to bltID.


    public
                    assignBillingType() : mixed

assignVariables()

Assign an array of variables to the form/tpl


    public
                    assignVariables(array<string|int, mixed> $values, array<string|int, mixed> $keys) : mixed

Parameters

$values : array<string|int, mixed>: Array of [key => value] to assign to the form
$keys : array<string|int, mixed>: Array of keys to assign from the values array

buildForm()

Core function that builds the form.


    public
                    buildForm() : mixed

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

buildQuickForm()

This virtual function is used to build the form.


    public
                    buildQuickForm() : mixed

It replaces the buildForm associated with QuickForm_Page. This allows us to put preProcess in front of the actual form building routine

cancelAction()

Function that can be defined in Form to override or.


    public
                    cancelAction() : mixed

perform specific action on cancel action

canUseAjaxContactLookups()


    public
                    canUseAjaxContactLookups() : bool

Return values

bool

error()

Error reporting mechanism.


    public
                    error(string $message[, int $code = NULL ][, CRM_Core_DAO $dao = NULL ]) : mixed

Parameters

$message : string: Error Message.
$code : int = NULL: Error Code.
$dao : CRM_Core_DAO = NULL: A data access object on which we perform a rollback if non - empty.

get()

Get the variable from the form scope.


    public
                    get(string $name) : mixed

Parameters

$name : string: Name of the variable

get_template_vars()

Returns an array containing template variables.


    public
                    get_template_vars([string $name = NULL ]) : array<string|int, mixed>

since 5.69 will be removed around 5.93. use getTemplateVars.

Parameters

$name : string = NULL

Return values

array<string|int, mixed>

getAction()

Getter for action.


    public
                    getAction() : int|null

Return values

int|null

getAuthenticatedContactID()

Get the authenticated contact ID.


    public
                    getAuthenticatedContactID() : int

APIYes

This is either

a contact ID authenticated by checksum
the logged in user
0 for none.

Return values

int

getCompleteTitle()


    public
                    getCompleteTitle() : string

Return values

string

getComponentClause()

Get the clause to add to queries to hone the results.


    public
                    getComponentClause() : string

In practice this generally means the query to limit by selected ids.

Return values

string

getContactID()

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


    public
                    getContactID() : int|null

Return values

int|null

getContactIDsFromComponent()

Given the component id, compute the contact id since it's used for things like send email.


    public
                    getContactIDsFromComponent(mixed $componentIDs, string $tableName[, string $idField = 'id' ]) : array<string|int, mixed>

Parameters

$componentIDs : mixed
$tableName : string
$idField : string = 'id'

Return values

array<string|int, mixed>

getContext()


    public
                    getContext() : string

Return values

string

getCurrency()

Get the currency for the form.


    public
                    getCurrency() : string

Return values

string

getDefaultContext()

Classes extending CRM_Core_Form should implement this method.


    public
                    getDefaultContext() : mixed

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

getDefaultEntity()

Classes extending CRM_Core_Form should implement this method.


    public
                    getDefaultEntity() : mixed

getDistinctComponentClause()

Get the clause for grouping by the component.


    public
                    getDistinctComponentClause() : string

Return values

string

getEntityAliasField()

Get the group by clause for the component.


    public
                    getEntityAliasField() : string

Return values

string

getGroupByComponentClause()

Get the group by clause for the component.


    public
                    getGroupByComponentClause() : string

Return values

string

getHookedTemplateFileName()

A wrapper for getTemplateFileName.


    public
                    getHookedTemplateFileName() : mixed

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

getIDs()

Get ids selected for the task.


    public
                    getIDs() : array<string|int, mixed>|bool

Return values

array<string|int, mixed>|bool

getLoggedInUserContactID()

Get the contact id of the logged in user.


    public
                    getLoggedInUserContactID() : int|false

Return values

int|false

getName()

Getter function for Name.


    public
                    getName() : string

Return values

string

getOptionalQuickFormElements()

Get any quick-form elements that may not be present in the form.


    public
                    getOptionalQuickFormElements() : array<string|int, mixed>

To make life simpler for smarty we ensure they are set to null rather than unset. This is done at the last minute when $this is converted to an array to be assigned to the form.

Return values

array<string|int, mixed>

getPaymentProcessorID()


    public
                    getPaymentProcessorID() : int|null

Return values

int|null

getProfileDefaults()

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


    public
                    getProfileDefaults([mixed $profile_id = 'Billing' ][, int $contactID = NULL ]) : array<string|int, mixed>

Parameters

$profile_id : mixed = 'Billing': (can be id, or profile name).
$contactID : int = NULL

Return values

array<string|int, mixed>

getQueryMode()

Get the query mode (eg. CRM_Core_BAO_Query::MODE_CASE) Should be overridden by child classes in most cases


    public
                    getQueryMode() : int

Return values

int

getRenderer()

Getter function for renderer.


    public
                &    getRenderer() : CRM_Core_Form_Renderer

If renderer is not set create one and initialize it.

Return values

CRM_Core_Form_Renderer

getRequestedContactID()

Get the contact ID that has been requested (via url or form value).


    public
                    getRequestedContactID() : int|null

Ideally the forms would override this so only the cid in the url would be checked in the shared form function.

Return values

int|null

getRootTitle()


    public
                    getRootTitle() : null

Return values

null

getSearchFormValues()

Get the submitted values for the form.


    public
                    getSearchFormValues() : array<string|int, mixed>

Return values

array<string|int, mixed>

getSearchQueryResults()

Get the results from the BAO_Query object based search.


    public
                    getSearchQueryResults() : CRM_Core_DAO

Return values

CRM_Core_DAO

getSelectedIDs()

Get the ids the user has selected or an empty array if selection has not been used.


    public
                    getSelectedIDs(array<string|int, mixed> $values) : array<string|int, mixed>

Parameters

$values : array<string|int, mixed>

Return values

array<string|int, mixed>

getState()

Getter function for State.


    public
                &    getState() : object

Return values

object

getStateType()

Getter function for StateType.


    public
                    getStateType() : int

Return values

int

getSubmittedValue()

Get value submitted by the user.


    public
                    getSubmittedValue(string $fieldName) : mixed|null

APIYes

These values have been validated against the fields added to the form. https://pear.php.net/manual/en/package.html.html-quickform.html-quickform.exportvalues.php unless the function is being called during before the submission has been validated. In which the values are not yet validated & hence taking directly from $_POST.

Fields with money or number formats are converted from localised formats before returning.

Parameters

$fieldName : string

Return values

mixed|null

getSubmittedValues()

Get values submitted by the user.


    public
                    getSubmittedValues() : array<string|int, mixed>

APIYes

Compared with $this->controller->exportValues this has a couple of changes

any fields declared in $this->submittableMoneyFields will be de-formatted first.
it is possible to store access fields from related forms if they are declared in getSubmittableFields(). This is notably used in imports to combine fields from the various screens & save the resulting 'submitted_values' to the UserJob.

Return values

array<string|int, mixed>

getTableName()

Get the name of the table for the relevant entity.


    public
                    getTableName() : string

Return values

string

getTemplate()


    public
            static    &    getTemplate() : CRM_Core_Smarty

Return values

CRM_Core_Smarty

getTemplateFileName()

Use the form name to create the tpl file name.


    public
                    getTemplateFileName() : string

Return values

string

getTemplateVars()

Get the value/s assigned to the Template Engine (Smarty).


    public
                    getTemplateVars([string|null $name = NULL ]) : mixed

Parameters

$name : string|null = NULL

getTitle()

Getter function for title.


    public
                    getTitle() : string

Should be over-ridden by derived class.

Return values

string

getTokenSchema()

Get the token processor schema required to list any tokens for this task.


    public
                    getTokenSchema() : array<string|int, mixed>

Return values

array<string|int, mixed>

getUFGroupIDs()

Get the active UFGroups (profiles) on this form Many forms load one or more UFGroups (profiles).


    public
                    getUFGroupIDs() : array<string|int, mixed>

This provides a standard function to retrieve the IDs of those profiles from the form so that you can implement things such as "is is_captcha field set on any of the active profiles on this form?"

NOT SUPPORTED FOR USE OUTSIDE CORE EXTENSIONS - Added for reCAPTCHA core extension.

Return values

array<string|int, mixed>

getVar()


    public
                    getVar(string $name) : mixed

use of this function assumes that an otherwise unavailable variable can be used form outside the class in question. However, the very fact it is otherwise unavailable means there is no contract that it will not be changed or become unused. This function is OK for temporary usage but should be accompanied with an effort to establish a more correct method or property tested hook / api interface if this is being done from outside of core.

Parameters

$name : string

isFormInEditMode()

Is the form in edit mode.


    public
                    isFormInEditMode() : bool

Helper function, notably for extensions implementing the buildForm hook, so that they can return early.

Return values

bool

isFormInViewMode()

Is the form in view mode.


    public
                    isFormInViewMode() : bool

Helper function, notably for extensions implementing the buildForm hook, so that they can return early.

Return values

bool

isQueryIncludesSoftCredits()

Has soft credit information been requested in the query filters.


    public
                    isQueryIncludesSoftCredits() : bool

Return values

bool

isSingle()

Is only one entity being processed?


    public
                    isSingle() : bool

Return values

bool

listTokens()

List available tokens for this form.


    public
                    listTokens() : array<string|int, mixed>

Return values

array<string|int, mixed>

mainProcess()

Main process wrapper.


    public
                    mainProcess([bool $allowAjax = TRUE ]) : mixed

Implemented so that we can call all the hook functions.

Parameters

$allowAjax : bool = TRUE: FIXME: This feels kind of hackish, ideally we would take the json-related code from this function. and bury it deeper down in the controller

orderBy()

Default ordering for getContactIDsFromComponent. Subclasses can override.


    public
                    orderBy() : string

Return values

string —

SQL fragment. Either return '' or a valid order clause including the words "ORDER BY", e.g. "ORDER BY {$this->idField}"

overrideExtraTemplateFileName()

Default extra tpl file basically just replaces .tpl with .extra.tpl.


    public
                    overrideExtraTemplateFileName() : string

i.e. we do not override.

Return values

string

postProcess()

Called after the form is validated.


    public
                    postProcess() : mixed

Any processing of form state etc should be done in this function. Typically all processing associated with a form should be done here and relevant state should be stored in the session

This is a virtual function and should be redefined if needed

postProcessHook()

The postProcess hook is typically called by the framework.


    public
                    postProcessHook() : mixed

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

preProcess()

Build all the data structures needed to build the form.


    public
                    preProcess() : mixed

preProcessCommon()

Common pre-processing function.


    public
            static        preProcessCommon(CRM_Contribute_Form_Task &$form) : void

Parameters

$form : CRM_Contribute_Form_Task

preventAjaxSubmit()

Sets form attribute.


    public
                    preventAjaxSubmit() : mixed

registerFileField()


    public
                    registerFileField(array<string|int, mixed> $fieldNames) : void

Parameters

$fieldNames : array<string|int, mixed>

registerRules()


    public
                    registerRules() : mixed

removeFileRequiredRules()


    public
                    removeFileRequiredRules(mixed $elementName) : mixed

Parameters

$elementName : mixed

resetValues()


    public
                    resetValues() : mixed

set()

Store the variable with the value in the form scope.


    public
                    set(string $name, mixed $value) : mixed

Parameters

$name : string: Name of the variable.
$value : mixed: Value of the variable.

setAction()

Setter for action.


    public
                    setAction(int $action) : mixed

Parameters

$action : int: The mode we want to set the form.

setContactIDs()

Given the contribution id, compute the contact id since its used for things like send email


    public
                    setContactIDs() : void

setContext()

Set context variable.


    public
                    setContext() : mixed

setContributionIds()

Sets contribution Ids for unit test.


    public
                    setContributionIds(array<string|int, mixed> $contributionIds) : void

Parameters

$contributionIds : array<string|int, mixed>

setDefaultValues()

This virtual function is used to set the default values of various form elements.


    public
                    setDefaultValues() : array<string|int, mixed>

Return values

array<string|int, mixed> —

reference to the array of default values

setNextUrl()

Set where the browser should be directed to next.


    public
                    setNextUrl(string $pathPart) : mixed

Parameters

$pathPart : string

setOptions()

Setter function for options.


    public
                    setOptions(mixed $options) : mixed

Parameters

$options : mixed

setPageTitle()

Sets page title based on entity and action.


    public
                    setPageTitle([string|null $entityLabel = NULL ]) : void

Parameters

$entityLabel : string|null = NULL

setPurifiedDefaults()


    public
                    setPurifiedDefaults(mixed $defaults) : mixed

Parameters

$defaults : mixed

setSelectedChild()

Set the active tab


    public
                    setSelectedChild([string $default = NULL ]) : mixed

Parameters

$default : string = NULL

setTitle()

Setter function for title.


    public
                    setTitle(string $title) : mixed

Parameters

$title : string: The title of the form.

setVar()


    public
                    setVar(string $name, mixed $value) : mixed

use of this function assumes that an otherwise unavailable variable can be used form outside the class in question. However, the very fact it is otherwise unavailable means there is no contract that it will not be changed or become unused. This function is OK for temporary usage but should be accompanied with an effort to establish a more correct method or property tested hook / api interface if this is being done from outside of core.

Parameters

$name : string
$value : mixed

toSmarty()

Render form and return contents.


    public
                    toSmarty() : string

Return values

string

validate()

Performs the server side validation.


    public
                    validate() : bool

Return values

bool —

true if no error found

validateMandatoryFields()

Helper function to verify that required fields have been filled.


    public
            static        validateMandatoryFields(array<string|int, mixed> $fields, array<string|int, mixed> $values, array<string|int, mixed> &$errors) : mixed

Typically called within the scope of a FormRule function

Parameters

$fields : array<string|int, mixed>
$values : array<string|int, mixed>
$errors : array<string|int, mixed>

assignPaymentProcessor()

This if a front end form function for setting the payment processor.


    protected
                    assignPaymentProcessor(bool $isPayLaterEnabled) : mixed

It would be good to sync it with the back-end function on abstractEditPayment & use one everywhere.

Parameters

$isPayLaterEnabled : bool

calculateIDS()


    protected
                    calculateIDS() : array<string|int, mixed>|bool|array<string|int, string>

Return values

array<string|int, mixed>|bool|array<string|int, string>

formatParamsForPaymentProcessor()

Format the fields in $this->_params for the payment processor.


    protected
                    formatParamsForPaymentProcessor(array<string|int, mixed> $fields) : array<string|int, mixed>

In order to pass fields to the payment processor in a consistent way we add some renamed parameters.

Parameters

$fields : array<string|int, mixed>

Return values

array<string|int, mixed>

getApiAction()

Based on form action, return a string representing the api action.


    protected
                    getApiAction() : mixed

Used by addField method.

Return string

getAuthenticatedCheckSumContactID()

Get the contact ID authenticated as a valid by checksum.


    protected
                    getAuthenticatedCheckSumContactID() : int

Return values

int

getContactIDIfAccessingOwnRecord()

Get the contact if from the url, using the checksum or the cid if it is the logged in user.


    protected
                    getContactIDIfAccessingOwnRecord() : int|false

use getAuthenticatedContactID()

This function returns the user being validated. It is not intended to get another user they have permission to (setContactID does do that) and can be used to check if the user is accessing their own record.

Return values

int|false

getContactIDs()

Get the relevant contact IDs.


    protected
                    getContactIDs() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFieldsToExcludeFromPurification()

Override this in a subclass to prevent fields intended to contain "raw html" from getting broken. E.g. system message templates


    protected
                    getFieldsToExcludeFromPurification() : array<string|int, mixed>

Return values

array<string|int, mixed>

getQueryParams()

Get the query parameters, adding test = FALSE if needed.


    protected
                    getQueryParams() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

getRows()

Get the rows from the results.


    protected
                    getRows() : array<string|int, mixed>

Return values

array<string|int, mixed>

getSubmittableFields()

Get the fields that can be submitted in this form flow.


    protected
                    getSubmittableFields() : array<string|int, string>

APIYes

To make fields in related forms (ie within the same wizard like Contribution_Main and Contribution_Confirm) accessible you can override this function as CRM_Import_Forms does.

Return values

array<string|int, string>

handlePreApproval()

Handle pre approval for processors.


    protected
                    handlePreApproval(array<string|int, mixed> &$params) : mixed

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.

Parameters

$params : array<string|int, mixed>

isFormInViewOrEditMode()

Is the form in view or edit mode.


    protected
                    isFormInViewOrEditMode() : bool

The 'addField' function relies on the form action being one of a set list of actions. Checking for these allows for an early return.

Return values

bool

prepareParamsForPaymentProcessor()

Format the fields in $params for the payment processor.


    protected
                    prepareParamsForPaymentProcessor(array<string|int, mixed> $params) : array<string|int, mixed>

In order to pass fields to the payment processor in a consistent way we add some renamed parameters.

Parameters

$params : array<string|int, mixed>: Payment processor params

Return values

array<string|int, mixed> —

$params

preProcessPaymentOptions()

Handle Payment Processor switching for contribution and event registration forms.


    protected
                    preProcessPaymentOptions() : mixed

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.

pushUrlToUserContext()

Push path to the userContext (defaults to current url path).


    protected
                    pushUrlToUserContext([string|null $path = NULL ]) : void

This is like a save point :-). The next status bounce will return the browser to this url unless another is added.

Parameters

$path : string|null = NULL: Path string e.g. civicrm/foo/bar?reset=1, defaults to current path.

setContactID()

Get contact iD for a form object.


    protected
                    setContactID() : null|int

This checks the requestedContactID and returns it if

it is the number 0 (relevant for online contribution & event forms).
it is the logged in user
it is validated by a checksum in the url.
it is a contact that the logged in user has permission to view

Failing that it returns the logged in user, if any. This is may be useful for users taking actions from their contact dashboard (although usually one of the variants above would be hit).

Return values

null|int

setTranslatedFields()

Set translated fields.


    protected
                    setTranslatedFields() : mixed

This function is called from the class constructor, allowing us to set fields on the class that can't be set as properties due to need for translation or other non-input specific handling.

validateAuthenticatedCheckSumContactID()

Verify that a contact ID is authenticated as a valid contact by checksum


    protected
                    validateAuthenticatedCheckSumContactID(int|null $contactID) : int

Parameters

$contactID : int|null

Return values

int

formatReferenceFieldAttributes()


    private
                    formatReferenceFieldAttributes(array<string|int, mixed> &$props, string $formName) : mixed

Parameters

$props : array<string|int, mixed>
$formName : string

preProcessChainSelectFields()

Set options and attributes for chain select fields based on the controlling field's value


    private
                    preProcessChainSelectFields() : mixed

selectOrAnyPlaceholder()

Handles a repeated bit supplying a placeholder for entity selection


    private
            static        selectOrAnyPlaceholder(string $props, bool $required[, string $title = NULL ]) : string

Parameters

$props : string: The field properties, including the entity and context.
$required : bool: If the field is required.
$title : string = NULL: A field title, if applicable.

Return values

string —

The placeholder text.

validateChainSelectFields()

Validate country / state / county match and suppress unwanted "required" errors


    private
                    validateChainSelectFields() : mixed

CRM_Contribute_Form_Task extends CRM_Core_Form_Task in package CRM uses CRM_Contribute_Form_Task_TaskTrait

Table of Contents

Constants

Properties

Methods

Constants

ATTR_SPACING

CB_PREFIX

CB_PREFIX_LEN

CB_PREFIY

CB_PREFIZ

Properties

$_action

$_contactIds

$_defaults

$_entityIds

$_options

$_paymentProcessorIDs

$ajaxResponse

$controller

$entityShortname

$expectedSmartyVariables

$html5Types

$submitOnce

$tableName

$urlPath

$_actionButtonName

$_componentClause

$_componentIds

$_contributionIds

$_name

$_paymentProcessorID

$_paymentProcessors

$_renderer

$_state

$_task

$_template

$_title

$context

$exportedValues

$ids

$optionalQuickFormElements

$queryMode

$rows

$submittableMoneyFields

$unsavedChangesWarn

$authenticatedContactID

$isValidated

Methods

__construct()

Parameters

Return values

add()

Parameters

Tags

Return values

addAutocomplete()

Parameters

Return values

addAutoSelector()

Parameters

Tags

addButtons()

Parameters

addChainSelect()

Parameters

Return values

addCheckBox()

Parameters

addCIDZeroOptions()

Tags

addClass()

Parameters

addCurrency()

Parameters

addDate()

Parameters

addDatePickerRange()

Parameters

addDateRange()

CRM_Contribute_Form_Task extends CRM_Core_Form_Task
in package

CRM

uses CRM_Contribute_Form_Task_TaskTrait