Documentation

CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_Registration
in package

CRM

This class generates form components for processing Event.

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
$_additionalParticipantIds : array<string|int, mixed>: Store additional participant ids.
$_allowConfirmation : bool: Is participant able to walk registration wizard.
$_allowWaitlist : bool: Is event configured for waitlist.
$_availableRegistrations : mixed
$_bltID : int: The billing location id for this contribution page.
$_defaults : array<string|int, mixed>: The default values for the form.
$_eventId : int: The id of the event we are processing.
$_fields : array<string|int, mixed>: The fields involved in this contribution page.
$_isBillingAddressRequiredForPayLater : bool
$_isEventFull : bool: Is event already full.
$_lineItem : mixed
$_lineItemParticipantsCount : mixed
$_mode : string: The payment mode that we are in ("live" or "test") This should be protected and retrieved via getPaymentMode() but it's accessed all over the place so we have to leave it public for now.
$_options : mixed: (QUASI-PROTECTED) The options passed into this form
$_paymentProcessor : array<string|int, mixed>: The paymentProcessor attributes for this page.
$_paymentProcessorIDs : array<string|int, mixed>: Available payment processors (IDS).
$_pcpId : mixed
$_priceSet : array<string|int, mixed>: Array of fields for the price set.
$_priceSetId : int: Price Set ID, if the new price set method is used
$_requireApproval : bool: Is participant requires approval.
$_values : array<string|int, mixed>: The values for the contribution db object.
$ajaxResponse : array<string|int, mixed>: What to return to the client if in ajax mode (snippet=json)
$controller : CRM_Core_Controller
$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
$isBackOffice : bool: Is this a back office form
$paymentInstrumentID : int: Payment instrument iD for the transaction.
$submitOnce : bool
$urlPath : array<string|int, mixed>: Url path used to reach this page
$_actionButtonName : string: Name of action button
$_name : string: The name of this form
$_params : array<string|int, mixed>: The params submitted by the form and computed by the app.
$_participantId : int: The id of the participant we are processing.
$_participantIDS : int: The array of ids of all the participant we are processing.
$_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
$_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.
$isPayLater : bool: Is pay later enabled on this form?
$optionalQuickFormElements : array<string|int, mixed>: Quick form elements which are conditionally added to the form.
$payLaterLabel : string: The label for the pay later pseudoprocessor option.
$showPaymentOnConfirm : bool: Should the payment element be shown on the confirm page instead of the first page?
$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
$optionsCount : array<string|int, mixed>
$order : CRM_Financial_BAO_Order

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.
assignToTemplate() : mixed: Assign the minimal set of variables to the template.
assignVariables() : mixed: Assign an array of variables to the form/tpl
buildCustom() : mixed: Add the custom fields.
buildForm() : mixed: Core function that builds the form.
buildQuickForm() : void: Build the form object.
cancelAction() : mixed: Function that can be defined in Form to override or.
canUseAjaxContactLookups() : bool
checkTemplateFileExists() : string|null: Check template file exists.
confirmPostProcess() : mixed: Handle process after the confirmation of payment by User.
error() : mixed: Error reporting mechanism.
formatPriceSetParams() : array<string|int, mixed>: Format user submitted price set params.
formRule() : bool|array<string|int, mixed>: Global form rule.
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
getContactID() : int|null: Get the contact id that the form is being submitted for.
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.
getEventID() : int|null: Get the selected Event ID.
getEventValue() : mixed: Get the value for a field relating to the event.
getFormContext() : string: Get the form context.
getHookedTemplateFileName() : mixed: A wrapper for getTemplateFileName.
getIsBackOffice() : bool
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.
getPages() : array<string|int, mixed>
getParticipantID() : int|null: Get id of participant being acted on.
getParticipantValue() : mixed: Get a value from the participant being acted on.
getPayLaterLabel() : string
getPaymentMode() : string: Get the payment mode ('live' or 'test')
getPaymentProcessorID() : int|null: Get the ID for the in-use payment processor.
getPaymentProcessorMode() : string|null: Get the mode (test or live) of the payment processor.
getPaymentProcessorValue() : mixed: Get the value for a field relating to the in-use payment processor.
getPriceFieldMetaData() : array<string|int, mixed>: Get price field metadata.
getPriceSetID() : int|null: Get the price set ID for the event.
getProfileDefaults() : array<string|int, mixed>: Set default values on form for given contact (or no contact defaults)
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
getState() : object: Getter function for State.
getStateType() : int: Getter function for StateType.
getSubmittedValue() : mixed|null: Get the submitted value, accessing it from whatever form in the flow it is submitted on.
getSubmittedValues() : array<string|int, mixed>: Get values submitted by the user.
getTemplate() : CRM_Core_Smarty
getTemplateFileName() : null|string: Get template file name.
getTemplateVars() : mixed: Get the value/s assigned to the Template Engine (Smarty).
getTitle() : string: Getter function for title.
getUFGroupIDs() : array<string|int, mixed>: Get the active UFGroups (profiles) on this form Many forms load one or more UFGroups (profiles).
getVar() : mixed
isEventFull() : bool: Is the event full already.
isFormInEditMode() : bool: Is the form in edit mode.
isFormInViewMode() : bool: Is the form in view mode.
isLastParticipant() : bool: Check whether call current participant is last one.
isPayLater() : bool
isQuickConfig() : bool: Is the price set quick config.
mainProcess() : mixed: Main process wrapper.
overrideExtraTemplateFileName() : null|string: Override extra template name.
postProcess() : void: Process the form submission.
postProcessHook() : mixed: The postProcess hook is typically called by the framework.
preProcess() : void: Set variables up before form is built.
preventAjaxSubmit() : mixed: Sets form attribute.
processFirstParticipant() : mixed: Set the first participant ID if not set.
processRegistration() : mixed: Process Registration of free event.
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
resetElementValue() : mixed: Reset values for all options those are full.
resetSubmittedValue() : mixed: Reset submitted value.
resetValues() : mixed
set() : mixed: Store the variable with the value in the form scope.
setAction() : mixed: Setter for action.
setContext() : mixed: Set context variable.
setDefaultValues() : void: Set default values for the form. For edit/view mode the default values are retrieved from the database
setIsPayLater() : mixed
setOptions() : mixed: Setter function for options.
setPageTitle() : void: Sets page title based on entity and action.
setPayLaterLabel() : mixed
setPaymentMode() : mixed: Set the payment mode ('live' or 'test')
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.
validatePaymentValues() : bool
addParticipant() : CRM_Event_BAO_Participant: Process the participant.
addPaymentProcessorFieldsToForm() : mixed: Adds in either a set of radio buttons or hidden fields to contain the payment processors on a front end form
alterLineItemsForTemplate() : mixed: Alter line items for template.
assignLineItemsToTemplate() : mixed: Assign line items to the template.
assignPaymentProcessor() : mixed: This if a front end form function for setting the payment processor.
checkValidEvent() : void: Check if event is valid.
formatParamsForPaymentProcessor() : array<string|int, mixed>: Format the fields in $this->_params for the payment processor.
getAmountLevel() : string: Get the amount level for the event payment.
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.
getAvailablePaymentProcessorIDS() : false|array<string|int, mixed>: Get the payment processor IDs available on the form.
getAvailablePaymentProcessors() : array<string|int, mixed>: Get the payment processors that are available on the form.
getContactIDIfAccessingOwnRecord() : int|false: Get the contact if from the url, using the checksum or the cid if it is the logged in user.
getDiscountID() : int|null: Get the discount ID.
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
getIsOptionFull() : bool: Should this option be disabled on the basis of being full.
getOptionFullPriceFieldValues() : array<string|int, mixed>: Get the array of price field value IDs on the form that 'count' as full.
getOrder() : CRM_Financial_BAO_Order
getParticipantCount() : int: Calculate the total participant count as per params.
getPaymentProcessorObject() : CRM_Core_Payment: Get the payment processor object for the submission, returning the manual one for offline payments.
getPaymentProcessorTitle() : string: Get the title of the payment processor to display to the user Note: There is an identical function in CRM_Core_Payment
getPriceSetOptionCount() : array<string|int, mixed>: Calculate total count for each price set options.
getProcessors() : array<string|int, mixed>: Get the configured processors, including the pay later processor.
getSubmittableFields() : array<string|int, string>: Get the fields that can be submitted in this form flow.
getUsedSeatsCount() : int: Get the used seat count for the price value option
handlePreApproval() : mixed: Handle pre approval for processors.
initializeOrder() : void
isFormInViewOrEditMode() : bool: Is the form in view or edit mode.
isMaxValueValidationRequired() : bool: Is there a price field value configured with a maximum value.
isShowPaymentOnConfirm() : bool: Is this event configured to show the payment processors on the confirmation form?
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.
setPriceFieldMetaData() : void: Set price field metadata.
setTranslatedFields() : mixed: Set translated fields.
validateAuthenticatedCheckSumContactID() : int: Verify that a contact ID is authenticated as a valid contact by checksum
validatePriceSet() : array<string|int, mixed>: Validate price set submitted params for price option limit.
formatReferenceFieldAttributes() : mixed
getInfoPageUrl() : string: Get redirect URL to send folks back to event info page is registration not available.
isOptionFullID() : bool: Is the option a 'full ID'.
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
sendMails() : mixed: Send Mail to participants.
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.

