array('default' => 'now'),
* );
*/
protected $_dateFields = [];
/**
* Cache the smarty template for efficiency reasons
*
* @var CRM_Core_Smarty
*/
static protected $_template;
/**
* Indicate if this form should warn users of unsaved changes
* @var bool
*/
protected $unsavedChangesWarn;
/**
* What to return to the client if in ajax mode (snippet=json)
*
* @var array
*/
public $ajaxResponse = [];
/**
* Url path used to reach this page
*
* @var array
*/
public $urlPath = [];
/**
* Context of the form being loaded.
*
* 'event' or null
*
* @var string
*/
protected $context;
/**
* @var bool
*/
public $submitOnce = FALSE;
/**
* Values submitted by the user.
*
* 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.
*
* @var array
*/
protected $exportedValues = [];
/**
* @return string
*/
public function getContext() {
return $this->context;
}
/**
* Set context variable.
*/
public function setContext() {
$this->context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
}
/**
* @var CRM_Core_Controller
*/
public $controller;
/**
* Constants for attributes for various form elements
* attempt to standardize on the number of variations that we
* use of the below form elements
*
* @var string
*/
const ATTR_SPACING = ' ';
/**
* 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
*
* @var string|int
*/
const CB_PREFIX = 'mark_x_', CB_PREFIY = 'mark_y_', CB_PREFIZ = 'mark_z_', CB_PREFIX_LEN = 7;
/**
* @var array
* @internal to keep track of chain-select fields
*/
private $_chainSelectFields = [];
/**
* Extra input types we support via the "add" method
* @var array
*/
public static $html5Types = [
'number',
'url',
'email',
'color',
];
/**
* Variables smarty expects to have set.
*
* 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.
*
* @var string[]
*/
public $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',
];
/**
* Constructor for the basic form page.
*
* We should not use QuickForm directly. This class provides a lot
* of default convenient functions, rules and buttons
*
* @param object $state
* State associated with this form.
* @param int $action The mode the form is operating in (None/Create/View/Update/Delete)
* @param string $method
* The type of http method used (GET/POST).
* @param string $name
* The name of the form if different from class name.
*
* @return \CRM_Core_Form
*/
public function __construct(
$state = NULL,
$action = CRM_Core_Action::NONE,
$method = 'post',
$name = NULL
) {
if ($name) {
$this->_name = $name;
}
else {
// CRM-15153 - FIXME this name translates to a DOM id and is not always unique!
$this->_name = CRM_Utils_String::getClassName(CRM_Utils_System::getClassName($this));
}
parent::__construct($this->_name, $method);
$this->_state =& $state;
if ($this->_state) {
$this->_state->setName($this->_name);
}
$this->_action = (int) $action;
$this->registerRules();
// let the constructor initialize this, should happen only once
if (!isset(self::$_template)) {
self::$_template = CRM_Core_Smarty::singleton();
}
// Workaround for CRM-15153 - give each form a reasonably unique css class
$this->addClass(CRM_Utils_System::getClassName($this));
$this->assign('snippet', CRM_Utils_Array::value('snippet', $_GET));
$this->setTranslatedFields();
}
/**
* Set translated fields.
*
* 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.
*/
protected function setTranslatedFields() {}
/**
* Add one or more css classes to the form.
*
* @param string $className
*/
public function addClass($className) {
$classes = $this->getAttribute('class');
$this->setAttribute('class', ($classes ? "$classes " : '') . $className);
}
/**
* Register all the standard rules that most forms potentially use.
*/
public function registerRules() {
static $rules = [
'title',
'longTitle',
'variable',
'qfVariable',
'phone',
'integer',
'query',
'url',
'wikiURL',
'domain',
'numberOfDigit',
'date',
'currentDate',
'asciiFile',
'utf8File',
'objectExists',
'optionExists',
'postalCode',
'money',
'positiveInteger',
'fileExists',
'settingPath',
'autocomplete',
'validContact',
'email',
];
foreach ($rules as $rule) {
$this->registerRule($rule, 'callback', $rule, 'CRM_Utils_Rule');
}
}
/**
* Simple easy to use wrapper around addElement.
*
* Deal with simple validation rules.
*
* @param string $type
* @param string $name
* @param string $label
* @param array $attributes (options for select elements)
* @param bool $required
* @param array $extra
* (attributes for select elements).
* For datepicker elements this is consistent with the data
* from CRM_Utils_Date::getDatePickerExtra
*
* @return HTML_QuickForm_Element
* Could be an error object
*
* @throws \CRM_Core_Exception
*/
public function &add(
$type, $name, $label = '',
$attributes = NULL, $required = FALSE, $extra = NULL
) {
if ($type === 'radio') {
CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_Form::addRadio');
}
if ($type !== 'static' && $attributes && !is_array($attributes)) {
// The $attributes param used to allow for strings and would default to an
// empty string. However, now that the variable is heavily manipulated,
// we should expect it to always be an array.
CRM_Core_Error::deprecatedWarning('Attributes passed to CRM_Core_Form::add() are not an array.');
}
// Fudge some extra types that quickform doesn't support
$inputType = $type;
if ($type == 'wysiwyg' || in_array($type, self::$html5Types)) {
$attributes = ($attributes ? $attributes : []) + ['class' => ''];
$attributes['class'] = ltrim($attributes['class'] . " crm-form-$type");
if ($type == 'wysiwyg' && isset($attributes['preset'])) {
$attributes['data-preset'] = $attributes['preset'];
unset($attributes['preset']);
}
$type = $type == 'wysiwyg' ? 'textarea' : 'text';
}
// Like select but accepts rich array data (with nesting, colors, icons, etc) as option list.
if ($inputType == 'select2') {
$type = 'text';
$options = $attributes;
$attributes = ($extra ? $extra : []) + ['class' => ''];
$attributes['class'] = ltrim($attributes['class'] . " crm-select2 crm-form-select2");
$attributes['data-select-params'] = json_encode(['data' => $options, 'multiple' => !empty($attributes['multiple'])]);
unset($attributes['multiple']);
$extra = NULL;
}
// @see https://docs.civicrm.org/dev/en/latest/framework/ui/#date-picker
if ($type === 'datepicker') {
$attributes = $attributes ?: [];
if (!empty($attributes['formatType'])) {
$dateAttributes = CRM_Core_SelectValues::date($attributes['formatType'], NULL, NULL, NULL, 'Input');
if (empty($extra['minDate']) && !empty($dateAttributes['minYear'])) {
$extra['minDate'] = $dateAttributes['minYear'] . '-01-01';
}
if (empty($extra['maxDate']) && !empty($dateAttributes['minYear'])) {
$extra['maxDate'] = $dateAttributes['maxYear'] . '-12-31';
}
}
// Support minDate/maxDate properties
if (isset($extra['minDate'])) {
$extra['minDate'] = date('Y-m-d', strtotime($extra['minDate']));
}
if (isset($extra['maxDate'])) {
$extra['maxDate'] = date('Y-m-d', strtotime($extra['maxDate']));
}
$attributes['data-crm-datepicker'] = json_encode((array) $extra);
if (!empty($attributes['aria-label']) || $label) {
$attributes['aria-label'] = $attributes['aria-label'] ?? $label;
}
$type = "text";
}
if ($type === 'select' && is_array($extra)) {
// Normalize this property
if (!empty($extra['multiple'])) {
$extra['multiple'] = 'multiple';
}
else {
unset($extra['multiple']);
}
unset($extra['size'], $extra['maxlength']);
// Add placeholder option for select
if (isset($extra['placeholder'])) {
if ($extra['placeholder'] === TRUE) {
$extra['placeholder'] = ts('- select %1 -', [1 => $label]);
}
if (($extra['placeholder'] || $extra['placeholder'] === '') && empty($extra['multiple']) && is_array($attributes) && !isset($attributes[''])) {
$attributes = ['' => $extra['placeholder']] + $attributes;
}
}
}
$optionContext = NULL;
if (!empty($extra['option_context'])) {
$optionContext = $extra['option_context'];
unset($extra['option_context']);
}
$element = $this->addElement($type, $name, CRM_Utils_String::purifyHTML($label), $attributes, $extra);
if (HTML_QuickForm::isError($element)) {
CRM_Core_Error::statusBounce(HTML_QuickForm::errorMessage($element));
}
if ($inputType == 'color') {
$this->addRule($name, ts('%1 must contain a color value e.g. #ffffff.', [1 => $label]), 'regex', '/#[0-9a-fA-F]{6}/');
}
if ($required) {
if ($type == 'file') {
$error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'uploadedfile');
}
else {
$error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'required');
}
if (HTML_QuickForm::isError($error)) {
CRM_Core_Error::statusBounce(HTML_QuickForm::errorMessage($element));
}
}
// Add context for the editing of option groups
if ($optionContext) {
$element->setAttribute('data-option-edit-context', json_encode($optionContext));
}
return $element;
}
/**
* 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.
*/
public function preProcess() {
}
/**
* 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
*/
public function postProcess() {
}
/**
* Main process wrapper.
*
* Implemented so that we can call all the hook functions.
*
* @param bool $allowAjax
* 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
*/
public function mainProcess($allowAjax = TRUE) {
$this->postProcess();
$this->postProcessHook();
// Respond with JSON if in AJAX context (also support legacy value '6')
if ($allowAjax && !empty($_REQUEST['snippet']) && in_array($_REQUEST['snippet'], [
CRM_Core_Smarty::PRINT_JSON,
6,
])) {
$this->ajaxResponse['buttonName'] = str_replace('_qf_' . $this->getAttribute('id') . '_', '', $this->controller->getButtonName());
$this->ajaxResponse['action'] = $this->_action;
if (isset($this->_id) || isset($this->id)) {
$this->ajaxResponse['id'] = $this->id ?? $this->_id;
}
CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse);
}
}
/**
* 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
*/
public function postProcessHook() {
CRM_Utils_Hook::postProcess(get_class($this), $this);
}
/**
* 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
*/
public function buildQuickForm() {
}
/**
* This virtual function is used to set the default values of various form elements.
*
* @return array
* reference to the array of default values
*/
public function setDefaultValues() {
return [];
}
/**
* 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
*/
public function addRules() {
}
/**
* Performs the server side validation.
* @since 1.0
* @return bool
* true if no error found
* @throws HTML_QuickForm_Error
*/
public function validate() {
$error = parent::validate();
$this->validateChainSelectFields();
$hookErrors = [];
CRM_Utils_Hook::validateForm(
get_class($this),
$this->_submitValues,
$this->_submitFiles,
$this,
$hookErrors
);
if (!empty($hookErrors)) {
$this->_errors += $hookErrors;
}
return (0 == count($this->_errors));
}
/**
* Core function that builds the form.
*
* We redefine this function here and expect all CRM forms to build their form in the function
* buildQuickForm.
*/
public function buildForm() {
$this->_formBuilt = TRUE;
$this->preProcess();
CRM_Utils_Hook::preProcess(get_class($this), $this);
$this->assign('translatePermission', CRM_Core_Permission::check('translate CiviCRM'));
if (
$this->controller->_key &&
$this->controller->_generateQFKey
) {
$this->addElement('hidden', 'qfKey', $this->controller->_key);
$this->assign('qfKey', $this->controller->_key);
}
// _generateQFKey suppresses the qfKey generation on form snippets that
// are part of other forms, hence we use that to avoid adding entryURL
if ($this->controller->_generateQFKey && $this->controller->_entryURL) {
$this->addElement('hidden', 'entryURL', $this->controller->_entryURL);
}
$this->buildQuickForm();
$defaults = $this->setDefaultValues();
unset($defaults['qfKey']);
if (!empty($defaults)) {
$this->setDefaults($defaults);
}
// call the form hook
// also call the hook function so any modules can set their own custom defaults
// the user can do both the form and set default values with this hook
CRM_Utils_Hook::buildForm(get_class($this), $this);
$this->addRules();
//Set html data-attribute to enable warning user of unsaved changes
if ($this->unsavedChangesWarn === TRUE
|| (!isset($this->unsavedChangesWarn)
&& ($this->_action & CRM_Core_Action::ADD || $this->_action & CRM_Core_Action::UPDATE)
)
) {
$this->setAttribute('data-warn-changes', 'true');
}
if ($this->submitOnce) {
$this->setAttribute('data-submit-once', 'true');
}
// Smarty $_template is a static var which persists between tests, so
// if something calls clearTemplateVars(), the static still exists but
// our ensured variables get blown away, so we need to set them even if
// it's already been initialized.
self::$_template->ensureVariablesAreAssigned($this->expectedSmartyVariables);
self::$_template->addExpectedTabHeaderKeys();
}
/**
* Add default Next / Back buttons.
*
* @param array $params
* 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.
*/
public function addButtons($params) {
$prevnext = $spacing = [];
foreach ($params as $button) {
if (!empty($button['submitOnce'])) {
$this->submitOnce = TRUE;
}
$attrs = ['class' => 'crm-form-submit'] + (array) CRM_Utils_Array::value('js', $button);
// A lot of forms use the hacky method of looking at
// `$params['button name']` (dating back to them being inputs with a
// "value" of the button label) rather than looking at
// `$this->controller->getButtonName()`. It makes sense to give buttons a
// value by default as a precaution.
$attrs['value'] = 1;
if (!empty($button['class'])) {
$attrs['class'] .= ' ' . $button['class'];
}
if (!empty($button['isDefault'])) {
$attrs['class'] .= ' default';
}
if (in_array($button['type'], ['upload', 'next', 'submit', 'done', 'process', 'refresh'])) {
$attrs['class'] .= ' validate';
$defaultIcon = 'fa-check';
}
else {
$attrs['class'] .= ' cancel';
$defaultIcon = $button['type'] == 'back' ? 'fa-chevron-left' : 'fa-times';
}
if ($button['type'] === 'reset') {
$attrs['type'] = 'reset';
$prevnext[] = $this->createElement('xbutton', 'reset', $button['name'], $attrs);
}
else {
if (!empty($button['subName'])) {
if ($button['subName'] == 'new') {
$defaultIcon = 'fa-plus-circle';
}
if ($button['subName'] == 'done') {
$defaultIcon = 'fa-check-circle';
}
if ($button['subName'] == 'next') {
$defaultIcon = 'fa-chevron-right';
}
}
if (in_array($button['type'], ['next', 'upload', 'done']) && $button['name'] === ts('Save')) {
$attrs['accesskey'] = 'S';
}
$buttonContents = CRM_Core_Page::crmIcon($button['icon'] ?? $defaultIcon) . ' ' . $button['name'];
$buttonName = $this->getButtonName($button['type'], CRM_Utils_Array::value('subName', $button));
$attrs['class'] .= " crm-button crm-button-type-{$button['type']} crm-button{$buttonName}";
$attrs['type'] = 'submit';
$prevnext[] = $this->createElement('xbutton', $buttonName, $buttonContents, $attrs);
}
if (!empty($button['isDefault'])) {
$this->setDefaultAction($button['type']);
}
// if button type is upload, set the enctype
if ($button['type'] == 'upload') {
$this->updateAttributes(['enctype' => 'multipart/form-data']);
$this->setMaxFileSize();
}
// hack - addGroup uses an array to express variable spacing, read from the last element
$spacing[] = CRM_Utils_Array::value('spacing', $button, self::ATTR_SPACING);
}
$this->addGroup($prevnext, 'buttons', '', $spacing, FALSE);
}
/**
* Getter function for Name.
*
* @return string
*/
public function getName() {
return $this->_name;
}
/**
* Getter function for State.
*
* @return object
*/
public function &getState() {
return $this->_state;
}
/**
* Getter function for StateType.
*
* @return int
*/
public function getStateType() {
return $this->_state->getType();
}
/**
* Getter function for title.
*
* Should be over-ridden by derived class.
*
* @return string
*/
public function getTitle() {
return $this->_title ? $this->_title : ts('ERROR: Title is not Set');
}
/**
* Setter function for title.
*
* @param string $title
* The title of the form.
*/
public function setTitle($title) {
$this->_title = $title;
CRM_Utils_System::setTitle($title);
}
/**
* Assign billing type id to bltID.
*
* @throws CRM_Core_Exception
*/
public function assignBillingType() {
$this->_bltID = CRM_Core_BAO_LocationType::getBilling();
$this->set('bltID', $this->_bltID);
$this->assign('bltID', $this->_bltID);
}
/**
* @return int
*/
public function getPaymentProcessorID(): int {
return (int) $this->_paymentProcessorID;
}
/**
* 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.
*
* @param bool $isPayLaterEnabled
*
* @throws \CRM_Core_Exception
*/
protected function assignPaymentProcessor($isPayLaterEnabled) {
$this->_paymentProcessors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors([ucfirst($this->_mode) . 'Mode'], $this->_paymentProcessorIDs);
if ($isPayLaterEnabled) {
$this->_paymentProcessors[0] = CRM_Financial_BAO_PaymentProcessor::getPayment(0);
}
if (!empty($this->_paymentProcessors)) {
foreach ($this->_paymentProcessors as $paymentProcessorID => $paymentProcessorDetail) {
if (empty($this->_paymentProcessor) && $paymentProcessorDetail['is_default'] == 1 || (count($this->_paymentProcessors) == 1)
) {
$this->_paymentProcessor = $paymentProcessorDetail;
$this->assign('paymentProcessor', $this->_paymentProcessor);
// Setting this is a bit of a legacy overhang.
$this->_paymentObject = $paymentProcessorDetail['object'];
}
}
// It's not clear why we set this on the form.
$this->set('paymentProcessors', $this->_paymentProcessors);
}
}
/**
* Assign an array of variables to the form/tpl
*
* @param array $values Array of [key => value] to assign to the form
* @param array $keys Array of keys to assign from the values array
*/
public function assignVariables($values, $keys) {
foreach ($keys as $key) {
$this->assign($key, $values[$key] ?? NULL);
}
}
/**
* Format the fields in $this->_params for the payment processor.
*
* In order to pass fields to the payment processor in a consistent way we add some renamed
* parameters.
*
* @param array $fields
*
* @return array
*/
protected function formatParamsForPaymentProcessor($fields) {
$this->_params = $this->prepareParamsForPaymentProcessor($this->_params);
$fields = array_merge($fields, ['first_name' => 1, 'middle_name' => 1, 'last_name' => 1]);
return $fields;
}
/**
* Format the fields in $params for the payment processor.
*
* In order to pass fields to the payment processor in a consistent way we add some renamed
* parameters.
*
* @param array $params Payment processor params
*
* @return array $params
*/
protected function prepareParamsForPaymentProcessor($params) {
// also add location name to the array
$params["address_name-{$this->_bltID}"] = CRM_Utils_Array::value('billing_first_name', $params) . ' ' . CRM_Utils_Array::value('billing_middle_name', $params) . ' ' . CRM_Utils_Array::value('billing_last_name', $params);
$params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
// Add additional parameters that the payment processors are used to receiving.
if (!empty($params["billing_state_province_id-{$this->_bltID}"])) {
$params['state_province'] = $params["state_province-{$this->_bltID}"] = $params["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($params["billing_state_province_id-{$this->_bltID}"]);
}
if (!empty($params["billing_country_id-{$this->_bltID}"])) {
$params['country'] = $params["country-{$this->_bltID}"] = $params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($params["billing_country_id-{$this->_bltID}"]);
}
[$hasAddressField, $addressParams] = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($params, $this->_bltID);
if ($hasAddressField) {
$params = array_merge($params, $addressParams);
}
// How does this relate to similar code in CRM_Contact_BAO_Contact::addBillingNameFieldsIfOtherwiseNotSet()?
$nameFields = ['first_name', 'middle_name', 'last_name'];
foreach ($nameFields as $name) {
if (array_key_exists("billing_$name", $params)) {
$params[$name] = $params["billing_{$name}"];
$params['preserveDBName'] = TRUE;
}
}
// For legacy reasons we set these creditcard expiry fields if present
CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($params);
// Assign IP address parameter
$params['ip_address'] = CRM_Utils_System::ipAddress();
return $params;
}
/**
* 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.
*/
protected function preProcessPaymentOptions() {
$this->_paymentProcessorID = NULL;
if ($this->_paymentProcessors) {
if (!empty($this->_submitValues)) {
$this->_paymentProcessorID = $this->_submitValues['payment_processor_id'] ?? NULL;
$this->_paymentProcessor = $this->_paymentProcessors[$this->_paymentProcessorID] ?? NULL;
$this->set('type', $this->_paymentProcessorID);
$this->set('mode', $this->_mode);
$this->set('paymentProcessor', $this->_paymentProcessor);
}
// Set default payment processor
else {
foreach ($this->_paymentProcessors as $values) {
if (!empty($values['is_default']) || count($this->_paymentProcessors) == 1) {
$this->_paymentProcessorID = $values['id'];
break;
}
}
}
if ($this->_paymentProcessorID
|| (isset($this->_submitValues['payment_processor_id']) && $this->_submitValues['payment_processor_id'] == 0)
) {
CRM_Core_Payment_ProcessorForm::preProcess($this);
}
else {
$this->_paymentProcessor = [];
}
}
// We save the fact that the profile 'billing' is required on the payment form.
// Currently pay-later is the only 'processor' that takes notice of this - but ideally
// 1) it would be possible to select the minimum_billing_profile_id for the contribution form
// 2) that profile_id would be set on the payment processor
// 3) the payment processor would return a billing form that combines these user-configured
// minimums with the payment processor minimums. This would lead to fields like 'postal_code'
// only being on the form if either the admin has configured it as wanted or the processor
// requires it.
$this->assign('billing_profile_id', (!empty($this->_values['is_billing_required']) ? 'billing' : ''));
}
/**
* 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.
*
* @param array $params
*/
protected function handlePreApproval(&$params) {
try {
$payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
$params['component'] = $params['component'] ?? 'contribute';
$result = $payment->doPreApproval($params);
if (empty($result)) {
// This could happen, for example, when paypal looks at the button value & decides it is not paypal express.
return;
}
}
catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
CRM_Core_Error::statusBounce(ts('Payment approval failed with message :') . $e->getMessage(), $payment->getCancelUrl($params['qfKey'], CRM_Utils_Array::value('participant_id', $params)));
}
$this->set('pre_approval_parameters', $result['pre_approval_parameters']);
if (!empty($result['redirect_url'])) {
CRM_Utils_System::redirect($result['redirect_url']);
}
}
/**
* Setter function for options.
*
* @param mixed $options
*/
public function setOptions($options) {
$this->_options = $options;
}
/**
* Quick form elements which are conditionally added to the form.
*
* 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).
*
* @var array
*/
protected $optionalQuickFormElements = [];
/**
* Add an optional element to the optional elements array.
*
* These elements are assigned as empty (null) variables if
* there is no real field - allowing smarty to use them without
* notices.
*
* @param string $elementName
*/
public function addOptionalQuickFormElement(string $elementName): void {
$this->optionalQuickFormElements[] = $elementName;
}
/**
* Get any quick-form elements that may not be present in the form.
*
* 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 array
*/
public function getOptionalQuickFormElements(): array {
return $this->optionalQuickFormElements;
}
/**
* Add an expected smarty variable to the array.
*
* @param string $elementName
*/
public function addExpectedSmartyVariable(string $elementName): void {
$this->expectedSmartyVariables[] = $elementName;
}
/**
* Add an expected smarty variable to the array.
*
* @param array $elementNames
*/
public function addExpectedSmartyVariables(array $elementNames): void {
foreach ($elementNames as $elementName) {
// Duplicates don't actually matter....
$this->addExpectedSmartyVariable($elementName);
}
}
/**
* Render form and return contents.
*
* @return string
*/
public function toSmarty() {
$this->preProcessChainSelectFields();
$renderer = $this->getRenderer();
$this->accept($renderer);
$content = $renderer->toArray();
$content['formName'] = $this->getName();
// CRM-15153
$content['formClass'] = CRM_Utils_System::getClassName($this);
foreach (array_merge($this->getOptionalQuickFormElements(), $this->expectedSmartyVariables) as $string) {
if (!array_key_exists($string, $content)) {
$content[$string] = NULL;
}
}
return $content;
}
/**
* Getter function for renderer.
*
* If renderer is not set create one and initialize it.
*
* @return object
*/
public function &getRenderer() {
if (!isset($this->_renderer)) {
$this->_renderer = CRM_Core_Form_Renderer::singleton();
}
return $this->_renderer;
}
/**
* Use the form name to create the tpl file name.
*
* @return string
*/
public function getTemplateFileName() {
$ext = CRM_Extension_System::singleton()->getMapper();
if ($ext->isExtensionClass(CRM_Utils_System::getClassName($this))) {
$filename = $ext->getTemplateName(CRM_Utils_System::getClassName($this));
$tplname = $ext->getTemplatePath(CRM_Utils_System::getClassName($this)) . DIRECTORY_SEPARATOR . $filename;
}
else {
$tplname = strtr(
CRM_Utils_System::getClassName($this),
[
'_' => DIRECTORY_SEPARATOR,
'\\' => DIRECTORY_SEPARATOR,
]
) . '.tpl';
}
return $tplname;
}
/**
* A wrapper for getTemplateFileName.
*
* This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.
*/
public function getHookedTemplateFileName() {
$pageTemplateFile = $this->getTemplateFileName();
CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
return $pageTemplateFile;
}
/**
* Default extra tpl file basically just replaces .tpl with .extra.tpl.
*
* i.e. we do not override.
*
* @return string
*/
public function overrideExtraTemplateFileName() {
return NULL;
}
/**
* Error reporting mechanism.
*
* @param string $message
* Error Message.
* @param int $code
* Error Code.
* @param CRM_Core_DAO $dao
* A data access object on which we perform a rollback if non - empty.
*/
public function error($message, $code = NULL, $dao = NULL) {
if ($dao) {
$dao->query('ROLLBACK');
}
$error = CRM_Core_Error::singleton();
$error->push($code, $message);
}
/**
* Store the variable with the value in the form scope.
*
* @param string $name
* Name of the variable.
* @param mixed $value
* Value of the variable.
*/
public function set($name, $value) {
$this->controller->set($name, $value);
}
/**
* Get the variable from the form scope.
*
* @param string $name
* Name of the variable
*
* @return mixed
*/
public function get($name) {
return $this->controller->get($name);
}
/**
* Getter for action.
*
* @return int
*/
public function getAction() {
return $this->_action;
}
/**
* Setter for action.
*
* @param int $action
* The mode we want to set the form.
*/
public function setAction($action) {
$this->_action = $action;
}
/**
* Assign value to name in template.
*
* @param string $var
* Name of variable.
* @param mixed $value
* Value of variable.
*/
public function assign($var, $value = NULL) {
self::$_template->assign($var, $value);
}
/**
* Assign value to name in template by reference.
*
* @param string $var
* Name of variable.
* @param mixed $value
* Value of variable.
*/
public function assign_by_ref($var, &$value) {
self::$_template->assign_by_ref($var, $value);
}
/**
* Appends values to template variables.
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value
* The value to append.
* @param bool $merge
*/
public function append($tpl_var, $value = NULL, $merge = FALSE) {
self::$_template->append($tpl_var, $value, $merge);
}
/**
* Returns an array containing template variables.
*
* @param string $name
*
* @return array
*/
public function get_template_vars($name = NULL) {
return self::$_template->get_template_vars($name);
}
/**
* @param string $name
* @param string $title
* @param array $values
* @param array $attributes
* @param string $separator
* @param bool $required
* @param array $optionAttributes - Option specific attributes
*
* @return HTML_QuickForm_group
*/
public function &addRadio($name, $title, $values, $attributes = [], $separator = NULL, $required = FALSE, $optionAttributes = []) {
$options = [];
$attributes = $attributes ? $attributes : [];
$allowClear = !empty($attributes['allowClear']);
unset($attributes['allowClear']);
$attributes['id_suffix'] = $name;
foreach ($values as $key => $var) {
$optAttributes = $attributes;
if (!empty($optionAttributes[$key])) {
foreach ($optionAttributes[$key] as $optAttr => $optVal) {
$optAttributes[$optAttr] = ltrim(($optAttributes[$optAttr] ?? '') . ' ' . $optVal);
}
}
// We use a class here to avoid html5 issues with collapsed cutsomfield sets.
$optAttributes['class'] = $optAttributes['class'] ?? '';
if ($required) {
$optAttributes['class'] .= ' required';
}
$element = $this->createElement('radio', NULL, NULL, $var, $key, $optAttributes);
$options[] = $element;
}
$group = $this->addGroup($options, $name, $title, $separator);
$optionEditKey = 'data-option-edit-path';
if (!empty($attributes[$optionEditKey])) {
$group->setAttribute($optionEditKey, $attributes[$optionEditKey]);
}
if ($required) {
$this->addRule($name, ts('%1 is a required field.', [1 => $title]), 'required');
}
if ($allowClear) {
$group->setAttribute('allowClear', TRUE);
}
return $group;
}
/**
* @param string $id
* @param string $title
* @param bool $allowClear
* @param bool $required
* @param array $attributes
*/
public function addYesNo($id, $title, $allowClear = FALSE, $required = NULL, $attributes = []) {
$attributes += ['id_suffix' => $id];
$choice = [];
$choice[] = $this->createElement('radio', NULL, '11', ts('Yes'), '1', $attributes);
$choice[] = $this->createElement('radio', NULL, '11', ts('No'), '0', $attributes);
$group = $this->addGroup($choice, $id, $title);
if ($allowClear) {
$group->setAttribute('allowClear', TRUE);
}
if ($required) {
$this->addRule($id, ts('%1 is a required field.', [1 => $title]), 'required');
}
}
/**
* @param int $id
* @param string $title
* @param array $values
* @param null $other
* @param null $attributes
* @param null $required
* @param null $javascriptMethod
* @param string $separator
* @param bool $flipValues
*/
public function addCheckBox(
$id, $title, $values, $other = NULL,
$attributes = NULL, $required = NULL,
$javascriptMethod = NULL,
$separator = '
', $flipValues = FALSE
) {
$options = [];
if ($javascriptMethod) {
foreach ($values as $key => $var) {
if (!$flipValues) {
$options[] = $this->createElement('checkbox', $var, NULL, $key, $javascriptMethod, $attributes);
}
else {
$options[] = $this->createElement('checkbox', $key, NULL, $var, $javascriptMethod, $attributes);
}
}
}
else {
foreach ($values as $key => $var) {
if (!$flipValues) {
$options[] = $this->createElement('checkbox', $var, NULL, $key, $attributes);
}
else {
$options[] = $this->createElement('checkbox', $key, NULL, $var, $attributes);
}
}
}
$group = $this->addGroup($options, $id, $title, $separator);
$optionEditKey = 'data-option-edit-path';
if (!empty($attributes[$optionEditKey])) {
$group->setAttribute($optionEditKey, $attributes[$optionEditKey]);
}
if ($other) {
$this->addElement('text', $id . '_other', ts('Other'), $attributes[$id . '_other']);
}
if ($required) {
$this->addRule($id,
ts('%1 is a required field.', [1 => $title]),
'required'
);
}
}
public function resetValues() {
$data = $this->controller->container();
$data['values'][$this->_name] = [];
}
/**
* Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title
* Title of the main button.
* @param string $nextType
* Button type for the form after processing.
* @param string $backType
* @param bool|string $submitOnce
*/
public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
$buttons = [];
if ($backType != NULL) {
$buttons[] = [
'type' => $backType,
'name' => ts('Previous'),
];
}
if ($nextType != NULL) {
$nextButton = [
'type' => $nextType,
'name' => $title,
'isDefault' => TRUE,
];
if ($submitOnce) {
$this->submitOnce = TRUE;
}
$buttons[] = $nextButton;
}
$this->addButtons($buttons);
}
/**
* @param string $name
* @param string $from
* @param string $to
* @param string $label
* @param string $dateFormat
* @param bool $required
* @param bool $displayTime
*/
public function addDateRange($name, $from = '_from', $to = '_to', $label = 'From:', $dateFormat = 'searchDate', $required = FALSE, $displayTime = FALSE) {
CRM_Core_Error::deprecatedFunctionWarning('Use CRM_Core_Form::addDatePickerRange insted');
if ($displayTime) {
$this->addDateTime($name . $from, $label, $required, ['formatType' => $dateFormat]);
$this->addDateTime($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]);
}
else {
$this->addDate($name . $from, $label, $required, ['formatType' => $dateFormat]);
$this->addDate($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]);
}
}
/**
* Add a search for a range using date picker fields.
*
* @param string $fieldName
* @param string $label
* @param bool $isDateTime
* Is this a date-time field (not just date).
* @param bool $required
* @param string $fromLabel
* @param string $toLabel
* @param array $additionalOptions
* @param string $to string to append to the to field.
* @param string $from string to append to the from field.
*/
public function addDatePickerRange($fieldName, $label, $isDateTime = FALSE, $required = FALSE, $fromLabel = 'From', $toLabel = 'To', $additionalOptions = [],
$to = '_high', $from = '_low') {
$options = [
'' => ts('- any -'),
0 => ts('Choose Date Range'),
] + CRM_Core_OptionGroup::values('relative_date_filters');
if ($additionalOptions) {
foreach ($additionalOptions as $key => $optionLabel) {
$options[$key] = $optionLabel;
}
}
$this->add('select',
"{$fieldName}_relative",
$label,
$options,
$required,
['class' => 'crm-select2']
);
$attributes = ['formatType' => 'searchDate'];
$extra = ['time' => $isDateTime];
$this->add('datepicker', $fieldName . $from, ts($fromLabel), $attributes, $required, $extra);
$this->add('datepicker', $fieldName . $to, ts($toLabel), $attributes, $required, $extra);
}
/**
* Based on form action, return a string representing the api action.
* Used by addField method.
*
* Return string
*/
protected function getApiAction() {
$action = $this->getAction();
if ($action & (CRM_Core_Action::UPDATE + CRM_Core_Action::ADD)) {
return 'create';
}
if ($action & (CRM_Core_Action::VIEW + CRM_Core_Action::BROWSE + CRM_Core_Action::BASIC + CRM_Core_Action::ADVANCED + CRM_Core_Action::PREVIEW)) {
return 'get';
}
if ($action & (CRM_Core_Action::DELETE)) {
return 'delete';
}
// If you get this exception try adding more cases above.
throw new Exception("Cannot determine api action for " . get_class($this) . '.' . 'CRM_Core_Action "' . CRM_Core_Action::description($action) . '" not recognized.');
}
/**
* Classes extending CRM_Core_Form should implement this method.
* @throws Exception
*/
public function getDefaultEntity() {
throw new Exception("Cannot determine default entity. " . get_class($this) . " should implement getDefaultEntity().");
}
/**
* Classes extending CRM_Core_Form should implement this method.
*
* TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation.
* @throws Exception
*/
public function getDefaultContext() {
throw new Exception("Cannot determine default context. " . get_class($this) . " should implement getDefaultContext().");
}
/**
* 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
* @param string $name
* Field name to go on the form.
* @param array $props
* 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
* @param bool $required
* @throws CRM_Core_Exception
* @return HTML_QuickForm_Element
*/
public function addSelect($name, $props = [], $required = FALSE) {
if (!isset($props['entity'])) {
$props['entity'] = $this->getDefaultEntity();
}
if (!isset($props['field'])) {
$props['field'] = strrpos($name, '[') ? rtrim(substr($name, 1 + strrpos($name, '[')), ']') : $name;
}
if (!isset($props['context'])) {
try {
$props['context'] = $this->getDefaultContext();
}
// This is not a required param, so we'll ignore if this doesn't exist.
catch (Exception $e) {
}
}
// Fetch options from the api unless passed explicitly
if (isset($props['options'])) {
$options = $props['options'];
}
else {
$info = civicrm_api3($props['entity'], 'getoptions', $props);
$options = $info['values'];
}
if (!array_key_exists('placeholder', $props) && $placeholder = self::selectOrAnyPlaceholder($props, $required)) {
$props['placeholder'] = $placeholder;
}
// Handle custom field
if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
[, $id] = explode('_', $name);
$label = $props['label'] ?? CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', 'label', $id);
$gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', 'option_group_id', $id);
if (CRM_Utils_Array::value('context', $props) != 'search') {
$props['data-option-edit-path'] = array_key_exists('option_url', $props) ? $props['option_url'] : 'civicrm/admin/options/' . CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $gid);
}
}
// Core field
else {
$info = civicrm_api3($props['entity'], 'getfields');
foreach ($info['values'] as $uniqueName => $fieldSpec) {
if (
$uniqueName === $props['field'] ||
CRM_Utils_Array::value('name', $fieldSpec) === $props['field'] ||
in_array($props['field'], CRM_Utils_Array::value('api.aliases', $fieldSpec, []))
) {
break;
}
}
$label = $props['label'] ?? $fieldSpec['title'];
if (CRM_Utils_Array::value('context', $props) != 'search') {
$props['data-option-edit-path'] = array_key_exists('option_url', $props) ? $props['option_url'] : CRM_Core_PseudoConstant::getOptionEditUrl($fieldSpec);
}
}
$props['class'] = (isset($props['class']) ? $props['class'] . ' ' : '') . "crm-select2";
$props['data-api-entity'] = $props['entity'];
$props['data-api-field'] = $props['field'];
CRM_Utils_Array::remove($props, 'label', 'entity', 'field', 'option_url', 'options', 'context');
return $this->add('select', $name, $label, $options, $required, $props);
}
/**
* Handles a repeated bit supplying a placeholder for entity selection
*
* @param string $props
* The field properties, including the entity and context.
* @param bool $required
* If the field is required.
* @param string $title
* A field title, if applicable.
* @return string
* The placeholder text.
*/
private static function selectOrAnyPlaceholder($props, $required, $title = NULL) {
if (empty($props['entity'])) {
return NULL;
}
if (!$title) {
$daoToClass = CRM_Core_DAO_AllCoreTables::daoToClass();
if (array_key_exists($props['entity'], $daoToClass)) {
$daoClass = $daoToClass[$props['entity']];
$title = $daoClass::getEntityTitle();
}
else {
$title = ts('option');
}
}
if (($props['context'] ?? '') == 'search' && !$required) {
return ts('- any %1 -', [1 => $title]);
}
return ts('- select %1 -', [1 => $title]);
}
/**
* Adds a field based on metadata.
*
* @param $name
* Field name to go on the form.
* @param array $props
* 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
* @param bool $required
* @param bool $legacyDate
* 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.
*
* @throws \CiviCRM_API3_Exception
* @throws \Exception
* @return mixed
* HTML_QuickForm_Element
* void
*/
public function addField($name, $props = [], $required = FALSE, $legacyDate = TRUE) {
// Resolve context.
if (empty($props['context'])) {
$props['context'] = $this->getDefaultContext();
}
$context = $props['context'];
// Resolve entity.
if (empty($props['entity'])) {
$props['entity'] = $this->getDefaultEntity();
}
// Resolve field.
if (empty($props['name'])) {
$props['name'] = strrpos($name, '[') ? rtrim(substr($name, 1 + strrpos($name, '[')), ']') : $name;
}
// Resolve action.
if (empty($props['action'])) {
$props['action'] = $this->getApiAction();
}
// Handle custom fields
if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
$fieldId = (int) substr($name, 7);
return CRM_Core_BAO_CustomField::addQuickFormElement($this, $name, $fieldId, $required, $context == 'search', CRM_Utils_Array::value('label', $props));
}
// Core field - get metadata.
$fieldSpec = civicrm_api3($props['entity'], 'getfield', $props);
$fieldSpec = $fieldSpec['values'];
$fieldSpecLabel = $fieldSpec['html']['label'] ?? CRM_Utils_Array::value('title', $fieldSpec);
$label = CRM_Utils_Array::value('label', $props, $fieldSpecLabel);
$widget = $props['type'] ?? $fieldSpec['html']['type'];
if ($widget == 'TextArea' && $context == 'search') {
$widget = 'Text';
}
$isSelect = (in_array($widget, [
'Select',
'Select2',
'CheckBoxGroup',
'RadioGroup',
'Radio',
]));
if ($isSelect) {
// Fetch options from the api unless passed explicitly.
if (isset($props['options'])) {
$options = $props['options'];
}
else {
$options = $fieldSpec['options'] ?? NULL;
}
if ($context == 'search') {
$widget = $widget == 'Select2' ? $widget : 'Select';
$props['multiple'] = CRM_Utils_Array::value('multiple', $props, TRUE);
}
// Add data for popup link.
$canEditOptions = CRM_Core_Permission::check('administer CiviCRM');
$hasOptionUrl = !empty($props['option_url']);
$optionUrlKeyIsSet = array_key_exists('option_url', $props);
$shouldAdd = $context !== 'search' && $isSelect && $canEditOptions;
// Only add if key is not set, or if non-empty option url is provided
if (($hasOptionUrl || !$optionUrlKeyIsSet) && $shouldAdd) {
$optionUrl = $hasOptionUrl ? $props['option_url'] :
CRM_Core_PseudoConstant::getOptionEditUrl($fieldSpec);
$props['data-option-edit-path'] = $optionUrl;
$props['data-api-entity'] = $props['entity'];
$props['data-api-field'] = $props['name'];
}
}
$props += CRM_Utils_Array::value('html', $fieldSpec, []);
if (in_array($widget, ['Select', 'Select2'])
&& !array_key_exists('placeholder', $props)
&& $placeholder = self::selectOrAnyPlaceholder($props, $required, $label)) {
$props['placeholder'] = $placeholder;
}
CRM_Utils_Array::remove($props, 'entity', 'name', 'context', 'label', 'action', 'type', 'option_url', 'options');
// TODO: refactor switch statement, to separate methods.
switch ($widget) {
case 'Text':
case 'Url':
case 'Number':
case 'Email':
//TODO: Autodetect ranges
$props['size'] = $props['size'] ?? 60;
return $this->add(strtolower($widget), $name, $label, $props, $required);
case 'hidden':
return $this->add('hidden', $name, NULL, $props, $required);
case 'TextArea':
//Set default columns and rows for textarea.
$props['rows'] = $props['rows'] ?? 4;
$props['cols'] = $props['cols'] ?? 60;
if (empty($props['maxlength']) && isset($fieldSpec['length'])) {
$props['maxlength'] = $fieldSpec['length'];
}
return $this->add('textarea', $name, $label, $props, $required);
case 'Select Date':
// This is a white list for fields that have been tested with
// date picker. We should be able to remove the other
if ($legacyDate) {
//TODO: add range support
//TODO: Add date formats
//TODO: Add javascript template for dates.
return $this->addDate($name, $label, $required, $props);
}
else {
$fieldSpec = CRM_Utils_Date::addDateMetadataToField($fieldSpec, $fieldSpec);
$attributes = ['format' => $fieldSpec['date_format']];
return $this->add('datepicker', $name, $label, $attributes, $required, $fieldSpec['datepicker']['extra']);
}
case 'Radio':
$separator = $props['separator'] ?? NULL;
unset($props['separator']);
if (!isset($props['allowClear'])) {
$props['allowClear'] = !$required;
}
return $this->addRadio($name, $label, $options, $props, $separator, $required);
case 'ChainSelect':
$props += [
'required' => $required,
'label' => $label,
'multiple' => $context == 'search',
];
return $this->addChainSelect($name, $props);
case 'Select':
case 'Select2':
$props['class'] = CRM_Utils_Array::value('class', $props, 'big') . ' crm-select2';
// TODO: Add and/or option for fields that store multiple values
return $this->add(strtolower($widget), $name, $label, $options, $required, $props);
case 'CheckBoxGroup':
return $this->addCheckBox($name, $label, array_flip($options), $required, $props);
case 'RadioGroup':
return $this->addRadio($name, $label, $options, $props, NULL, $required);
case 'CheckBox':
if ($context === 'search') {
$this->addYesNo($name, $label, TRUE, FALSE, $props);
return;
}
$text = $props['text'] ?? NULL;
unset($props['text']);
return $this->addElement('checkbox', $name, $label, $text, $props);
//add support for 'Advcheckbox' field
case 'advcheckbox':
$text = $props['text'] ?? NULL;
unset($props['text']);
return $this->addElement('advcheckbox', $name, $label, $text, $props);
case 'File':
// We should not build upload file in search mode.
if ($context == 'search') {
return;
}
$file = $this->add('file', $name, $label, $props, $required);
$this->addUploadElement($name);
return $file;
case 'RichTextEditor':
return $this->add('wysiwyg', $name, $label, $props, $required);
case 'EntityRef':
return $this->addEntityRef($name, $label, $props, $required);
case 'Password':
$props['size'] = $props['size'] ?? 60;
return $this->add('password', $name, $label, $props, $required);
// Check datatypes of fields
// case 'Int':
//case 'Float':
//case 'Money':
//case read only fields
default:
throw new Exception("Unsupported html-element " . $widget);
}
}
/**
* Add a widget for selecting/editing/creating/copying a profile form
*
* @param string $name
* HTML form-element name.
* @param string $label
* Printable label.
* @param string $allowCoreTypes
* Only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity'.
* @param string $allowSubTypes
* Only present a UFGroup if its group_type is compatible with $allowSubypes.
* @param array $entities
* @param bool $default
* //CRM-15427.
* @param string $usedFor
*/
public function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities, $default = FALSE, $usedFor = NULL) {
// Output widget
// FIXME: Instead of adhoc serialization, use a single json_encode()
CRM_UF_Page_ProfileEditor::registerProfileScripts();
CRM_UF_Page_ProfileEditor::registerSchemas(CRM_Utils_Array::collect('entity_type', $entities));
$this->add('text', $name, $label, [
'class' => 'crm-profile-selector',
// Note: client treats ';;' as equivalent to \0, and ';;' works better in HTML
'data-group-type' => CRM_Core_BAO_UFGroup::encodeGroupType($allowCoreTypes, $allowSubTypes, ';;'),
'data-entities' => json_encode($entities),
//CRM-15427
'data-default' => $default,
'data-usedfor' => json_encode($usedFor),
]);
}
/**
* @return null
*/
public function getRootTitle() {
return NULL;
}
/**
* @return string
*/
public function getCompleteTitle() {
return $this->getRootTitle() . $this->getTitle();
}
/**
* @return CRM_Core_Smarty
*/
public static function &getTemplate() {
return self::$_template;
}
/**
* @param string[]|string $elementName
*/
public function addUploadElement($elementName) {
$uploadNames = $this->get('uploadNames');
if (!$uploadNames) {
$uploadNames = [];
}
if (is_array($elementName)) {
foreach ($elementName as $name) {
if (!in_array($name, $uploadNames)) {
$uploadNames[] = $name;
}
}
}
else {
if (!in_array($elementName, $uploadNames)) {
$uploadNames[] = $elementName;
}
}
$this->set('uploadNames', $uploadNames);
$config = CRM_Core_Config::singleton();
if (!empty($uploadNames)) {
$this->controller->addUploadAction($config->customFileUploadDir, $uploadNames);
}
}
/**
* @param string $name
*
* @return mixed
*/
public function getVar($name) {
return $this->$name ?? NULL;
}
/**
* @param string $name
* @param mixed $value
*/
public function setVar($name, $value) {
$this->$name = $value;
}
/**
* Add date.
*
* @deprecated
* Use $this->add('datepicker', ...) instead.
*
* @param string $name
* Name of the element.
* @param string $label
* Label of the element.
* @param bool $required
* True if required.
* @param array $attributes
* Key / value pair.
*/
public function addDate($name, $label, $required = FALSE, $attributes = NULL) {
if (!empty($attributes['formatType'])) {
// get actual format
$params = ['name' => $attributes['formatType']];
$values = [];
// cache date information
static $dateFormat;
$key = "dateFormat_" . str_replace(' ', '_', $attributes['formatType']);
if (empty($dateFormat[$key])) {
CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_PreferencesDate', $params, $values);
$dateFormat[$key] = $values;
}
else {
$values = $dateFormat[$key];
}
if ($values['date_format']) {
$attributes['format'] = $values['date_format'];
}
if (!empty($values['time_format'])) {
$attributes['timeFormat'] = $values['time_format'];
}
$attributes['startOffset'] = $values['start'];
$attributes['endOffset'] = $values['end'];
}
$config = CRM_Core_Config::singleton();
if (empty($attributes['format'])) {
$attributes['format'] = $config->dateInputFormat;
}
if (!isset($attributes['startOffset'])) {
$attributes['startOffset'] = 10;
}
if (!isset($attributes['endOffset'])) {
$attributes['endOffset'] = 10;
}
$this->add('text', $name, $label, $attributes);
if (!empty($attributes['addTime']) || !empty($attributes['timeFormat'])) {
if (!isset($attributes['timeFormat'])) {
$timeFormat = $config->timeInputFormat;
}
else {
$timeFormat = $attributes['timeFormat'];
}
// 1 - 12 hours and 2 - 24 hours, but for jquery widget it is 0 and 1 respectively
if ($timeFormat) {
$show24Hours = TRUE;
if ($timeFormat == 1) {
$show24Hours = FALSE;
}
//CRM-6664 -we are having time element name
//in either flat string or an array format.
$elementName = $name . '_time';
if (substr($name, -1) == ']') {
$elementName = substr($name, 0, strlen($name) - 1) . '_time]';
}
$this->add('text', $elementName, ts('Time'), ['timeFormat' => $show24Hours]);
}
}
if ($required) {
$this->addRule($name, ts('Please select %1', [1 => $label]), 'required');
if (!empty($attributes['addTime']) && !empty($attributes['addTimeRequired'])) {
$this->addRule($elementName, ts('Please enter a time.'), 'required');
}
}
}
/**
* Function that will add date and time.
*
* @deprecated
* Use $this->add('datepicker', ...) instead.
*
* @param string $name
* @param string $label
* @param bool $required
* @param array $attributes
*/
public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) {
$addTime = ['addTime' => TRUE];
if (is_array($attributes)) {
$attributes = array_merge($attributes, $addTime);
}
else {
$attributes = $addTime;
}
$this->addDate($name, $label, $required, $attributes);
}
/**
* Add a currency and money element to the form.
*
* @param string $name
* @param string $label
* @param bool $required
* @param array $attributes
* @param bool $addCurrency
* @param string $currencyName
* @param string $defaultCurrency
* @param bool $freezeCurrency
*
* @return \HTML_QuickForm_Element
*/
public function addMoney(
$name,
$label,
$required = FALSE,
$attributes = NULL,
$addCurrency = TRUE,
$currencyName = 'currency',
$defaultCurrency = NULL,
$freezeCurrency = FALSE
) {
$element = $this->add('text', $name, $label, $attributes, $required);
$this->addRule($name, ts('Please enter a valid amount.'), 'money');
if ($addCurrency) {
$ele = $this->addCurrency($currencyName, NULL, TRUE, $defaultCurrency, $freezeCurrency);
}
return $element;
}
/**
* Add currency element to the form.
*
* @param string $name
* @param string $label
* @param bool $required
* @param string $defaultCurrency
* @param bool $freezeCurrency
* @param bool $setDefaultCurrency
*/
public function addCurrency(
$name = 'currency',
$label = NULL,
$required = TRUE,
$defaultCurrency = NULL,
$freezeCurrency = FALSE,
$setDefaultCurrency = TRUE
) {
$currencies = CRM_Core_OptionGroup::values('currencies_enabled');
if (!empty($defaultCurrency) && !array_key_exists($defaultCurrency, $currencies)) {
Civi::log()->warning('addCurrency: Currency ' . $defaultCurrency . ' is disabled but still in use!');
$currencies[$defaultCurrency] = $defaultCurrency;
}
$options = ['class' => 'crm-select2 eight'];
if (!$required) {
$currencies = ['' => ''] + $currencies;
$options['placeholder'] = ts('- none -');
}
$ele = $this->add('select', $name, $label, $currencies, $required, $options);
if ($freezeCurrency) {
$ele->freeze();
}
if (!$defaultCurrency) {
$config = CRM_Core_Config::singleton();
$defaultCurrency = $config->defaultCurrency;
}
// In some case, setting currency field by default might override the default value
// as encountered in CRM-20527 for batch data entry
if ($setDefaultCurrency) {
$this->setDefaults([$name => $defaultCurrency]);
}
}
/**
* Create a single or multiple entity ref field.
* @param string $name
* @param string $label
* @param array $props
* 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
* @param bool $required
*
* @return HTML_QuickForm_Element
*/
public function addEntityRef($name, $label = '', $props = [], $required = FALSE) {
// Default properties
$props['api'] = CRM_Utils_Array::value('api', $props, []);
$props['entity'] = CRM_Core_DAO_AllCoreTables::convertEntityNameToCamel($props['entity'] ?? 'Contact');
$props['class'] = ltrim(($props['class'] ?? '') . ' crm-form-entityref');
if (array_key_exists('create', $props) && empty($props['create'])) {
unset($props['create']);
}
$props['placeholder'] = $props['placeholder'] ?? self::selectOrAnyPlaceholder($props, $required);
$defaults = [];
if (!empty($props['multiple'])) {
$defaults['multiple'] = TRUE;
}
$props['select'] = CRM_Utils_Array::value('select', $props, []) + $defaults;
$this->formatReferenceFieldAttributes($props, get_class($this));
return $this->add('text', $name, $label, $props, $required);
}
/**
* @param array $props
* @param string $formName
*/
private function formatReferenceFieldAttributes(&$props, $formName) {
CRM_Utils_Hook::alterEntityRefParams($props, $formName);
$props['data-select-params'] = json_encode($props['select']);
$props['data-api-params'] = $props['api'] ? json_encode($props['api']) : NULL;
$props['data-api-entity'] = $props['entity'];
if (!empty($props['create'])) {
$props['data-create-links'] = json_encode($props['create']);
}
CRM_Utils_Array::remove($props, 'multiple', 'select', 'api', 'entity', 'create');
}
/**
* @param $elementName
*/
public function removeFileRequiredRules($elementName) {
$this->_required = array_diff($this->_required, [$elementName]);
if (isset($this->_rules[$elementName])) {
foreach ($this->_rules[$elementName] as $index => $ruleInfo) {
if ($ruleInfo['type'] == 'uploadedfile') {
unset($this->_rules[$elementName][$index]);
}
}
if (empty($this->_rules[$elementName])) {
unset($this->_rules[$elementName]);
}
}
}
/**
* Function that can be defined in Form to override or.
* perform specific action on cancel action
*/
public function cancelAction() {
}
/**
* Helper function to verify that required fields have been filled.
*
* Typically called within the scope of a FormRule function
*
* @param array $fields
* @param array $values
* @param array $errors
*/
public static function validateMandatoryFields($fields, $values, &$errors) {
foreach ($fields as $name => $fld) {
if (!empty($fld['is_required']) && CRM_Utils_System::isNull(CRM_Utils_Array::value($name, $values))) {
$errors[$name] = ts('%1 is a required field.', [1 => $fld['title']]);
}
}
}
/**
* 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?)
*
* @return NULL|int
*/
protected function setContactID() {
$tempID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
if (isset($this->_params) && !empty($this->_params['select_contact_id'])) {
$tempID = $this->_params['select_contact_id'];
}
if (isset($this->_params, $this->_params[0]) && !empty($this->_params[0]['select_contact_id'])) {
// event form stores as an indexed array, contribution form not so much...
$tempID = $this->_params[0]['select_contact_id'];
}
// force to ignore the authenticated user
if ($tempID === '0' || $tempID === 0) {
// we set the cid on the form so that this will be retained for the Confirm page
// in the multi-page form & prevent us returning the $userID when this is called
// from that page
// we don't really need to set it when $tempID is set because the params have that stored
$this->set('cid', 0);
CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
return (int) $tempID;
}
$userID = CRM_Core_Session::getLoggedInContactID();
if (!is_null($tempID) && $tempID === $userID) {
CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
return (int) $userID;
}
//check if this is a checksum authentication
$userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this);
if ($userChecksum) {
//check for anonymous user.
$validUser = CRM_Contact_BAO_Contact_Utils::validChecksum($tempID, $userChecksum);
if ($validUser) {
CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
CRM_Core_Resources::singleton()->addVars('coreForm', ['checksum' => $userChecksum]);
return $tempID;
}
}
// check if user has permission, CRM-12062
elseif ($tempID && CRM_Contact_BAO_Contact_Permission::allow($tempID)) {
CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]);
return $tempID;
}
if (is_numeric($userID)) {
CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $userID]);
}
return is_numeric($userID) ? $userID : NULL;
}
/**
* Get the contact id that the form is being submitted for.
*
* @return int|null
*/
public function getContactID() {
return $this->setContactID();
}
/**
* Get the contact id of the logged in user.
* @deprecated
*
* @return int|false
*/
public function getLoggedInUserContactID() {
CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_Session::getLoggedInContactID()');
// check if the user is logged in and has a contact ID
$session = CRM_Core_Session::singleton();
return $session->get('userID') ? (int) $session->get('userID') : FALSE;
}
/**
* 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)}
*