CRM_Core_Form
class CRM_Core_Form extends HTML_QuickForm_Page
Class CRM_Core_Form
Constants
ATTR_SPACING |
Constants for attributes for various form elements attempt to standardize on the number of variations that we use of the below form elements |
CB_PREFIX |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIY |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIZ |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIX_LEN |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
Properties
protected object | $_state | The state object that this form belongs to | |
protected string | $_name | The name of this form | |
protected string | $_title | The title of this form | |
array | $_defaults | The default values for the form. | |
mixed | $_options | (QUASI-PROTECTED) The options passed into this form | |
int | $_action | (QUASI-PROTECTED) The mode of operation for this form | |
protected array | $_paymentProcessors | Available payment processors. | |
array | $_paymentProcessorIDs | Available payment processors (IDS). | |
protected int | $_paymentProcessorID | Default or selected processor id. | |
protected int | $_is_pay_later_enabled | Is pay later enabled for the form. | |
protected object | $_renderer | The renderer used for this form | |
protected array | $_dateFields | An array to hold a list of datefields on the form so that they can be converted to ISO in a consistent manner | |
static protected CRM_Core_Smarty | $_template | Cache the smarty template for efficiency reasons | |
protected | $unsavedChangesWarn | Indicate if this form should warn users of unsaved changes | |
array | $ajaxResponse | What to return to the client if in ajax mode (snippet=json) | |
array | $urlPath | Url path used to reach this page | |
CRM_Core_Controller | $controller | ||
static array | $html5Types | Extra input types we support via the "add" method |
Methods
Constructor for the basic form page.
Add one or more css classes to the form.
Register all the standard rules that most forms potentially use.
Simple easy to use wrapper around addElement.
Preprocess form.
Called after the form is validated.
Main process wrapper.
The postProcess hook is typically called by the framework.
This virtual function is used to build the form.
This virtual function is used to set the default values of various form elements.
This is a virtual function that adds group and global rules to the form.
Performs the server side validation.
Core function that builds the form.
Add default Next / Back buttons.
Getter function for Name.
Getter function for State.
Getter function for StateType.
Getter function for title.
Setter function for title.
Assign billing type id to bltID.
This if a front end form function for setting the payment processor.
Format the fields for the payment processor.
Handle Payment Processor switching for contribution and event registration forms.
Handle pre approval for processors.
Setter function for options.
Render form and return contents.
Getter function for renderer.
Use the form name to create the tpl file name.
A wrapper for getTemplateFileName.
Default extra tpl file basically just replaces .tpl with .extra.tpl.
Store the variable with the value in the form scope.
Get the variable from the form scope.
Getter for action.
Setter for action.
Assign value to name in template.
Assign value to name in template by reference.
Appends values to template variables.
Returns an array containing template variables.
No description
No description
No description
No description
Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit
No description
Classes extending CRM_Core_Form should implement this method.
Classes extending CRM_Core_Form should implement this method.
Adds a select based on field metadata.
Adds a field based on metadata.
Add a widget for selecting/editing/creating/copying a profile form
No description
No description
No description
No description
No description
No description
Add date.
Function that will add date and time.
Add a currency and money element to the form.
Add currency element to the form.
Create a single or multiple entity ref field.
Convert all date fields within the params to mysql date ready for the BAO layer. In this case fields are checked against the $_datefields defined for the form and if time is defined it is incorporated
No description
Function that can be defined in Form to override or.
Helper function to verify that required fields have been filled.
Get contact if for a form object. Prioritise - cid in URL if 0 (on behalf on someoneelse) (@todo consider setting a variable if onbehalf for clarity of downstream 'if's - logged in user id if it matches the one in the cid in the URL - contact id validated from a checksum from a checksum - cid from the url if the caller has ACL permission to view - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)
Get the contact id that the form is being submitted for.
Get the contact id of the logged in user.
Add autoselector field -if user has permission to view contacts If adding this to a form you also need to add to the tpl e.g
No description
Add the options appropriate to cid = zero - ie. autocomplete
Set default values on form for given contact (or no contact defaults)
Sets form attribute.
Sets form attribute.
Sets page title based on entity and action.
Create a chain-select target field. All settings are optional; the defaults usually work.
Add actions menu to results form.
Assign billing name to the template.
Details
at line 239
CRM_Core_Form
__construct(object $state = NULL, const|enum|int $action = CRM_Core_Action::NONE, string $method = 'post', string $name = NULL)
Constructor for the basic form page.
We should not use QuickForm directly. This class provides a lot of default convenient functions, rules and buttons
at line 279
addClass(string $className)
Add one or more css classes to the form.
at line 287
registerRules()
Register all the standard rules that most forms potentially use.
at line 340
HTML_QuickForm_Element
add(string $type, string $name, string $label = '', string|array $attributes = '', bool $required = FALSE, array $extra = NULL)
Simple easy to use wrapper around addElement.
Deal with simple validation rules.
at line 422
preProcess()
Preprocess form.
This is called before buildForm. Any pre-processing that needs to be done for buildForm should be done here.
This is a virtual function and should be redefined if needed.
at line 434
postProcess()
Called after the form is validated.
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
at line 446
mainProcess(bool $allowAjax = TRUE)
Main process wrapper.
Implemented so that we can call all the hook functions.
at line 473
postProcessHook()
The postProcess hook is typically called by the framework.
However in a few cases, the form exits or redirects early in which case it needs to call this function so other modules can do the needful Calling this function directly should be avoided if possible. In general a better way is to do setUserContext so the framework does the redirect
at line 483
buildQuickForm()
This virtual function is used to build the form.
It replaces the buildForm associated with QuickForm_Page. This allows us to put preProcess in front of the actual form building routine
at line 492
array|NULL
setDefaultValues()
This virtual function is used to set the default values of various form elements.
at line 502
addRules()
This is a virtual function that adds group and global rules to the form.
Keeping it distinct from the form to keep code small and localized in the form building code
at line 512
bool
validate()
Performs the server side validation.
at line 540
buildForm()
Core function that builds the form.
We redefine this function here and expect all CRM forms to build their form in the function buildQuickForm.
at line 599
addButtons(array $params)
Add default Next / Back buttons.
at line 668
string
getName()
Getter function for Name.
at line 677
object
getState()
Getter function for State.
at line 686
int
getStateType()
Getter function for StateType.
at line 697
string
getTitle()
Getter function for title.
Should be over-ridden by derived class.
at line 707
setTitle(string $title)
Setter function for title.
at line 716
assignBillingType()
Assign billing type id to bltID.
at line 731
protected
assignPaymentProcessor(bool $is_pay_later_enabled)
This if a front end form function for setting the payment processor.
It would be good to sync it with the back-end function on abstractEditPayment & use one everywhere.
at line 769
protected array
formatParamsForPaymentProcessor(array $fields)
Format the fields for the payment processor.
In order to pass fields to the payment processor in a consistent way we add some renamed parameters.
at line 807
protected
preProcessPaymentOptions()
Handle Payment Processor switching for contribution and event registration forms.
This function is shared between contribution & event forms & this is their common class.
However, this should be seen as an in-progress refactor, the end goal being to also align the backoffice forms that action payments.
This function overlaps assignPaymentProcessor, in a bad way.
at line 860
protected
handlePreApproval(array $params)
Handle pre approval for processors.
This fits with the flow where a pre-approval is done and then confirmed in the next stage when confirm is hit.
This function is shared between contribution & event forms & this is their common class.
However, this should be seen as an in-progress refactor, the end goal being to also align the backoffice forms that action payments.
at line 885
setOptions(mixed $options)
Setter function for options.
at line 894
string
toSmarty()
Render form and return contents.
at line 912
object
getRenderer()
Getter function for renderer.
If renderer is not set create one and initialize it.
at line 924
string
getTemplateFileName()
Use the form name to create the tpl file name.
at line 947
getHookedTemplateFileName()
A wrapper for getTemplateFileName.
This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.
at line 960
string
overrideExtraTemplateFileName()
Default extra tpl file basically just replaces .tpl with .extra.tpl.
i.e. we do not override.
at line 974
error(string $message, int $code = NULL, CRM_Core_DAO $dao = NULL)
Error reporting mechanism.
at line 992
set(string $name, mixed $value)
Store the variable with the value in the form scope.
at line 1004
mixed
get(string $name)
Get the variable from the form scope.
at line 1013
int
getAction()
Getter for action.
at line 1023
setAction(int $action)
Setter for action.
at line 1035
assign(string $var, mixed $value = NULL)
Assign value to name in template.
at line 1047
assign_by_ref(string $var, mixed $value)
Assign value to name in template by reference.
at line 1059
append(array|string $tpl_var, mixed $value = NULL, bool $merge = FALSE)
Appends values to template variables.
at line 1070
array
get_template_vars(string $name = NULL)
Returns an array containing template variables.
at line 1084
HTML_QuickForm_group
addRadio(string $name, $title, $values, array $attributes = array(), null $separator = NULL, bool $required = FALSE)
at line 1110
addYesNo(int $id, $title, bool $allowClear = FALSE, null $required = NULL, array $attributes = array())
at line 1136
addCheckBox(int $id, $title, $values, null $other = NULL, null $attributes = NULL, null $required = NULL, null $javascriptMethod = NULL, string $separator = '<br />', bool $flipValues = FALSE)
at line 1179
resetValues()
at line 1195
addDefaultButtons(string $title, string $nextType = 'next', string $backType = 'back', bool|string $submitOnce = FALSE)
Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit
at line 1226
addDateRange(string $name, string $from = '_from', string $to = '_to', string $label = 'From:', string $dateFormat = 'searchDate', bool $required = FALSE, bool $displayTime = FALSE)
at line 1259
getDefaultEntity()
Classes extending CRM_Core_Form should implement this method.
at line 1269
getDefaultContext()
Classes extending CRM_Core_Form should implement this method.
TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation.
at line 1291
HTML_QuickForm_Element
addSelect($name, array $props = array(), bool $required = FALSE)
Adds a select based on field metadata.
TODO: This could be even more generic and widget type (select in this case) could also be read from metadata Perhaps a method like $form->bind($name) which would look up all metadata for named field
at line 1372
HTML_QuickForm_Element
addField($name, array $props = array(), bool $required = FALSE, bool $legacyDate = TRUE)
Adds a field based on metadata.
at line 1553
addProfileSelector(string $name, string $label, string $allowCoreTypes, string $allowSubTypes, array $entities, bool $default = FALSE, string $usedFor = NULL)
Add a widget for selecting/editing/creating/copying a profile form
at line 1572
null
getRootTitle()
at line 1579
string
getCompleteTitle()
at line 1586
static CRM_Core_Smarty
getTemplate()
at line 1593
addUploadElement($elementName)
at line 1623
null
getVar($name)
at line 1631
setVar($name, $value)
at line 1650
addDate(string $name, string $label, bool $required = FALSE, array $attributes = NULL)
deprecated
deprecated
Add date.
at line 1739
addDateTime(string $name, string $label, bool $required = FALSE, null $attributes = NULL)
deprecated
deprecated
Function that will add date and time.
at line 1765
HTML_QuickForm_Element
addMoney(string $name, string $label, bool $required = FALSE, null $attributes = NULL, bool $addCurrency = TRUE, string $currencyName = 'currency', null $defaultCurrency = NULL, bool $freezeCurrency = FALSE)
Add a currency and money element to the form.
at line 1795
addCurrency(string $name = 'currency', null $label = NULL, bool $required = TRUE, string $defaultCurrency = NULL, bool $freezeCurrency = FALSE, bool $setDefaultCurrency = TRUE)
Add currency element to the form.
at line 1845
HTML_QuickForm_Element
addEntityRef(string $name, string $label = '', array $props = array(), bool $required = FALSE)
Create a single or multiple entity ref field.
at line 1894
convertDateFieldsToMySQL(array $params)
Convert all date fields within the params to mysql date ready for the BAO layer. In this case fields are checked against the $_datefields defined for the form and if time is defined it is incorporated
at line 1914
removeFileRequiredRules($elementName)
at line 1932
cancelAction()
Function that can be defined in Form to override or.
perform specific action on cancel action
at line 1944
static
validateMandatoryFields(array $fields, array $values, array $errors)
Helper function to verify that required fields have been filled.
Typically called within the scope of a FormRule function
at line 1963
protected NULL|int
setContactID()
Get contact if for a form object. Prioritise - cid in URL if 0 (on behalf on someoneelse) (@todo consider setting a variable if onbehalf for clarity of downstream 'if's - logged in user id if it matches the one in the cid in the URL - contact id validated from a checksum from a checksum - cid from the url if the caller has ACL permission to view - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)
at line 2018
int|NULL
getContactID()
Get the contact id that the form is being submitted for.
at line 2025
getLoggedInUserContactID()
Get the contact id of the logged in user.
at line 2054
addAutoSelector(array $profiles = array(), array $autoCompleteField = array())
Add autoselector field -if user has permission to view contacts If adding this to a form you also need to add to the tpl e.g
{if !empty($selectable)}
{/if}
at line 2079
canUseAjaxContactLookups()
at line 2097
addCIDZeroOptions($onlinePaymentProcessorEnabled)
Add the options appropriate to cid = zero - ie. autocomplete
at line 2123
array
getProfileDefaults(mixed $profile_id = 'Billing', int $contactID = NULL)
Set default values on form for given contact (or no contact defaults)
at line 2142
preventAjaxSubmit()
Sets form attribute.
at line 2150
allowAjaxSubmit()
Sets form attribute.
at line 2158
setPageTitle(string $entityLabel)
Sets page title based on entity and action.
at line 2187
HTML_QuickForm_Element
addChainSelect(string $elementName, array $settings = array())
Create a chain-select target field. All settings are optional; the defaults usually work.
at line 2222
addTaskMenu(array $tasks)
Add actions menu to results form.
at line 2337
string
assignBillingName(array $params = array())
Assign billing name to the template.