$_additionalParticipantIds

Store additional participant ids.


    public
        array<string|int, mixed>
    $_additionalParticipantIds

when there are pre-registered.

$_allowConfirmation

Is participant able to walk registration wizard.


    public
        bool
    $_allowConfirmation

$_allowWaitlist

Is event configured for waitlist.


    public
        bool
    $_allowWaitlist

$_availableRegistrations


    public
        mixed
    $_availableRegistrations

$_bltID

The billing location id for this contribution page.


    public
        int
    $_bltID

$_defaults

The default values for the form.


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

$_eventId

The id of the event we are processing.

access via getEventID


    public
        int
    $_eventId

$_fields

The fields involved in this contribution page.


    public
        array<string|int, mixed>
    $_fields

$_isBillingAddressRequiredForPayLater


    public
        bool
    $_isBillingAddressRequiredForPayLater

$_isEventFull

Is event already full.


    public
        bool
    $_isEventFull

$_lineItem


    public
        mixed
    $_lineItem

$_lineItemParticipantsCount


    public
        mixed
    $_lineItemParticipantsCount

$_mode

The payment mode that we are in ("live" or "test") This should be protected and retrieved via getPaymentMode() but it's accessed all over the place so we have to leave it public for now.


    public
        string
    $_mode

$_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.

$_paymentProcessor

The paymentProcessor attributes for this page.


    public
        array<string|int, mixed>
    $_paymentProcessor

$_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.

$_pcpId


    public
        mixed
    $_pcpId

$_priceSet

Array of fields for the price set.


    public
        array<string|int, mixed>
    $_priceSet

$_priceSetId

Price Set ID, if the new price set method is used


    public
        int
    $_priceSetId
     = \NULL

$_requireApproval

Is participant requires approval.


    public
        bool
    $_requireApproval

$_values

The values for the contribution db object.


    public
        array<string|int, mixed>
    $_values

$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

$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']

$isBackOffice

Is this a back office form


    public
        bool
    $isBackOffice
     = \FALSE

$paymentInstrumentID

Payment instrument iD for the transaction.


    public
        int
    $paymentInstrumentID

This will generally be drawn from the payment processor and is ignored for front end forms.

$submitOnce


    public
        bool
    $submitOnce
     = \FALSE

$urlPath

Url path used to reach this page


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

$_actionButtonName

Name of action button


    protected
        string
    $_actionButtonName

$_name

The name of this form


    protected
        string
    $_name

$_params

The params submitted by the form and computed by the app.


    protected
        array<string|int, mixed>
    $_params

$_participantId

The id of the participant we are processing.


    protected
        int
    $_participantId

$_participantIDS

The array of ids of all the participant we are processing.


    protected
        int
    $_participantIDS
     = \NULL

$_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

$_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.

$isPayLater

Is pay later enabled on this form?


    protected
        bool
    $isPayLater
     = \FALSE

$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).

$payLaterLabel

The label for the pay later pseudoprocessor option.


    protected
        string
    $payLaterLabel

$showPaymentOnConfirm

Should the payment element be shown on the confirm page instead of the first page?


    protected
        bool
    $showPaymentOnConfirm
     = \FALSE

$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

$optionsCount


    private
        array<string|int, mixed>
    $optionsCount

$order


    private
        CRM_Financial_BAO_Order
    $order

__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|string $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|string = 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

assignToTemplate()

Assign the minimal set of variables to the template.


    public
                    assignToTemplate() : 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

buildCustom()

Add the custom fields.


    public
                    buildCustom(int $id, string $name) : mixed

Parameters

$id : int
$name : string

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

Build the form object.


    public
                    buildQuickForm() : void

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

checkTemplateFileExists()

Check template file exists.


    public
                    checkTemplateFileExists([string|null $suffix = NULL ]) : string|null

Parameters

$suffix : string|null = NULL

Return values

string|null —

Template file path, else null

confirmPostProcess()

Handle process after the confirmation of payment by User.


    public
                    confirmPostProcess([int $contactID = NULL ][, CRM_Contribute_BAO_Contribution $contribution = NULL ]) : mixed

Parameters

$contactID : int = NULL
$contribution : CRM_Contribute_BAO_Contribution = NULL

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.

formatPriceSetParams()

Format user submitted price set params.


    public
            static        formatPriceSetParams(self &$form, array<string|int, mixed> $params) : array<string|int, mixed>

Convert price set each param as an array.

Parameters

$form : self
$params : array<string|int, mixed>: An array of user submitted params.

Return values

array<string|int, mixed> —

Formatted price set params.

formRule()

Global form rule.


    public
            static        formRule(array<string|int, mixed> $fields, array<string|int, mixed> $files, self $self) : bool|array<string|int, mixed>

Parameters

$fields : array<string|int, mixed>: The input form values.
$files : array<string|int, mixed>: The uploaded files if any.
$self : self

Return values

bool|array<string|int, mixed> —

true if no errors, else array of errors

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

getContactID()

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


    public
                    getContactID() : int|null

Return values

int|null

getContext()


    public
                    getContext() : string

Return values

string

getCurrency()

Get the currency for the form.


    public
                    getCurrency() : string

Rather historic - might have unneeded stuff

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

getEventID()

Get the selected Event ID.


    public
                    getEventID() : int|null

APIYes

Return values

int|null

getEventValue()

Get the value for a field relating to the event.


    public
                    getEventValue(string $fieldName) : mixed

APIYes

All values returned in apiv4 format. Escaping may be required.

Parameters

$fieldName : string

getFormContext()

Get the form context.


    public
                    getFormContext() : string

This is important for passing to the buildAmount hook as CiviDiscount checks it.

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.

getIsBackOffice()


    public
                    getIsBackOffice() : bool

Return values

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>

getPages()


    public
            static    &    getPages(mixed $additionalParticipant) : array<string|int, mixed>

Parameters

$additionalParticipant : mixed

Return values

array<string|int, mixed>

getParticipantID()

Get id of participant being acted on.


    public
                    getParticipantID() : int|null

APIYes

Return values

int|null

getParticipantValue()

Get a value from the participant being acted on.


    public
                    getParticipantValue(string $fieldName) : mixed

APIYes

All values returned in apiv4 format. Escaping may be required.

Parameters

$fieldName : string

getPayLaterLabel()


    public
                    getPayLaterLabel() : string

Return values

string

getPaymentMode()

Get the payment mode ('live' or 'test')


    public
                    getPaymentMode() : string

Return values

string

getPaymentProcessorID()

Get the ID for the in-use payment processor.


    public
                    getPaymentProcessorID() : int|null

APIYes

Return values

int|null

getPaymentProcessorMode()

Get the mode (test or live) of the payment processor.


    public
                    getPaymentProcessorMode() : string|null

APIYes

Return values

string|null —

test or live

getPaymentProcessorValue()

Get the value for a field relating to the in-use payment processor.


    public
                    getPaymentProcessorValue(string $fieldName) : mixed

APIYes

All values returned in apiv4 format. Escaping may be required.

Parameters

$fieldName : string

getPriceFieldMetaData()

Get price field metadata.


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

APIYes

The returned value is an array of arrays where each array is an id-keyed price field and an 'options' key has been added to that arry for any options.

Return values

array<string|int, mixed>

getPriceSetID()

Get the price set ID for the event.


    public
                    getPriceSetID() : int|null

APIYes

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>

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

getState()

Getter function for State.


    public
                &    getState() : object

Return values

object

getStateType()

Getter function for StateType.


    public
                    getStateType() : int

Return values

int

getSubmittedValue()

Get the submitted value, accessing it from whatever form in the flow it is submitted on.


    public
                    getSubmittedValue(string $fieldName) : mixed|null

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>

getTemplate()


    public
            static    &    getTemplate() : CRM_Core_Smarty

Return values

CRM_Core_Smarty

getTemplateFileName()

Get template file name.


    public
                    getTemplateFileName() : null|string

Return values

null|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

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

isEventFull()

Is the event full already.


    public
                    isEventFull() : bool

APIYes

This function may be calculated by v4 api in time, in which case the function will call that instead but will remain available.

Return values

bool

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

isLastParticipant()

Check whether call current participant is last one.


    public
                    isLastParticipant([bool $isButtonJs = FALSE ]) : bool

Parameters

$isButtonJs : bool = FALSE

Return values

bool —

true on success.

isPayLater()


    public
                    isPayLater() : bool

Return values

bool

isQuickConfig()

Is the price set quick config.


    public
                    isQuickConfig() : bool

Return values

bool

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

overrideExtraTemplateFileName()

Override extra template name.


    public
                    overrideExtraTemplateFileName() : null|string

Return values

null|string

postProcess()

Process the form submission.


    public
                    postProcess() : void

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

Set variables up before form is built.


    public
                    preProcess() : void

preventAjaxSubmit()

Sets form attribute.


    public
                    preventAjaxSubmit() : mixed

processFirstParticipant()

Set the first participant ID if not set.


    public
                    processFirstParticipant(int $participantID) : mixed

CRM-10032.

Parameters

$participantID : int

processRegistration()

Process Registration of free event.


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

Parameters

$params : array<string|int, mixed>: Form values.
$contactID : int = NULL

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

resetElementValue()

Reset values for all options those are full.


    public
            static        resetElementValue(array<string|int, mixed> $optionFullIds, CRM_Core_Form &$form) : mixed

Parameters

$optionFullIds : array<string|int, mixed>
$form : CRM_Core_Form

resetSubmittedValue()

Reset submitted value.


    public
            static        resetSubmittedValue(string $elementName, array<string|int, mixed> $optionIds, CRM_Core_Form &$form) : mixed

Parameters

$elementName : string
$optionIds : array<string|int, mixed>
$form : CRM_Core_Form

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.

setContext()

Set context variable.


    public
                    setContext() : mixed

setDefaultValues()

Set default values for the form. For edit/view mode the default values are retrieved from the database


    public
                    setDefaultValues() : void

setIsPayLater()


    public
                    setIsPayLater(bool $isPayLater) : mixed

Parameters

$isPayLater : bool

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

setPayLaterLabel()


    public
                    setPayLaterLabel(string $payLaterLabel) : mixed

Parameters

$payLaterLabel : string

setPaymentMode()

Set the payment mode ('live' or 'test')


    public
                    setPaymentMode() : mixed

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>

validatePaymentValues()


    public
                    validatePaymentValues(self $self, mixed $fields) : bool

Parameters

$self : self
$fields : mixed

Return values

bool

addParticipant()

Process the participant.


    protected
                    addParticipant(CRM_Core_Form &$form, int $contactID) : CRM_Event_BAO_Participant

Parameters

$form : CRM_Core_Form
$contactID : int

Return values

CRM_Event_BAO_Participant

addPaymentProcessorFieldsToForm()

Adds in either a set of radio buttons or hidden fields to contain the payment processors on a front end form


    protected
                    addPaymentProcessorFieldsToForm() : mixed

alterLineItemsForTemplate()

Alter line items for template.


    protected
                    alterLineItemsForTemplate(array<string|int, mixed> &$tplLineItems) : mixed

This is an early cut of what will ideally eventually be a hooklike call to the CRM_Invoicing_Utils class with a potential end goal of moving this handling to an extension.

Parameters

$tplLineItems : array<string|int, mixed>

assignLineItemsToTemplate()

Assign line items to the template.


    protected
                    assignLineItemsToTemplate(array<string|int, mixed> $tplLineItems) : mixed

Parameters

$tplLineItems : 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

checkValidEvent()

Check if event is valid.


    protected
                    checkValidEvent() : void

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>

getAmountLevel()

Get the amount level for the event payment.


    protected
                    getAmountLevel(array<string|int, mixed> $params, int|null $discountID) : string

The amount level is the string stored on the contribution record that describes the purchase.

Parameters

$params : array<string|int, mixed>
$discountID : int|null

Return values

string

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

getAvailablePaymentProcessorIDS()

Get the payment processor IDs available on the form.


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

Return values

false|array<string|int, mixed>

getAvailablePaymentProcessors()

Get the payment processors that are available on the form.


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

Return values

array<string|int, mixed>

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

getDiscountID()

Get the discount ID.


    protected
                    getDiscountID() : int|null

APIYes

Return values

int|null

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>

getIsOptionFull()

Should this option be disabled on the basis of being full.


    protected
                    getIsOptionFull(array<string|int, mixed> $option) : bool

Note there is another full calculation that is slightly different for ... reasons? When we figure out what those are we can update this.

Parameters

$option : array<string|int, mixed>

Return values

bool

getOptionFullPriceFieldValues()

Get the array of price field value IDs on the form that 'count' as full.


    protected
                    getOptionFullPriceFieldValues(array<string|int, mixed> $field) : array<string|int, mixed>

The criteria for full is slightly confusing as it has an exclusion around select fields if they are the default - or something...

Parameters

$field : array<string|int, mixed>

Return values

array<string|int, mixed>

getOrder()


    protected
                    getOrder() : CRM_Financial_BAO_Order

Return values

CRM_Financial_BAO_Order

getParticipantCount()

Calculate the total participant count as per params.


    protected
                    getParticipantCount(array<string|int, mixed> $params[, bool $skipCurrent = FALSE ]) : int

Parameters

$params : array<string|int, mixed>: User params.
$skipCurrent : bool = FALSE

Return values

int

getPaymentProcessorObject()

Get the payment processor object for the submission, returning the manual one for offline payments.


    protected
                    getPaymentProcessorObject() : CRM_Core_Payment

Return values

CRM_Core_Payment

getPaymentProcessorTitle()

Get the title of the payment processor to display to the user Note: There is an identical function in CRM_Core_Payment


    protected
                    getPaymentProcessorTitle(array<string|int, mixed> $processor) : string

Parameters

$processor : array<string|int, mixed>

Return values

string

getPriceSetOptionCount()

Calculate total count for each price set options.


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

currently selected by user.

Return values

array<string|int, mixed> —

array of each option w/ count total.

getProcessors()

Get the configured processors, including the pay later processor.


    protected
                    getProcessors() : 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>

getUsedSeatsCount()

Get the used seat count for the price value option


    protected
                    getUsedSeatsCount(int $priceFieldValueID) : int

Parameters

$priceFieldValueID : int

Return values

int

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>

initializeOrder()


    protected
                    initializeOrder() : void

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

isMaxValueValidationRequired()

Is there a price field value configured with a maximum value.


    protected
                    isMaxValueValidationRequired() : bool

If so there will need to be a check to ensure the number used does not exceed it.

Return values

bool

isShowPaymentOnConfirm()

Is this event configured to show the payment processors on the confirmation form?


    protected
                    isShowPaymentOnConfirm() : bool

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

setPriceFieldMetaData()

Set price field metadata.


    protected
                    setPriceFieldMetaData(array<string|int, mixed> $metadata) : void

Parameters

$metadata : array<string|int, mixed>

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

validatePriceSet()

Validate price set submitted params for price option limit.


    protected
                    validatePriceSet(array<string|int, mixed> $params, int $priceSetId, array<string|int, mixed> $priceSetDetails) : array<string|int, mixed>

User should select at least one price field option.

Parameters

$params : array<string|int, mixed>
$priceSetId : int
$priceSetDetails : array<string|int, mixed>

Return values

array<string|int, mixed>

formatReferenceFieldAttributes()


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

Parameters

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

getInfoPageUrl()

Get redirect URL to send folks back to event info page is registration not available.


    private
                    getInfoPageUrl() : string

Return values

string

isOptionFullID()

Is the option a 'full ID'.


    private
                    isOptionFullID(array<string|int, mixed> $option, array<string|int, mixed> $field) : bool

It is not clear why this is different to the is_full calculation but it is used in a less narrow context, around validation.

Ideally figure it out & update this doc block.

Parameters

$option : array<string|int, mixed>
$field : array<string|int, mixed>

Return values

bool

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.

sendMails()

Send Mail to participants.


    private
                    sendMails(mixed $params, mixed $registerByID, array<string|int, mixed> $participantCount) : mixed

Parameters

$params : mixed
$registerByID : mixed
$participantCount : array<string|int, mixed>

validateChainSelectFields()

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


    private
                    validateChainSelectFields() : mixed

CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_Registration in package CRM

Table of Contents

Constants

Properties

Methods

Constants

ATTR_SPACING

CB_PREFIX

CB_PREFIX_LEN

CB_PREFIY

CB_PREFIZ

Properties

$_action

$_additionalParticipantIds

$_allowConfirmation

$_allowWaitlist

$_availableRegistrations

$_bltID

$_defaults

$_eventId

$_fields

$_isBillingAddressRequiredForPayLater

$_isEventFull

$_lineItem

$_lineItemParticipantsCount

$_mode

$_options

$_paymentProcessor

$_paymentProcessorIDs

$_pcpId

$_priceSet

$_priceSetId

$_requireApproval

$_values

$ajaxResponse

$controller

$expectedSmartyVariables

$html5Types

$isBackOffice

$paymentInstrumentID

$submitOnce

$urlPath

$_actionButtonName

$_name

$_params

$_participantId

$_participantIDS

$_paymentProcessorID

$_paymentProcessors

$_renderer

$_state

$_template

$_title

$context

$exportedValues

$isPayLater

$optionalQuickFormElements

$payLaterLabel

$showPaymentOnConfirm

$submittableMoneyFields

$unsavedChangesWarn

$authenticatedContactID

$isValidated

$optionsCount

$order

Methods

__construct()

Parameters

Return values

add()

Parameters

Tags

Return values

addAutocomplete()

Parameters

Return values

addAutoSelector()

Parameters

Tags

addButtons()

CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_Registration
in package

CRM