Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * This is our base form. It is part of the Form/Controller/StateMachine | |
14 | * trifecta. Each form is associated with a specific state in the state | |
15 | * machine. Each form can also operate in various modes | |
16 | * | |
17 | * @package CRM | |
ca5cec67 | 18 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
19 | */ |
20 | ||
21 | require_once 'HTML/QuickForm/Page.php'; | |
28518c90 EM |
22 | |
23 | /** | |
24 | * Class CRM_Core_Form | |
25 | */ | |
6a488035 TO |
26 | class CRM_Core_Form extends HTML_QuickForm_Page { |
27 | ||
28 | /** | |
29 | * The state object that this form belongs to | |
30 | * @var object | |
31 | */ | |
32 | protected $_state; | |
33 | ||
34 | /** | |
35 | * The name of this form | |
36 | * @var string | |
37 | */ | |
38 | protected $_name; | |
39 | ||
40 | /** | |
41 | * The title of this form | |
42 | * @var string | |
43 | */ | |
44 | protected $_title = NULL; | |
45 | ||
73afe1e6 | 46 | /** |
47 | * The default values for the form. | |
48 | * | |
49 | * @var array | |
50 | */ | |
be2fb01f | 51 | public $_defaults = []; |
73afe1e6 | 52 | |
6a488035 | 53 | /** |
2eee184e TO |
54 | * (QUASI-PROTECTED) The options passed into this form |
55 | * | |
56 | * This field should marked `protected` and is not generally | |
57 | * intended for external callers, but some edge-cases do use it. | |
58 | * | |
6a488035 TO |
59 | * @var mixed |
60 | */ | |
2eee184e | 61 | public $_options = NULL; |
6a488035 TO |
62 | |
63 | /** | |
2eee184e TO |
64 | * (QUASI-PROTECTED) The mode of operation for this form |
65 | * | |
66 | * This field should marked `protected` and is not generally | |
67 | * intended for external callers, but some edge-cases do use it. | |
68 | * | |
6a488035 TO |
69 | * @var int |
70 | */ | |
2eee184e | 71 | public $_action; |
6a488035 | 72 | |
1b9f9ca3 EM |
73 | /** |
74 | * Available payment processors. | |
75 | * | |
76 | * As part of trying to consolidate various payment pages we store processors here & have functions | |
77 | * at this level to manage them. | |
78 | * | |
79 | * @var array | |
80 | * An array of payment processor details with objects loaded in the 'object' field. | |
81 | */ | |
42e3a033 | 82 | protected $_paymentProcessors; |
1b9f9ca3 EM |
83 | |
84 | /** | |
85 | * Available payment processors (IDS). | |
86 | * | |
87 | * As part of trying to consolidate various payment pages we store processors here & have functions | |
cbcb5b49 | 88 | * at this level to manage them. An alternative would be to have a separate Form that is inherited |
89 | * by all forms that allow payment processing. | |
1b9f9ca3 EM |
90 | * |
91 | * @var array | |
92 | * An array of the IDS available on this form. | |
93 | */ | |
94 | public $_paymentProcessorIDs; | |
95 | ||
cbcb5b49 | 96 | /** |
97 | * Default or selected processor id. | |
98 | * | |
99 | * As part of trying to consolidate various payment pages we store processors here & have functions | |
100 | * at this level to manage them. An alternative would be to have a separate Form that is inherited | |
101 | * by all forms that allow payment processing. | |
102 | * | |
103 | * @var int | |
104 | */ | |
105 | protected $_paymentProcessorID; | |
106 | ||
107 | /** | |
108 | * Is pay later enabled for the form. | |
109 | * | |
110 | * As part of trying to consolidate various payment pages we store processors here & have functions | |
111 | * at this level to manage them. An alternative would be to have a separate Form that is inherited | |
112 | * by all forms that allow payment processing. | |
113 | * | |
114 | * @var int | |
115 | */ | |
116 | protected $_is_pay_later_enabled; | |
117 | ||
6a488035 | 118 | /** |
100fef9d | 119 | * The renderer used for this form |
6a488035 TO |
120 | * |
121 | * @var object | |
122 | */ | |
123 | protected $_renderer; | |
124 | ||
5d86176b | 125 | /** |
126 | * An array to hold a list of datefields on the form | |
127 | * so that they can be converted to ISO in a consistent manner | |
128 | * | |
129 | * @var array | |
130 | * | |
131 | * e.g on a form declare $_dateFields = array( | |
132 | * 'receive_date' => array('default' => 'now'), | |
133 | * ); | |
134 | * then in postProcess call $this->convertDateFieldsToMySQL($formValues) | |
135 | * to have the time field re-incorporated into the field & 'now' set if | |
136 | * no value has been passed in | |
137 | */ | |
be2fb01f | 138 | protected $_dateFields = []; |
5d86176b | 139 | |
6a488035 | 140 | /** |
100fef9d | 141 | * Cache the smarty template for efficiency reasons |
6a488035 TO |
142 | * |
143 | * @var CRM_Core_Smarty | |
144 | */ | |
145 | static protected $_template; | |
146 | ||
461fa5fb | 147 | /** |
148 | * Indicate if this form should warn users of unsaved changes | |
518fa0ee | 149 | * @var bool |
461fa5fb | 150 | */ |
151 | protected $unsavedChangesWarn; | |
152 | ||
03a7ec8f | 153 | /** |
fc05b8da | 154 | * What to return to the client if in ajax mode (snippet=json) |
03a7ec8f CW |
155 | * |
156 | * @var array | |
157 | */ | |
be2fb01f | 158 | public $ajaxResponse = []; |
03a7ec8f | 159 | |
118e964e CW |
160 | /** |
161 | * Url path used to reach this page | |
162 | * | |
163 | * @var array | |
164 | */ | |
be2fb01f | 165 | public $urlPath = []; |
118e964e | 166 | |
2d69ef96 | 167 | /** |
168 | * Context of the form being loaded. | |
169 | * | |
170 | * 'event' or null | |
171 | * | |
172 | * @var string | |
173 | */ | |
174 | protected $context; | |
175 | ||
423616fa CW |
176 | /** |
177 | * @var bool | |
178 | */ | |
179 | public $submitOnce = FALSE; | |
180 | ||
6aef1389 | 181 | /** |
182 | * Values submitted by the user. | |
183 | * | |
184 | * These values have been checked for injection per | |
185 | * https://pear.php.net/manual/en/package.html.html-quickform.html-quickform.exportvalues.php | |
186 | * and are as submitted. | |
187 | * | |
188 | * Once set this array should be treated as read only. | |
189 | * | |
190 | * @var array | |
191 | */ | |
192 | protected $exportedValues = []; | |
193 | ||
2d69ef96 | 194 | /** |
195 | * @return string | |
196 | */ | |
197 | public function getContext() { | |
198 | return $this->context; | |
199 | } | |
200 | ||
201 | /** | |
202 | * Set context variable. | |
203 | */ | |
204 | public function setContext() { | |
205 | $this->context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this); | |
206 | } | |
207 | ||
d77a0a58 EM |
208 | /** |
209 | * @var CRM_Core_Controller | |
210 | */ | |
211 | public $controller; | |
4a44fd8a | 212 | |
6a488035 | 213 | /** |
100fef9d | 214 | * Constants for attributes for various form elements |
6a488035 TO |
215 | * attempt to standardize on the number of variations that we |
216 | * use of the below form elements | |
217 | * | |
218 | * @var const string | |
219 | */ | |
7da04cde | 220 | const ATTR_SPACING = ' '; |
6a488035 TO |
221 | |
222 | /** | |
223 | * All checkboxes are defined with a common prefix. This allows us to | |
224 | * have the same javascript to check / clear all the checkboxes etc | |
225 | * If u have multiple groups of checkboxes, you will need to give them different | |
226 | * ids to avoid potential name collision | |
227 | * | |
fffe9ee1 | 228 | * @var string|int |
6a488035 | 229 | */ |
7da04cde | 230 | const CB_PREFIX = 'mark_x_', CB_PREFIY = 'mark_y_', CB_PREFIZ = 'mark_z_', CB_PREFIX_LEN = 7; |
6a488035 | 231 | |
1d07e7ab | 232 | /** |
1d07e7ab | 233 | * @var array |
518fa0ee | 234 | * @internal to keep track of chain-select fields |
1d07e7ab | 235 | */ |
be2fb01f | 236 | private $_chainSelectFields = []; |
1d07e7ab | 237 | |
d8f1758d CW |
238 | /** |
239 | * Extra input types we support via the "add" method | |
240 | * @var array | |
241 | */ | |
be2fb01f | 242 | public static $html5Types = [ |
d8f1758d CW |
243 | 'number', |
244 | 'url', | |
245 | 'email', | |
1192bd09 | 246 | 'color', |
be2fb01f | 247 | ]; |
d8f1758d | 248 | |
6a488035 | 249 | /** |
4b62bc4f | 250 | * Constructor for the basic form page. |
6a488035 TO |
251 | * |
252 | * We should not use QuickForm directly. This class provides a lot | |
253 | * of default convenient functions, rules and buttons | |
254 | * | |
6a0b768e TO |
255 | * @param object $state |
256 | * State associated with this form. | |
fffe9ee1 | 257 | * @param \const|\enum|int $action The mode the form is operating in (None/Create/View/Update/Delete) |
6a0b768e TO |
258 | * @param string $method |
259 | * The type of http method used (GET/POST). | |
260 | * @param string $name | |
261 | * The name of the form if different from class name. | |
6a488035 | 262 | * |
dd244018 | 263 | * @return \CRM_Core_Form |
6a488035 | 264 | */ |
2da40d21 | 265 | public function __construct( |
6a488035 TO |
266 | $state = NULL, |
267 | $action = CRM_Core_Action::NONE, | |
268 | $method = 'post', | |
f9f40af3 | 269 | $name = NULL |
6a488035 TO |
270 | ) { |
271 | ||
272 | if ($name) { | |
273 | $this->_name = $name; | |
274 | } | |
275 | else { | |
b50fdacc | 276 | // CRM-15153 - FIXME this name translates to a DOM id and is not always unique! |
6a488035 TO |
277 | $this->_name = CRM_Utils_String::getClassName(CRM_Utils_System::getClassName($this)); |
278 | } | |
279 | ||
6ef04c72 | 280 | parent::__construct($this->_name, $method); |
6a488035 TO |
281 | |
282 | $this->_state =& $state; | |
283 | if ($this->_state) { | |
284 | $this->_state->setName($this->_name); | |
285 | } | |
286 | $this->_action = (int) $action; | |
287 | ||
288 | $this->registerRules(); | |
289 | ||
290 | // let the constructor initialize this, should happen only once | |
291 | if (!isset(self::$_template)) { | |
292 | self::$_template = CRM_Core_Smarty::singleton(); | |
293 | } | |
b50fdacc CW |
294 | // Workaround for CRM-15153 - give each form a reasonably unique css class |
295 | $this->addClass(CRM_Utils_System::getClassName($this)); | |
03a7ec8f | 296 | |
819d4cbb | 297 | $this->assign('snippet', CRM_Utils_Array::value('snippet', $_GET)); |
d84ae5f6 | 298 | $this->setTranslatedFields(); |
6a488035 TO |
299 | } |
300 | ||
d84ae5f6 | 301 | /** |
302 | * Set translated fields. | |
303 | * | |
304 | * This function is called from the class constructor, allowing us to set | |
305 | * fields on the class that can't be set as properties due to need for | |
306 | * translation or other non-input specific handling. | |
307 | */ | |
308 | protected function setTranslatedFields() {} | |
309 | ||
023e90c3 | 310 | /** |
e51d62d3 | 311 | * Add one or more css classes to the form. |
312 | * | |
100fef9d | 313 | * @param string $className |
023e90c3 CW |
314 | */ |
315 | public function addClass($className) { | |
316 | $classes = $this->getAttribute('class'); | |
317 | $this->setAttribute('class', ($classes ? "$classes " : '') . $className); | |
318 | } | |
319 | ||
6a488035 | 320 | /** |
fe482240 | 321 | * Register all the standard rules that most forms potentially use. |
6a488035 | 322 | */ |
00be9182 | 323 | public function registerRules() { |
be2fb01f | 324 | static $rules = [ |
353ffa53 TO |
325 | 'title', |
326 | 'longTitle', | |
327 | 'variable', | |
328 | 'qfVariable', | |
329 | 'phone', | |
330 | 'integer', | |
331 | 'query', | |
332 | 'url', | |
333 | 'wikiURL', | |
334 | 'domain', | |
335 | 'numberOfDigit', | |
336 | 'date', | |
337 | 'currentDate', | |
338 | 'asciiFile', | |
339 | 'htmlFile', | |
340 | 'utf8File', | |
341 | 'objectExists', | |
342 | 'optionExists', | |
343 | 'postalCode', | |
344 | 'money', | |
345 | 'positiveInteger', | |
353ffa53 | 346 | 'fileExists', |
d9d7e7dd | 347 | 'settingPath', |
353ffa53 TO |
348 | 'autocomplete', |
349 | 'validContact', | |
be2fb01f | 350 | ]; |
6a488035 TO |
351 | |
352 | foreach ($rules as $rule) { | |
353 | $this->registerRule($rule, 'callback', $rule, 'CRM_Utils_Rule'); | |
354 | } | |
355 | } | |
356 | ||
357 | /** | |
e51d62d3 | 358 | * Simple easy to use wrapper around addElement. |
359 | * | |
360 | * Deal with simple validation rules. | |
6a488035 | 361 | * |
bae056c6 CW |
362 | * @param string $type |
363 | * @param string $name | |
77b97be7 | 364 | * @param string $label |
4367e964 | 365 | * @param array $attributes (options for select elements) |
77b97be7 | 366 | * @param bool $required |
6a0b768e TO |
367 | * @param array $extra |
368 | * (attributes for select elements). | |
d86e674f | 369 | * For datepicker elements this is consistent with the data |
370 | * from CRM_Utils_Date::getDatePickerExtra | |
6a488035 | 371 | * |
e51d62d3 | 372 | * @return HTML_QuickForm_Element |
373 | * Could be an error object | |
8a35c7ee | 374 | * |
375 | * @throws \CRM_Core_Exception | |
6a488035 | 376 | */ |
2da40d21 | 377 | public function &add( |
f9f40af3 | 378 | $type, $name, $label = '', |
4367e964 | 379 | $attributes = NULL, $required = FALSE, $extra = NULL |
6a488035 | 380 | ) { |
dd283518 SL |
381 | if ($type === 'radio') { |
382 | CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_Form::addRadio'); | |
383 | } | |
4367e964 | 384 | |
50252ad3 | 385 | if ($type !== 'static' && $attributes && !is_array($attributes)) { |
4367e964 AH |
386 | // The $attributes param used to allow for strings and would default to an |
387 | // empty string. However, now that the variable is heavily manipulated, | |
388 | // we should expect it to always be an array. | |
31177cf4 | 389 | CRM_Core_Error::deprecatedWarning('Attributes passed to CRM_Core_Form::add() are not an array.'); |
4367e964 | 390 | } |
092cb9c5 | 391 | // Fudge some extra types that quickform doesn't support |
1192bd09 | 392 | $inputType = $type; |
d8f1758d | 393 | if ($type == 'wysiwyg' || in_array($type, self::$html5Types)) { |
be2fb01f | 394 | $attributes = ($attributes ? $attributes : []) + ['class' => '']; |
092cb9c5 | 395 | $attributes['class'] = ltrim($attributes['class'] . " crm-form-$type"); |
7ad5ae6a CW |
396 | if ($type == 'wysiwyg' && isset($attributes['preset'])) { |
397 | $attributes['data-preset'] = $attributes['preset']; | |
398 | unset($attributes['preset']); | |
399 | } | |
092cb9c5 | 400 | $type = $type == 'wysiwyg' ? 'textarea' : 'text'; |
b608cfb1 | 401 | } |
b733747a CW |
402 | // Like select but accepts rich array data (with nesting, colors, icons, etc) as option list. |
403 | if ($inputType == 'select2') { | |
404 | $type = 'text'; | |
405 | $options = $attributes; | |
11b9f280 | 406 | $attributes = ($extra ? $extra : []) + ['class' => '']; |
b733747a | 407 | $attributes['class'] = ltrim($attributes['class'] . " crm-select2 crm-form-select2"); |
be2fb01f | 408 | $attributes['data-select-params'] = json_encode(['data' => $options, 'multiple' => !empty($attributes['multiple'])]); |
b733747a CW |
409 | unset($attributes['multiple']); |
410 | $extra = NULL; | |
411 | } | |
8a35c7ee | 412 | |
6f55e2a8 | 413 | // @see https://docs.civicrm.org/dev/en/latest/framework/ui/#date-picker |
8a35c7ee | 414 | if ($type === 'datepicker') { |
415 | $attributes = $attributes ?: []; | |
db91a581 SL |
416 | if (!empty($attributes['formatType'])) { |
417 | $dateAttributes = CRM_Core_SelectValues::date($attributes['formatType'], NULL, NULL, NULL, 'Input'); | |
8a35c7ee | 418 | if (empty($extra['minDate']) && !empty($dateAttributes['minYear'])) { |
419 | $extra['minDate'] = $dateAttributes['minYear'] . '-01-01'; | |
420 | } | |
421 | if (empty($extra['maxDate']) && !empty($dateAttributes['minYear'])) { | |
422 | $extra['maxDate'] = $dateAttributes['maxYear'] . '-12-31'; | |
423 | } | |
424 | } | |
12c73866 MW |
425 | // Support minDate/maxDate properties |
426 | if (isset($extra['minDate'])) { | |
427 | $extra['minDate'] = date('Y-m-d', strtotime($extra['minDate'])); | |
428 | } | |
429 | if (isset($extra['maxDate'])) { | |
430 | $extra['maxDate'] = date('Y-m-d', strtotime($extra['maxDate'])); | |
431 | } | |
432 | ||
238fee7f | 433 | $attributes['data-crm-datepicker'] = json_encode((array) $extra); |
1f1410dc | 434 | if (!empty($attributes['aria-label']) || $label) { |
9ca69805 | 435 | $attributes['aria-label'] = $attributes['aria-label'] ?? $label; |
1f1410dc | 436 | } |
238fee7f CW |
437 | $type = "text"; |
438 | } | |
8a35c7ee | 439 | if ($type === 'select' && is_array($extra)) { |
bae056c6 | 440 | // Normalize this property |
1d07e7ab CW |
441 | if (!empty($extra['multiple'])) { |
442 | $extra['multiple'] = 'multiple'; | |
443 | } | |
444 | else { | |
445 | unset($extra['multiple']); | |
446 | } | |
65e8615b | 447 | unset($extra['size'], $extra['maxlength']); |
bae056c6 CW |
448 | // Add placeholder option for select |
449 | if (isset($extra['placeholder'])) { | |
450 | if ($extra['placeholder'] === TRUE) { | |
a2eb6152 | 451 | $extra['placeholder'] = ts('- select %1 -', [1 => $label]); |
bae056c6 CW |
452 | } |
453 | if (($extra['placeholder'] || $extra['placeholder'] === '') && empty($extra['multiple']) && is_array($attributes) && !isset($attributes[''])) { | |
be2fb01f | 454 | $attributes = ['' => $extra['placeholder']] + $attributes; |
bae056c6 CW |
455 | } |
456 | } | |
908fe4e6 | 457 | } |
fcce3ced JP |
458 | $optionContext = NULL; |
459 | if (!empty($extra['option_context'])) { | |
460 | $optionContext = $extra['option_context']; | |
461 | unset($extra['option_context']); | |
462 | } | |
6e5cba54 | 463 | |
d6ae85ac | 464 | $element = $this->addElement($type, $name, CRM_Utils_String::purifyHTML($label), $attributes, $extra); |
6a488035 | 465 | if (HTML_QuickForm::isError($element)) { |
ac15829d | 466 | CRM_Core_Error::statusBounce(HTML_QuickForm::errorMessage($element)); |
6a488035 TO |
467 | } |
468 | ||
1192bd09 | 469 | if ($inputType == 'color') { |
be2fb01f | 470 | $this->addRule($name, ts('%1 must contain a color value e.g. #ffffff.', [1 => $label]), 'regex', '/#[0-9a-fA-F]{6}/'); |
1192bd09 CW |
471 | } |
472 | ||
6a488035 TO |
473 | if ($required) { |
474 | if ($type == 'file') { | |
be2fb01f | 475 | $error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'uploadedfile'); |
6a488035 TO |
476 | } |
477 | else { | |
be2fb01f | 478 | $error = $this->addRule($name, ts('%1 is a required field.', [1 => $label]), 'required'); |
6a488035 TO |
479 | } |
480 | if (HTML_QuickForm::isError($error)) { | |
ac15829d | 481 | CRM_Core_Error::statusBounce(HTML_QuickForm::errorMessage($element)); |
6a488035 TO |
482 | } |
483 | } | |
484 | ||
b3ee84c9 | 485 | // Add context for the editing of option groups |
6e5cba54 JP |
486 | if ($optionContext) { |
487 | $element->setAttribute('data-option-edit-context', json_encode($optionContext)); | |
b3ee84c9 MD |
488 | } |
489 | ||
6a488035 TO |
490 | return $element; |
491 | } | |
492 | ||
493 | /** | |
e51d62d3 | 494 | * Preprocess form. |
495 | * | |
496 | * This is called before buildForm. Any pre-processing that | |
497 | * needs to be done for buildForm should be done here. | |
6a488035 | 498 | * |
8eedd10a | 499 | * This is a virtual function and should be redefined if needed. |
6a488035 | 500 | */ |
f9f40af3 TO |
501 | public function preProcess() { |
502 | } | |
6a488035 TO |
503 | |
504 | /** | |
8eedd10a | 505 | * Called after the form is validated. |
506 | * | |
507 | * Any processing of form state etc should be done in this function. | |
6a488035 TO |
508 | * Typically all processing associated with a form should be done |
509 | * here and relevant state should be stored in the session | |
510 | * | |
511 | * This is a virtual function and should be redefined if needed | |
6a488035 | 512 | */ |
f9f40af3 TO |
513 | public function postProcess() { |
514 | } | |
6a488035 TO |
515 | |
516 | /** | |
e51d62d3 | 517 | * Main process wrapper. |
518 | * | |
519 | * Implemented so that we can call all the hook functions. | |
520 | * | |
6a0b768e TO |
521 | * @param bool $allowAjax |
522 | * FIXME: This feels kind of hackish, ideally we would take the json-related code from this function. | |
7e9fdecf | 523 | * and bury it deeper down in the controller |
6a488035 | 524 | */ |
00be9182 | 525 | public function mainProcess($allowAjax = TRUE) { |
6a488035 | 526 | $this->postProcess(); |
6a488035 | 527 | $this->postProcessHook(); |
03a7ec8f | 528 | |
fc05b8da | 529 | // Respond with JSON if in AJAX context (also support legacy value '6') |
be2fb01f | 530 | if ($allowAjax && !empty($_REQUEST['snippet']) && in_array($_REQUEST['snippet'], [ |
518fa0ee SL |
531 | CRM_Core_Smarty::PRINT_JSON, |
532 | 6, | |
533 | ])) { | |
03a7ec8f CW |
534 | $this->ajaxResponse['buttonName'] = str_replace('_qf_' . $this->getAttribute('id') . '_', '', $this->controller->getButtonName()); |
535 | $this->ajaxResponse['action'] = $this->_action; | |
18ddc127 | 536 | if (isset($this->_id) || isset($this->id)) { |
2e1f50d6 | 537 | $this->ajaxResponse['id'] = $this->id ?? $this->_id; |
18ddc127 | 538 | } |
03a7ec8f CW |
539 | CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse); |
540 | } | |
6a488035 TO |
541 | } |
542 | ||
543 | /** | |
4b62bc4f | 544 | * The postProcess hook is typically called by the framework. |
e51d62d3 | 545 | * |
6a488035 TO |
546 | * However in a few cases, the form exits or redirects early in which |
547 | * case it needs to call this function so other modules can do the needful | |
548 | * Calling this function directly should be avoided if possible. In general a | |
549 | * better way is to do setUserContext so the framework does the redirect | |
6a488035 | 550 | */ |
00be9182 | 551 | public function postProcessHook() { |
6a488035 TO |
552 | CRM_Utils_Hook::postProcess(get_class($this), $this); |
553 | } | |
554 | ||
555 | /** | |
8eedd10a | 556 | * This virtual function is used to build the form. |
6a488035 | 557 | * |
8eedd10a | 558 | * It replaces the buildForm associated with QuickForm_Page. This allows us to put |
559 | * preProcess in front of the actual form building routine | |
6a488035 | 560 | */ |
f9f40af3 TO |
561 | public function buildQuickForm() { |
562 | } | |
6a488035 TO |
563 | |
564 | /** | |
8eedd10a | 565 | * This virtual function is used to set the default values of various form elements. |
6a488035 | 566 | * |
a1a2a83d | 567 | * @return array|NULL |
a6c01b45 | 568 | * reference to the array of default values |
6a488035 | 569 | */ |
f9f40af3 | 570 | public function setDefaultValues() { |
a1a2a83d | 571 | return NULL; |
f9f40af3 | 572 | } |
6a488035 TO |
573 | |
574 | /** | |
8eedd10a | 575 | * This is a virtual function that adds group and global rules to the form. |
6a488035 | 576 | * |
8eedd10a | 577 | * Keeping it distinct from the form to keep code small |
578 | * and localized in the form building code | |
6a488035 | 579 | */ |
f9f40af3 TO |
580 | public function addRules() { |
581 | } | |
6a488035 | 582 | |
b5c2afd0 | 583 | /** |
fe482240 | 584 | * Performs the server side validation. |
b5c2afd0 | 585 | * @since 1.0 |
5c766a0b | 586 | * @return bool |
a6c01b45 | 587 | * true if no error found |
b5c2afd0 EM |
588 | * @throws HTML_QuickForm_Error |
589 | */ | |
00be9182 | 590 | public function validate() { |
6a488035 TO |
591 | $error = parent::validate(); |
592 | ||
bc999cd1 CW |
593 | $this->validateChainSelectFields(); |
594 | ||
be2fb01f | 595 | $hookErrors = []; |
6a488035 TO |
596 | |
597 | CRM_Utils_Hook::validateForm( | |
598 | get_class($this), | |
599 | $this->_submitValues, | |
600 | $this->_submitFiles, | |
601 | $this, | |
602 | $hookErrors | |
603 | ); | |
604 | ||
605 | if (!empty($hookErrors)) { | |
606 | $this->_errors += $hookErrors; | |
607 | } | |
608 | ||
609 | return (0 == count($this->_errors)); | |
610 | } | |
611 | ||
612 | /** | |
3bdf1f3a | 613 | * Core function that builds the form. |
614 | * | |
615 | * We redefine this function here and expect all CRM forms to build their form in the function | |
6a488035 | 616 | * buildQuickForm. |
6a488035 | 617 | */ |
00be9182 | 618 | public function buildForm() { |
6a488035 TO |
619 | $this->_formBuilt = TRUE; |
620 | ||
621 | $this->preProcess(); | |
622 | ||
21d2903d AN |
623 | CRM_Utils_Hook::preProcess(get_class($this), $this); |
624 | ||
6a488035 TO |
625 | $this->assign('translatePermission', CRM_Core_Permission::check('translate CiviCRM')); |
626 | ||
627 | if ( | |
628 | $this->controller->_key && | |
629 | $this->controller->_generateQFKey | |
630 | ) { | |
631 | $this->addElement('hidden', 'qfKey', $this->controller->_key); | |
632 | $this->assign('qfKey', $this->controller->_key); | |
ab435bd4 | 633 | |
6a488035 TO |
634 | } |
635 | ||
ab435bd4 DL |
636 | // _generateQFKey suppresses the qfKey generation on form snippets that |
637 | // are part of other forms, hence we use that to avoid adding entryURL | |
638 | if ($this->controller->_generateQFKey && $this->controller->_entryURL) { | |
3ab88a8c DL |
639 | $this->addElement('hidden', 'entryURL', $this->controller->_entryURL); |
640 | } | |
6a488035 TO |
641 | |
642 | $this->buildQuickForm(); | |
643 | ||
644 | $defaults = $this->setDefaultValues(); | |
645 | unset($defaults['qfKey']); | |
646 | ||
647 | if (!empty($defaults)) { | |
648 | $this->setDefaults($defaults); | |
649 | } | |
650 | ||
651 | // call the form hook | |
b44e3f84 | 652 | // also call the hook function so any modules can set their own custom defaults |
6a488035 TO |
653 | // the user can do both the form and set default values with this hook |
654 | CRM_Utils_Hook::buildForm(get_class($this), $this); | |
655 | ||
656 | $this->addRules(); | |
3e201321 | 657 | |
658 | //Set html data-attribute to enable warning user of unsaved changes | |
f9f40af3 | 659 | if ($this->unsavedChangesWarn === TRUE |
353ffa53 TO |
660 | || (!isset($this->unsavedChangesWarn) |
661 | && ($this->_action & CRM_Core_Action::ADD || $this->_action & CRM_Core_Action::UPDATE) | |
662 | ) | |
663 | ) { | |
f9f40af3 | 664 | $this->setAttribute('data-warn-changes', 'true'); |
3e201321 | 665 | } |
423616fa CW |
666 | |
667 | if ($this->submitOnce) { | |
668 | $this->setAttribute('data-submit-once', 'true'); | |
669 | } | |
6a488035 TO |
670 | } |
671 | ||
672 | /** | |
3bdf1f3a | 673 | * Add default Next / Back buttons. |
6a488035 | 674 | * |
6c552737 TO |
675 | * @param array $params |
676 | * Array of associative arrays in the order in which the buttons should be | |
677 | * displayed. The associate array has 3 fields: 'type', 'name' and 'isDefault' | |
678 | * The base form class will define a bunch of static arrays for commonly used | |
679 | * formats. | |
6a488035 | 680 | */ |
00be9182 | 681 | public function addButtons($params) { |
be2fb01f | 682 | $prevnext = $spacing = []; |
6a488035 | 683 | foreach ($params as $button) { |
d7fccec7 | 684 | if (!empty($button['submitOnce'])) { |
423616fa | 685 | $this->submitOnce = TRUE; |
d7fccec7 MWMC |
686 | } |
687 | ||
be2fb01f | 688 | $attrs = ['class' => 'crm-form-submit'] + (array) CRM_Utils_Array::value('js', $button); |
6a488035 | 689 | |
f7083334 AH |
690 | // A lot of forms use the hacky method of looking at |
691 | // `$params['button name']` (dating back to them being inputs with a | |
692 | // "value" of the button label) rather than looking at | |
693 | // `$this->controller->getButtonName()`. It makes sense to give buttons a | |
694 | // value by default as a precaution. | |
695 | $attrs['value'] = 1; | |
696 | ||
b01812e5 CW |
697 | if (!empty($button['class'])) { |
698 | $attrs['class'] .= ' ' . $button['class']; | |
699 | } | |
700 | ||
fdb0ca2c CW |
701 | if (!empty($button['isDefault'])) { |
702 | $attrs['class'] .= ' default'; | |
6a488035 TO |
703 | } |
704 | ||
be2fb01f | 705 | if (in_array($button['type'], ['upload', 'next', 'submit', 'done', 'process', 'refresh'])) { |
fdb0ca2c | 706 | $attrs['class'] .= ' validate'; |
f62db3ac | 707 | $defaultIcon = 'fa-check'; |
fdb0ca2c CW |
708 | } |
709 | else { | |
b61fd8cf | 710 | $attrs['class'] .= ' cancel'; |
f62db3ac | 711 | $defaultIcon = $button['type'] == 'back' ? 'fa-chevron-left' : 'fa-times'; |
b61fd8cf CW |
712 | } |
713 | ||
6a488035 | 714 | if ($button['type'] === 'reset') { |
cbd83dde AH |
715 | $attrs['type'] = 'reset'; |
716 | $prevnext[] = $this->createElement('xbutton', 'reset', $button['name'], $attrs); | |
6a488035 TO |
717 | } |
718 | else { | |
a7488080 | 719 | if (!empty($button['subName'])) { |
deae896d | 720 | if ($button['subName'] == 'new') { |
f62db3ac | 721 | $defaultIcon = 'fa-plus-circle'; |
deae896d | 722 | } |
fdb0ca2c | 723 | if ($button['subName'] == 'done') { |
f62db3ac | 724 | $defaultIcon = 'fa-check-circle'; |
fdb0ca2c CW |
725 | } |
726 | if ($button['subName'] == 'next') { | |
f62db3ac | 727 | $defaultIcon = 'fa-chevron-right'; |
fdb0ca2c | 728 | } |
6a488035 TO |
729 | } |
730 | ||
be2fb01f | 731 | if (in_array($button['type'], ['next', 'upload', 'done']) && $button['name'] === ts('Save')) { |
fdb0ca2c | 732 | $attrs['accesskey'] = 'S'; |
6a488035 | 733 | } |
98da7d67 | 734 | $buttonContents = CRM_Core_Page::crmIcon($button['icon'] ?? $defaultIcon) . ' ' . $button['name']; |
fdb0ca2c | 735 | $buttonName = $this->getButtonName($button['type'], CRM_Utils_Array::value('subName', $button)); |
57c59c34 | 736 | $attrs['class'] .= " crm-button crm-button-type-{$button['type']} crm-button{$buttonName}"; |
cbd83dde | 737 | $attrs['type'] = 'submit'; |
98da7d67 | 738 | $prevnext[] = $this->createElement('xbutton', $buttonName, $buttonContents, $attrs); |
6a488035 | 739 | } |
a7488080 | 740 | if (!empty($button['isDefault'])) { |
6a488035 TO |
741 | $this->setDefaultAction($button['type']); |
742 | } | |
743 | ||
744 | // if button type is upload, set the enctype | |
745 | if ($button['type'] == 'upload') { | |
be2fb01f | 746 | $this->updateAttributes(['enctype' => 'multipart/form-data']); |
6a488035 TO |
747 | $this->setMaxFileSize(); |
748 | } | |
749 | ||
750 | // hack - addGroup uses an array to express variable spacing, read from the last element | |
751 | $spacing[] = CRM_Utils_Array::value('spacing', $button, self::ATTR_SPACING); | |
752 | } | |
753 | $this->addGroup($prevnext, 'buttons', '', $spacing, FALSE); | |
754 | } | |
755 | ||
756 | /** | |
fe482240 | 757 | * Getter function for Name. |
6a488035 TO |
758 | * |
759 | * @return string | |
6a488035 | 760 | */ |
00be9182 | 761 | public function getName() { |
6a488035 TO |
762 | return $this->_name; |
763 | } | |
764 | ||
765 | /** | |
fe482240 | 766 | * Getter function for State. |
6a488035 TO |
767 | * |
768 | * @return object | |
6a488035 | 769 | */ |
00be9182 | 770 | public function &getState() { |
6a488035 TO |
771 | return $this->_state; |
772 | } | |
773 | ||
774 | /** | |
fe482240 | 775 | * Getter function for StateType. |
6a488035 TO |
776 | * |
777 | * @return int | |
6a488035 | 778 | */ |
00be9182 | 779 | public function getStateType() { |
6a488035 TO |
780 | return $this->_state->getType(); |
781 | } | |
782 | ||
783 | /** | |
3bdf1f3a | 784 | * Getter function for title. |
785 | * | |
786 | * Should be over-ridden by derived class. | |
6a488035 TO |
787 | * |
788 | * @return string | |
6a488035 | 789 | */ |
00be9182 | 790 | public function getTitle() { |
6a488035 TO |
791 | return $this->_title ? $this->_title : ts('ERROR: Title is not Set'); |
792 | } | |
793 | ||
794 | /** | |
100fef9d | 795 | * Setter function for title. |
6a488035 | 796 | * |
6a0b768e TO |
797 | * @param string $title |
798 | * The title of the form. | |
6a488035 | 799 | */ |
00be9182 | 800 | public function setTitle($title) { |
6a488035 | 801 | $this->_title = $title; |
d7188a5d | 802 | CRM_Utils_System::setTitle($title); |
6a488035 TO |
803 | } |
804 | ||
8345c9d3 EM |
805 | /** |
806 | * Assign billing type id to bltID. | |
807 | * | |
808 | * @throws CRM_Core_Exception | |
809 | */ | |
810 | public function assignBillingType() { | |
b576d770 | 811 | $this->_bltID = CRM_Core_BAO_LocationType::getBilling(); |
8345c9d3 EM |
812 | $this->set('bltID', $this->_bltID); |
813 | $this->assign('bltID', $this->_bltID); | |
814 | } | |
815 | ||
2204d007 MWMC |
816 | /** |
817 | * @return int | |
818 | */ | |
17dcf201 | 819 | public function getPaymentProcessorID(): int { |
820 | return (int) $this->_paymentProcessorID; | |
2204d007 MWMC |
821 | } |
822 | ||
1b9f9ca3 EM |
823 | /** |
824 | * This if a front end form function for setting the payment processor. | |
825 | * | |
826 | * It would be good to sync it with the back-end function on abstractEditPayment & use one everywhere. | |
827 | * | |
682c12c0 | 828 | * @param bool $isPayLaterEnabled |
cbcb5b49 | 829 | * |
1b9f9ca3 EM |
830 | * @throws \CRM_Core_Exception |
831 | */ | |
682c12c0 | 832 | protected function assignPaymentProcessor($isPayLaterEnabled) { |
95863863 | 833 | $this->_paymentProcessors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors([ucfirst($this->_mode) . 'Mode'], $this->_paymentProcessorIDs); |
682c12c0 JP |
834 | if ($isPayLaterEnabled) { |
835 | $this->_paymentProcessors[0] = CRM_Financial_BAO_PaymentProcessor::getPayment(0); | |
836 | } | |
1b9f9ca3 EM |
837 | |
838 | if (!empty($this->_paymentProcessors)) { | |
839 | foreach ($this->_paymentProcessors as $paymentProcessorID => $paymentProcessorDetail) { | |
840 | if (empty($this->_paymentProcessor) && $paymentProcessorDetail['is_default'] == 1 || (count($this->_paymentProcessors) == 1) | |
841 | ) { | |
842 | $this->_paymentProcessor = $paymentProcessorDetail; | |
843 | $this->assign('paymentProcessor', $this->_paymentProcessor); | |
844 | // Setting this is a bit of a legacy overhang. | |
845 | $this->_paymentObject = $paymentProcessorDetail['object']; | |
846 | } | |
847 | } | |
848 | // It's not clear why we set this on the form. | |
849 | $this->set('paymentProcessors', $this->_paymentProcessors); | |
850 | } | |
851 | else { | |
852 | throw new CRM_Core_Exception(ts('A payment processor configured for this page might be disabled (contact the site administrator for assistance).')); | |
853 | } | |
2e09448c | 854 | } |
f48e6cf7 | 855 | |
2e09448c MW |
856 | /** |
857 | * Assign an array of variables to the form/tpl | |
858 | * | |
859 | * @param array $values Array of [key => value] to assign to the form | |
860 | * @param array $keys Array of keys to assign from the values array | |
861 | */ | |
862 | public function assignVariables($values, $keys) { | |
863 | foreach ($keys as $key) { | |
864 | $this->assign($key, $values[$key] ?? NULL); | |
865 | } | |
1b9f9ca3 EM |
866 | } |
867 | ||
bddc8a28 | 868 | /** |
358b59a5 | 869 | * Format the fields in $this->_params for the payment processor. |
bddc8a28 | 870 | * |
871 | * In order to pass fields to the payment processor in a consistent way we add some renamed | |
872 | * parameters. | |
873 | * | |
874 | * @param array $fields | |
875 | * | |
876 | * @return array | |
877 | */ | |
878 | protected function formatParamsForPaymentProcessor($fields) { | |
358b59a5 MWMC |
879 | $this->_params = $this->prepareParamsForPaymentProcessor($this->_params); |
880 | $fields = array_merge($fields, ['first_name' => 1, 'middle_name' => 1, 'last_name' => 1]); | |
881 | return $fields; | |
882 | } | |
883 | ||
884 | /** | |
885 | * Format the fields in $params for the payment processor. | |
886 | * | |
887 | * In order to pass fields to the payment processor in a consistent way we add some renamed | |
888 | * parameters. | |
889 | * | |
890 | * @param array $params Payment processor params | |
891 | * | |
892 | * @return array $params | |
893 | */ | |
894 | protected function prepareParamsForPaymentProcessor($params) { | |
bddc8a28 | 895 | // also add location name to the array |
358b59a5 MWMC |
896 | $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); |
897 | $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]); | |
bddc8a28 | 898 | // Add additional parameters that the payment processors are used to receiving. |
358b59a5 MWMC |
899 | if (!empty($params["billing_state_province_id-{$this->_bltID}"])) { |
900 | $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}"]); | |
bddc8a28 | 901 | } |
358b59a5 MWMC |
902 | if (!empty($params["billing_country_id-{$this->_bltID}"])) { |
903 | $params['country'] = $params["country-{$this->_bltID}"] = $params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($params["billing_country_id-{$this->_bltID}"]); | |
bddc8a28 | 904 | } |
905 | ||
358b59a5 | 906 | list($hasAddressField, $addressParams) = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($params, $this->_bltID); |
bddc8a28 | 907 | if ($hasAddressField) { |
358b59a5 | 908 | $params = array_merge($params, $addressParams); |
bddc8a28 | 909 | } |
910 | ||
b0efa39e | 911 | // How does this relate to similar code in CRM_Contact_BAO_Contact::addBillingNameFieldsIfOtherwiseNotSet()? |
be2fb01f | 912 | $nameFields = ['first_name', 'middle_name', 'last_name']; |
bddc8a28 | 913 | foreach ($nameFields as $name) { |
358b59a5 MWMC |
914 | if (array_key_exists("billing_$name", $params)) { |
915 | $params[$name] = $params["billing_{$name}"]; | |
916 | $params['preserveDBName'] = TRUE; | |
bddc8a28 | 917 | } |
918 | } | |
b0efa39e MWMC |
919 | |
920 | // For legacy reasons we set these creditcard expiry fields if present | |
2e09448c | 921 | CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($params); |
b0efa39e MWMC |
922 | |
923 | // Assign IP address parameter | |
924 | $params['ip_address'] = CRM_Utils_System::ipAddress(); | |
925 | ||
358b59a5 | 926 | return $params; |
bddc8a28 | 927 | } |
928 | ||
42e3a033 EM |
929 | /** |
930 | * Handle Payment Processor switching for contribution and event registration forms. | |
931 | * | |
932 | * This function is shared between contribution & event forms & this is their common class. | |
933 | * | |
934 | * However, this should be seen as an in-progress refactor, the end goal being to also align the | |
935 | * backoffice forms that action payments. | |
936 | * | |
937 | * This function overlaps assignPaymentProcessor, in a bad way. | |
938 | */ | |
939 | protected function preProcessPaymentOptions() { | |
940 | $this->_paymentProcessorID = NULL; | |
941 | if ($this->_paymentProcessors) { | |
942 | if (!empty($this->_submitValues)) { | |
9c1bc317 CW |
943 | $this->_paymentProcessorID = $this->_submitValues['payment_processor_id'] ?? NULL; |
944 | $this->_paymentProcessor = $this->_paymentProcessors[$this->_paymentProcessorID] ?? NULL; | |
42e3a033 EM |
945 | $this->set('type', $this->_paymentProcessorID); |
946 | $this->set('mode', $this->_mode); | |
947 | $this->set('paymentProcessor', $this->_paymentProcessor); | |
948 | } | |
949 | // Set default payment processor | |
950 | else { | |
951 | foreach ($this->_paymentProcessors as $values) { | |
952 | if (!empty($values['is_default']) || count($this->_paymentProcessors) == 1) { | |
953 | $this->_paymentProcessorID = $values['id']; | |
954 | break; | |
955 | } | |
956 | } | |
957 | } | |
1d1fee72 | 958 | if ($this->_paymentProcessorID |
959 | || (isset($this->_submitValues['payment_processor_id']) && $this->_submitValues['payment_processor_id'] == 0) | |
960 | ) { | |
42e3a033 EM |
961 | CRM_Core_Payment_ProcessorForm::preProcess($this); |
962 | } | |
963 | else { | |
be2fb01f | 964 | $this->_paymentProcessor = []; |
42e3a033 | 965 | } |
42e3a033 | 966 | } |
2204d007 | 967 | |
f48e6cf7 | 968 | // We save the fact that the profile 'billing' is required on the payment form. |
969 | // Currently pay-later is the only 'processor' that takes notice of this - but ideally | |
970 | // 1) it would be possible to select the minimum_billing_profile_id for the contribution form | |
971 | // 2) that profile_id would be set on the payment processor | |
972 | // 3) the payment processor would return a billing form that combines these user-configured | |
973 | // minimums with the payment processor minimums. This would lead to fields like 'postal_code' | |
974 | // only being on the form if either the admin has configured it as wanted or the processor | |
975 | // requires it. | |
e71c1326 | 976 | $this->assign('billing_profile_id', (!empty($this->_values['is_billing_required']) ? 'billing' : '')); |
42e3a033 | 977 | } |
1b9f9ca3 | 978 | |
ec022878 | 979 | /** |
980 | * Handle pre approval for processors. | |
981 | * | |
982 | * This fits with the flow where a pre-approval is done and then confirmed in the next stage when confirm is hit. | |
983 | * | |
984 | * This function is shared between contribution & event forms & this is their common class. | |
985 | * | |
986 | * However, this should be seen as an in-progress refactor, the end goal being to also align the | |
987 | * backoffice forms that action payments. | |
988 | * | |
989 | * @param array $params | |
990 | */ | |
991 | protected function handlePreApproval(&$params) { | |
992 | try { | |
993 | $payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor); | |
a9c65036 | 994 | $params['component'] = $params['component'] ?? 'contribute'; |
ec022878 | 995 | $result = $payment->doPreApproval($params); |
996 | if (empty($result)) { | |
997 | // This could happen, for example, when paypal looks at the button value & decides it is not paypal express. | |
998 | return; | |
999 | } | |
1000 | } | |
1001 | catch (\Civi\Payment\Exception\PaymentProcessorException $e) { | |
abfb35ee | 1002 | CRM_Core_Error::statusBounce(ts('Payment approval failed with message :') . $e->getMessage(), $payment->getCancelUrl($params['qfKey'], CRM_Utils_Array::value('participant_id', $params))); |
ec022878 | 1003 | } |
1004 | ||
1005 | $this->set('pre_approval_parameters', $result['pre_approval_parameters']); | |
1006 | if (!empty($result['redirect_url'])) { | |
1007 | CRM_Utils_System::redirect($result['redirect_url']); | |
1008 | } | |
1009 | } | |
1010 | ||
6a488035 | 1011 | /** |
fe482240 | 1012 | * Setter function for options. |
6a488035 | 1013 | * |
6c552737 | 1014 | * @param mixed $options |
6a488035 | 1015 | */ |
00be9182 | 1016 | public function setOptions($options) { |
6a488035 TO |
1017 | $this->_options = $options; |
1018 | } | |
1019 | ||
6a488035 | 1020 | /** |
fe482240 | 1021 | * Render form and return contents. |
6a488035 TO |
1022 | * |
1023 | * @return string | |
6a488035 | 1024 | */ |
00be9182 | 1025 | public function toSmarty() { |
1d07e7ab | 1026 | $this->preProcessChainSelectFields(); |
6a488035 TO |
1027 | $renderer = $this->getRenderer(); |
1028 | $this->accept($renderer); | |
1029 | $content = $renderer->toArray(); | |
1030 | $content['formName'] = $this->getName(); | |
b50fdacc CW |
1031 | // CRM-15153 |
1032 | $content['formClass'] = CRM_Utils_System::getClassName($this); | |
6a488035 TO |
1033 | return $content; |
1034 | } | |
1035 | ||
1036 | /** | |
3bdf1f3a | 1037 | * Getter function for renderer. |
1038 | * | |
1039 | * If renderer is not set create one and initialize it. | |
6a488035 TO |
1040 | * |
1041 | * @return object | |
6a488035 | 1042 | */ |
00be9182 | 1043 | public function &getRenderer() { |
6a488035 TO |
1044 | if (!isset($this->_renderer)) { |
1045 | $this->_renderer = CRM_Core_Form_Renderer::singleton(); | |
1046 | } | |
1047 | return $this->_renderer; | |
1048 | } | |
1049 | ||
1050 | /** | |
fe482240 | 1051 | * Use the form name to create the tpl file name. |
6a488035 TO |
1052 | * |
1053 | * @return string | |
6a488035 | 1054 | */ |
00be9182 | 1055 | public function getTemplateFileName() { |
6a488035 TO |
1056 | $ext = CRM_Extension_System::singleton()->getMapper(); |
1057 | if ($ext->isExtensionClass(CRM_Utils_System::getClassName($this))) { | |
1058 | $filename = $ext->getTemplateName(CRM_Utils_System::getClassName($this)); | |
1059 | $tplname = $ext->getTemplatePath(CRM_Utils_System::getClassName($this)) . DIRECTORY_SEPARATOR . $filename; | |
1060 | } | |
1061 | else { | |
9b591d79 TO |
1062 | $tplname = strtr( |
1063 | CRM_Utils_System::getClassName($this), | |
be2fb01f | 1064 | [ |
9b591d79 TO |
1065 | '_' => DIRECTORY_SEPARATOR, |
1066 | '\\' => DIRECTORY_SEPARATOR, | |
be2fb01f | 1067 | ] |
9b591d79 | 1068 | ) . '.tpl'; |
6a488035 TO |
1069 | } |
1070 | return $tplname; | |
1071 | } | |
1072 | ||
8aac22c8 | 1073 | /** |
3bdf1f3a | 1074 | * A wrapper for getTemplateFileName. |
1075 | * | |
1076 | * This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook. | |
8aac22c8 | 1077 | */ |
00be9182 | 1078 | public function getHookedTemplateFileName() { |
8aac22c8 | 1079 | $pageTemplateFile = $this->getTemplateFileName(); |
1080 | CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile); | |
1081 | return $pageTemplateFile; | |
1082 | } | |
1083 | ||
6a488035 | 1084 | /** |
3bdf1f3a | 1085 | * Default extra tpl file basically just replaces .tpl with .extra.tpl. |
1086 | * | |
1087 | * i.e. we do not override. | |
6a488035 TO |
1088 | * |
1089 | * @return string | |
6a488035 | 1090 | */ |
00be9182 | 1091 | public function overrideExtraTemplateFileName() { |
6a488035 TO |
1092 | return NULL; |
1093 | } | |
1094 | ||
1095 | /** | |
fe482240 | 1096 | * Error reporting mechanism. |
6a488035 | 1097 | * |
6a0b768e TO |
1098 | * @param string $message |
1099 | * Error Message. | |
1100 | * @param int $code | |
1101 | * Error Code. | |
1102 | * @param CRM_Core_DAO $dao | |
1103 | * A data access object on which we perform a rollback if non - empty. | |
6a488035 | 1104 | */ |
00be9182 | 1105 | public function error($message, $code = NULL, $dao = NULL) { |
6a488035 TO |
1106 | if ($dao) { |
1107 | $dao->query('ROLLBACK'); | |
1108 | } | |
1109 | ||
1110 | $error = CRM_Core_Error::singleton(); | |
1111 | ||
1112 | $error->push($code, $message); | |
1113 | } | |
1114 | ||
1115 | /** | |
fe482240 | 1116 | * Store the variable with the value in the form scope. |
6a488035 | 1117 | * |
6c552737 TO |
1118 | * @param string $name |
1119 | * Name of the variable. | |
1120 | * @param mixed $value | |
1121 | * Value of the variable. | |
6a488035 | 1122 | */ |
00be9182 | 1123 | public function set($name, $value) { |
6a488035 TO |
1124 | $this->controller->set($name, $value); |
1125 | } | |
1126 | ||
1127 | /** | |
fe482240 | 1128 | * Get the variable from the form scope. |
6a488035 | 1129 | * |
6c552737 TO |
1130 | * @param string $name |
1131 | * Name of the variable | |
6a488035 TO |
1132 | * |
1133 | * @return mixed | |
6a488035 | 1134 | */ |
00be9182 | 1135 | public function get($name) { |
6a488035 TO |
1136 | return $this->controller->get($name); |
1137 | } | |
1138 | ||
1139 | /** | |
fe482240 | 1140 | * Getter for action. |
6a488035 TO |
1141 | * |
1142 | * @return int | |
6a488035 | 1143 | */ |
00be9182 | 1144 | public function getAction() { |
6a488035 TO |
1145 | return $this->_action; |
1146 | } | |
1147 | ||
1148 | /** | |
fe482240 | 1149 | * Setter for action. |
6a488035 | 1150 | * |
6a0b768e TO |
1151 | * @param int $action |
1152 | * The mode we want to set the form. | |
6a488035 | 1153 | */ |
00be9182 | 1154 | public function setAction($action) { |
6a488035 TO |
1155 | $this->_action = $action; |
1156 | } | |
1157 | ||
1158 | /** | |
fe482240 | 1159 | * Assign value to name in template. |
6a488035 | 1160 | * |
6a0b768e TO |
1161 | * @param string $var |
1162 | * Name of variable. | |
1163 | * @param mixed $value | |
1164 | * Value of variable. | |
6a488035 | 1165 | */ |
00be9182 | 1166 | public function assign($var, $value = NULL) { |
6a488035 TO |
1167 | self::$_template->assign($var, $value); |
1168 | } | |
1169 | ||
1170 | /** | |
fe482240 | 1171 | * Assign value to name in template by reference. |
6a488035 | 1172 | * |
6a0b768e TO |
1173 | * @param string $var |
1174 | * Name of variable. | |
1175 | * @param mixed $value | |
8eedd10a | 1176 | * Value of variable. |
6a488035 | 1177 | */ |
00be9182 | 1178 | public function assign_by_ref($var, &$value) { |
6a488035 TO |
1179 | self::$_template->assign_by_ref($var, $value); |
1180 | } | |
1181 | ||
4a9538ac | 1182 | /** |
fe482240 | 1183 | * Appends values to template variables. |
4a9538ac CW |
1184 | * |
1185 | * @param array|string $tpl_var the template variable name(s) | |
6a0b768e TO |
1186 | * @param mixed $value |
1187 | * The value to append. | |
4a9538ac CW |
1188 | * @param bool $merge |
1189 | */ | |
f9f40af3 | 1190 | public function append($tpl_var, $value = NULL, $merge = FALSE) { |
4a9538ac CW |
1191 | self::$_template->append($tpl_var, $value, $merge); |
1192 | } | |
1193 | ||
1194 | /** | |
fe482240 | 1195 | * Returns an array containing template variables. |
4a9538ac CW |
1196 | * |
1197 | * @param string $name | |
2a6da8d7 | 1198 | * |
4a9538ac CW |
1199 | * @return array |
1200 | */ | |
f9f40af3 | 1201 | public function get_template_vars($name = NULL) { |
4a9538ac CW |
1202 | return self::$_template->get_template_vars($name); |
1203 | } | |
1204 | ||
a0ee3941 | 1205 | /** |
100fef9d | 1206 | * @param string $name |
a0ee3941 EM |
1207 | * @param $title |
1208 | * @param $values | |
1209 | * @param array $attributes | |
1210 | * @param null $separator | |
1211 | * @param bool $required | |
15a05fc2 | 1212 | * @param array $optionAttributes - Option specific attributes |
a0ee3941 EM |
1213 | * |
1214 | * @return HTML_QuickForm_group | |
1215 | */ | |
15a05fc2 | 1216 | public function &addRadio($name, $title, $values, $attributes = [], $separator = NULL, $required = FALSE, $optionAttributes = []) { |
be2fb01f CW |
1217 | $options = []; |
1218 | $attributes = $attributes ? $attributes : []; | |
b847e6e7 CW |
1219 | $allowClear = !empty($attributes['allowClear']); |
1220 | unset($attributes['allowClear']); | |
385f11fd | 1221 | $attributes['id_suffix'] = $name; |
6a488035 | 1222 | foreach ($values as $key => $var) { |
15a05fc2 SL |
1223 | $optAttributes = $attributes; |
1224 | if (!empty($optionAttributes[$key])) { | |
1225 | foreach ($optionAttributes[$key] as $optAttr => $optVal) { | |
9ca69805 | 1226 | $optAttributes[$optAttr] = ltrim(($optAttributes[$optAttr] ?? '') . ' ' . $optVal); |
15a05fc2 SL |
1227 | } |
1228 | } | |
996b358b SL |
1229 | // We use a class here to avoid html5 issues with collapsed cutsomfield sets. |
1230 | $optAttributes['class'] = $optAttributes['class'] ?? ''; | |
dd283518 | 1231 | if ($required) { |
996b358b | 1232 | $optAttributes['class'] .= ' required'; |
dd283518 | 1233 | } |
996b358b | 1234 | $element = $this->createElement('radio', NULL, NULL, $var, $key, $optAttributes); |
dd283518 | 1235 | $options[] = $element; |
6a488035 TO |
1236 | } |
1237 | $group = $this->addGroup($options, $name, $title, $separator); | |
3ef93345 MD |
1238 | |
1239 | $optionEditKey = 'data-option-edit-path'; | |
1240 | if (!empty($attributes[$optionEditKey])) { | |
1241 | $group->setAttribute($optionEditKey, $attributes[$optionEditKey]); | |
1242 | } | |
1243 | ||
6a488035 | 1244 | if ($required) { |
be2fb01f | 1245 | $this->addRule($name, ts('%1 is a required field.', [1 => $title]), 'required'); |
6a488035 | 1246 | } |
b847e6e7 CW |
1247 | if ($allowClear) { |
1248 | $group->setAttribute('allowClear', TRUE); | |
8a4f27dc | 1249 | } |
6a488035 TO |
1250 | return $group; |
1251 | } | |
1252 | ||
a0ee3941 | 1253 | /** |
100fef9d | 1254 | * @param int $id |
a0ee3941 EM |
1255 | * @param $title |
1256 | * @param bool $allowClear | |
1257 | * @param null $required | |
1258 | * @param array $attributes | |
1259 | */ | |
be2fb01f CW |
1260 | public function addYesNo($id, $title, $allowClear = FALSE, $required = NULL, $attributes = []) { |
1261 | $attributes += ['id_suffix' => $id]; | |
1262 | $choice = []; | |
8a4f27dc CW |
1263 | $choice[] = $this->createElement('radio', NULL, '11', ts('Yes'), '1', $attributes); |
1264 | $choice[] = $this->createElement('radio', NULL, '11', ts('No'), '0', $attributes); | |
6a488035 | 1265 | |
8a4f27dc | 1266 | $group = $this->addGroup($choice, $id, $title); |
b847e6e7 CW |
1267 | if ($allowClear) { |
1268 | $group->setAttribute('allowClear', TRUE); | |
8a4f27dc | 1269 | } |
6a488035 | 1270 | if ($required) { |
be2fb01f | 1271 | $this->addRule($id, ts('%1 is a required field.', [1 => $title]), 'required'); |
6a488035 TO |
1272 | } |
1273 | } | |
1274 | ||
a0ee3941 | 1275 | /** |
100fef9d | 1276 | * @param int $id |
a0ee3941 EM |
1277 | * @param $title |
1278 | * @param $values | |
1279 | * @param null $other | |
1280 | * @param null $attributes | |
1281 | * @param null $required | |
1282 | * @param null $javascriptMethod | |
1283 | * @param string $separator | |
1284 | * @param bool $flipValues | |
1285 | */ | |
2da40d21 | 1286 | public function addCheckBox( |
f9f40af3 TO |
1287 | $id, $title, $values, $other = NULL, |
1288 | $attributes = NULL, $required = NULL, | |
6a488035 | 1289 | $javascriptMethod = NULL, |
f9f40af3 | 1290 | $separator = '<br />', $flipValues = FALSE |
6a488035 | 1291 | ) { |
be2fb01f | 1292 | $options = []; |
6a488035 TO |
1293 | |
1294 | if ($javascriptMethod) { | |
1295 | foreach ($values as $key => $var) { | |
1296 | if (!$flipValues) { | |
3ef93345 | 1297 | $options[] = $this->createElement('checkbox', $var, NULL, $key, $javascriptMethod, $attributes); |
6a488035 TO |
1298 | } |
1299 | else { | |
3ef93345 | 1300 | $options[] = $this->createElement('checkbox', $key, NULL, $var, $javascriptMethod, $attributes); |
6a488035 TO |
1301 | } |
1302 | } | |
1303 | } | |
1304 | else { | |
1305 | foreach ($values as $key => $var) { | |
1306 | if (!$flipValues) { | |
3ef93345 | 1307 | $options[] = $this->createElement('checkbox', $var, NULL, $key, $attributes); |
6a488035 TO |
1308 | } |
1309 | else { | |
3ef93345 | 1310 | $options[] = $this->createElement('checkbox', $key, NULL, $var, $attributes); |
6a488035 TO |
1311 | } |
1312 | } | |
1313 | } | |
1314 | ||
3ef93345 MD |
1315 | $group = $this->addGroup($options, $id, $title, $separator); |
1316 | $optionEditKey = 'data-option-edit-path'; | |
1317 | if (!empty($attributes[$optionEditKey])) { | |
1318 | $group->setAttribute($optionEditKey, $attributes[$optionEditKey]); | |
1319 | } | |
6a488035 TO |
1320 | |
1321 | if ($other) { | |
1322 | $this->addElement('text', $id . '_other', ts('Other'), $attributes[$id . '_other']); | |
1323 | } | |
1324 | ||
1325 | if ($required) { | |
1326 | $this->addRule($id, | |
be2fb01f | 1327 | ts('%1 is a required field.', [1 => $title]), |
6a488035 TO |
1328 | 'required' |
1329 | ); | |
1330 | } | |
1331 | } | |
1332 | ||
00be9182 | 1333 | public function resetValues() { |
6a488035 | 1334 | $data = $this->controller->container(); |
be2fb01f | 1335 | $data['values'][$this->_name] = []; |
6a488035 TO |
1336 | } |
1337 | ||
1338 | /** | |
100fef9d | 1339 | * Simple shell that derived classes can call to add buttons to |
6a488035 TO |
1340 | * the form with a customized title for the main Submit |
1341 | * | |
6a0b768e TO |
1342 | * @param string $title |
1343 | * Title of the main button. | |
1344 | * @param string $nextType | |
1345 | * Button type for the form after processing. | |
fd31fa4c | 1346 | * @param string $backType |
423616fa | 1347 | * @param bool|string $submitOnce |
6a488035 | 1348 | */ |
00be9182 | 1349 | public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) { |
be2fb01f | 1350 | $buttons = []; |
6a488035 | 1351 | if ($backType != NULL) { |
be2fb01f | 1352 | $buttons[] = [ |
6a488035 TO |
1353 | 'type' => $backType, |
1354 | 'name' => ts('Previous'), | |
be2fb01f | 1355 | ]; |
6a488035 TO |
1356 | } |
1357 | if ($nextType != NULL) { | |
be2fb01f | 1358 | $nextButton = [ |
6a488035 TO |
1359 | 'type' => $nextType, |
1360 | 'name' => $title, | |
1361 | 'isDefault' => TRUE, | |
be2fb01f | 1362 | ]; |
6a488035 | 1363 | if ($submitOnce) { |
423616fa | 1364 | $this->submitOnce = TRUE; |
6a488035 TO |
1365 | } |
1366 | $buttons[] = $nextButton; | |
1367 | } | |
1368 | $this->addButtons($buttons); | |
1369 | } | |
1370 | ||
a0ee3941 | 1371 | /** |
100fef9d | 1372 | * @param string $name |
a0ee3941 EM |
1373 | * @param string $from |
1374 | * @param string $to | |
1375 | * @param string $label | |
1376 | * @param string $dateFormat | |
1377 | * @param bool $required | |
1378 | * @param bool $displayTime | |
1379 | */ | |
00be9182 | 1380 | public function addDateRange($name, $from = '_from', $to = '_to', $label = 'From:', $dateFormat = 'searchDate', $required = FALSE, $displayTime = FALSE) { |
eb81078f | 1381 | CRM_Core_Error::deprecatedFunctionWarning('Use CRM_Core_Form::addDatePickerRange insted'); |
6a488035 | 1382 | if ($displayTime) { |
be2fb01f CW |
1383 | $this->addDateTime($name . $from, $label, $required, ['formatType' => $dateFormat]); |
1384 | $this->addDateTime($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]); | |
0db6c3e1 TO |
1385 | } |
1386 | else { | |
be2fb01f CW |
1387 | $this->addDate($name . $from, $label, $required, ['formatType' => $dateFormat]); |
1388 | $this->addDate($name . $to, ts('To:'), $required, ['formatType' => $dateFormat]); | |
6a488035 TO |
1389 | } |
1390 | } | |
d5965a37 | 1391 | |
e2123607 | 1392 | /** |
1393 | * Add a search for a range using date picker fields. | |
1394 | * | |
1395 | * @param string $fieldName | |
1396 | * @param string $label | |
27cedb98 | 1397 | * @param bool $isDateTime |
1398 | * Is this a date-time field (not just date). | |
e2123607 | 1399 | * @param bool $required |
1400 | * @param string $fromLabel | |
1401 | * @param string $toLabel | |
6d6630cf SL |
1402 | * @param array $additionalOptions |
1403 | * @param string $to string to append to the to field. | |
1404 | * @param string $from string to append to the from field. | |
e2123607 | 1405 | */ |
6d6630cf SL |
1406 | public function addDatePickerRange($fieldName, $label, $isDateTime = FALSE, $required = FALSE, $fromLabel = 'From', $toLabel = 'To', $additionalOptions = [], |
1407 | $to = '_high', $from = '_low') { | |
e2123607 | 1408 | |
be2fb01f | 1409 | $options = [ |
e2123607 | 1410 | '' => ts('- any -'), |
1411 | 0 => ts('Choose Date Range'), | |
be2fb01f | 1412 | ] + CRM_Core_OptionGroup::values('relative_date_filters'); |
e2123607 | 1413 | |
6d6630cf SL |
1414 | if ($additionalOptions) { |
1415 | foreach ($additionalOptions as $key => $optionLabel) { | |
1416 | $options[$key] = $optionLabel; | |
1417 | } | |
1418 | } | |
1419 | ||
e2123607 | 1420 | $this->add('select', |
1421 | "{$fieldName}_relative", | |
1422 | $label, | |
1423 | $options, | |
1424 | $required, | |
736fb4c2 | 1425 | ['class' => 'crm-select2'] |
e2123607 | 1426 | ); |
db91a581 | 1427 | $attributes = ['formatType' => 'searchDate']; |
27cedb98 | 1428 | $extra = ['time' => $isDateTime]; |
6d6630cf SL |
1429 | $this->add('datepicker', $fieldName . $from, ts($fromLabel), $attributes, $required, $extra); |
1430 | $this->add('datepicker', $fieldName . $to, ts($toLabel), $attributes, $required, $extra); | |
e2123607 | 1431 | } |
1432 | ||
03225ad6 CW |
1433 | /** |
1434 | * Based on form action, return a string representing the api action. | |
1435 | * Used by addField method. | |
1436 | * | |
1437 | * Return string | |
1438 | */ | |
d5e4784e | 1439 | protected function getApiAction() { |
03225ad6 CW |
1440 | $action = $this->getAction(); |
1441 | if ($action & (CRM_Core_Action::UPDATE + CRM_Core_Action::ADD)) { | |
1442 | return 'create'; | |
1443 | } | |
889dbed8 | 1444 | if ($action & (CRM_Core_Action::VIEW + CRM_Core_Action::BROWSE + CRM_Core_Action::BASIC + CRM_Core_Action::ADVANCED + CRM_Core_Action::PREVIEW)) { |
03225ad6 CW |
1445 | return 'get'; |
1446 | } | |
079c7954 CW |
1447 | if ($action & (CRM_Core_Action::DELETE)) { |
1448 | return 'delete'; | |
1449 | } | |
03225ad6 | 1450 | // If you get this exception try adding more cases above. |
0e02cb01 | 1451 | throw new Exception("Cannot determine api action for " . get_class($this) . '.' . 'CRM_Core_Action "' . CRM_Core_Action::description($action) . '" not recognized.'); |
03225ad6 CW |
1452 | } |
1453 | ||
6e62b28c | 1454 | /** |
d5965a37 | 1455 | * Classes extending CRM_Core_Form should implement this method. |
6e62b28c TM |
1456 | * @throws Exception |
1457 | */ | |
1458 | public function getDefaultEntity() { | |
0e02cb01 | 1459 | throw new Exception("Cannot determine default entity. " . get_class($this) . " should implement getDefaultEntity()."); |
6e62b28c | 1460 | } |
6a488035 | 1461 | |
1ae720b3 TM |
1462 | /** |
1463 | * Classes extending CRM_Core_Form should implement this method. | |
1464 | * | |
1465 | * TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation. | |
1466 | * @throws Exception | |
1467 | */ | |
1468 | public function getDefaultContext() { | |
0e02cb01 | 1469 | throw new Exception("Cannot determine default context. " . get_class($this) . " should implement getDefaultContext()."); |
1ae720b3 TM |
1470 | } |
1471 | ||
5fafc9b0 | 1472 | /** |
fe482240 | 1473 | * Adds a select based on field metadata. |
5fafc9b0 | 1474 | * TODO: This could be even more generic and widget type (select in this case) could also be read from metadata |
475e9f44 | 1475 | * Perhaps a method like $form->bind($name) which would look up all metadata for named field |
6a0b768e TO |
1476 | * @param $name |
1477 | * Field name to go on the form. | |
1478 | * @param array $props | |
1479 | * Mix of html attributes and special properties, namely. | |
920600e1 CW |
1480 | * - entity (api entity name, can usually be inferred automatically from the form class) |
1481 | * - field (field name - only needed if different from name used on the form) | |
1482 | * - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link | |
1483 | * - placeholder - set to NULL to disable | |
d0def949 | 1484 | * - multiple - bool |
76773c5a | 1485 | * - context - @see CRM_Core_DAO::buildOptionsContext |
5fafc9b0 CW |
1486 | * @param bool $required |
1487 | * @throws CRM_Core_Exception | |
1488 | * @return HTML_QuickForm_Element | |
1489 | */ | |
be2fb01f | 1490 | public function addSelect($name, $props = [], $required = FALSE) { |
920600e1 | 1491 | if (!isset($props['entity'])) { |
6e62b28c | 1492 | $props['entity'] = $this->getDefaultEntity(); |
6a488035 | 1493 | } |
920600e1 CW |
1494 | if (!isset($props['field'])) { |
1495 | $props['field'] = strrpos($name, '[') ? rtrim(substr($name, 1 + strrpos($name, '[')), ']') : $name; | |
e869b07d | 1496 | } |
65e8615b CW |
1497 | if (!isset($props['context'])) { |
1498 | try { | |
1499 | $props['context'] = $this->getDefaultContext(); | |
1500 | } | |
1501 | // This is not a required param, so we'll ignore if this doesn't exist. | |
518fa0ee SL |
1502 | catch (Exception $e) { |
1503 | } | |
65e8615b | 1504 | } |
f76b27fe CW |
1505 | // Fetch options from the api unless passed explicitly |
1506 | if (isset($props['options'])) { | |
1507 | $options = $props['options']; | |
1508 | } | |
1509 | else { | |
76352fbc | 1510 | $info = civicrm_api3($props['entity'], 'getoptions', $props); |
f76b27fe CW |
1511 | $options = $info['values']; |
1512 | } | |
a2eb6152 AH |
1513 | if (!array_key_exists('placeholder', $props) && $placeholder = self::selectOrAnyPlaceholder($props, $required)) { |
1514 | $props['placeholder'] = $placeholder; | |
5fafc9b0 | 1515 | } |
5fafc9b0 CW |
1516 | // Handle custom field |
1517 | if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) { | |
1518 | list(, $id) = explode('_', $name); | |
2e1f50d6 | 1519 | $label = $props['label'] ?? CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', 'label', $id); |
475e9f44 | 1520 | $gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', 'option_group_id', $id); |
76773c5a CW |
1521 | if (CRM_Utils_Array::value('context', $props) != 'search') { |
1522 | $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); | |
1523 | } | |
5fafc9b0 CW |
1524 | } |
1525 | // Core field | |
6a488035 | 1526 | else { |
f76b27fe | 1527 | $info = civicrm_api3($props['entity'], 'getfields'); |
22e263ad | 1528 | foreach ($info['values'] as $uniqueName => $fieldSpec) { |
e869b07d | 1529 | if ( |
920600e1 CW |
1530 | $uniqueName === $props['field'] || |
1531 | CRM_Utils_Array::value('name', $fieldSpec) === $props['field'] || | |
be2fb01f | 1532 | in_array($props['field'], CRM_Utils_Array::value('api.aliases', $fieldSpec, [])) |
e869b07d CW |
1533 | ) { |
1534 | break; | |
1535 | } | |
6a488035 | 1536 | } |
2e1f50d6 | 1537 | $label = $props['label'] ?? $fieldSpec['title']; |
76773c5a | 1538 | if (CRM_Utils_Array::value('context', $props) != 'search') { |
599ae208 | 1539 | $props['data-option-edit-path'] = array_key_exists('option_url', $props) ? $props['option_url'] : CRM_Core_PseudoConstant::getOptionEditUrl($fieldSpec); |
76773c5a | 1540 | } |
6a488035 | 1541 | } |
920600e1 CW |
1542 | $props['class'] = (isset($props['class']) ? $props['class'] . ' ' : '') . "crm-select2"; |
1543 | $props['data-api-entity'] = $props['entity']; | |
1544 | $props['data-api-field'] = $props['field']; | |
76773c5a | 1545 | CRM_Utils_Array::remove($props, 'label', 'entity', 'field', 'option_url', 'options', 'context'); |
5fafc9b0 | 1546 | return $this->add('select', $name, $label, $options, $required, $props); |
6a488035 TO |
1547 | } |
1548 | ||
a2eb6152 AH |
1549 | /** |
1550 | * Handles a repeated bit supplying a placeholder for entity selection | |
1551 | * | |
1552 | * @param string $props | |
1553 | * The field properties, including the entity and context. | |
1554 | * @param bool $required | |
1555 | * If the field is required. | |
abe8ec96 AH |
1556 | * @param string $title |
1557 | * A field title, if applicable. | |
a2eb6152 AH |
1558 | * @return string |
1559 | * The placeholder text. | |
1560 | */ | |
abe8ec96 | 1561 | private static function selectOrAnyPlaceholder($props, $required, $title = NULL) { |
a2eb6152 AH |
1562 | if (empty($props['entity'])) { |
1563 | return NULL; | |
1564 | } | |
abe8ec96 AH |
1565 | if (!$title) { |
1566 | $daoToClass = CRM_Core_DAO_AllCoreTables::daoToClass(); | |
1567 | if (array_key_exists($props['entity'], $daoToClass)) { | |
1568 | $daoClass = $daoToClass[$props['entity']]; | |
1569 | $title = $daoClass::getEntityTitle(); | |
1570 | } | |
1571 | else { | |
1572 | $title = ts('option'); | |
1573 | } | |
a2eb6152 AH |
1574 | } |
1575 | if (($props['context'] ?? '') == 'search' && !$required) { | |
abe8ec96 | 1576 | return ts('- any %1 -', [1 => $title]); |
a2eb6152 | 1577 | } |
abe8ec96 | 1578 | return ts('- select %1 -', [1 => $title]); |
a2eb6152 AH |
1579 | } |
1580 | ||
7ec4548b TM |
1581 | /** |
1582 | * Adds a field based on metadata. | |
1583 | * | |
1584 | * @param $name | |
1585 | * Field name to go on the form. | |
1586 | * @param array $props | |
1587 | * Mix of html attributes and special properties, namely. | |
1588 | * - entity (api entity name, can usually be inferred automatically from the form class) | |
03225ad6 | 1589 | * - name (field name - only needed if different from name used on the form) |
7ec4548b TM |
1590 | * - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link |
1591 | * - placeholder - set to NULL to disable | |
1592 | * - multiple - bool | |
1593 | * - context - @see CRM_Core_DAO::buildOptionsContext | |
1594 | * @param bool $required | |
ed0ca248 | 1595 | * @param bool $legacyDate |
1596 | * Temporary param to facilitate the conversion of fields to use the datepicker in | |
1597 | * a controlled way. To convert the field the jcalendar code needs to be removed from the | |
1598 | * tpl as well. That file is intended to be EOL. | |
1599 | * | |
03225ad6 CW |
1600 | * @throws \CiviCRM_API3_Exception |
1601 | * @throws \Exception | |
518fa0ee SL |
1602 | * @return mixed |
1603 | * HTML_QuickForm_Element | |
1604 | * void | |
7ec4548b | 1605 | */ |
be2fb01f | 1606 | public function addField($name, $props = [], $required = FALSE, $legacyDate = TRUE) { |
1ae720b3 | 1607 | // Resolve context. |
916b6181 | 1608 | if (empty($props['context'])) { |
1ae720b3 TM |
1609 | $props['context'] = $this->getDefaultContext(); |
1610 | } | |
916b6181 | 1611 | $context = $props['context']; |
7ec4548b | 1612 | // Resolve entity. |
916b6181 | 1613 | if (empty($props['entity'])) { |
7ec4548b TM |
1614 | $props['entity'] = $this->getDefaultEntity(); |
1615 | } | |
1616 | // Resolve field. | |
916b6181 | 1617 | if (empty($props['name'])) { |
03225ad6 | 1618 | $props['name'] = strrpos($name, '[') ? rtrim(substr($name, 1 + strrpos($name, '[')), ']') : $name; |
7ec4548b | 1619 | } |
03225ad6 | 1620 | // Resolve action. |
916b6181 | 1621 | if (empty($props['action'])) { |
03225ad6 | 1622 | $props['action'] = $this->getApiAction(); |
7ec4548b | 1623 | } |
2b31bc15 CW |
1624 | |
1625 | // Handle custom fields | |
1626 | if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) { | |
1627 | $fieldId = (int) substr($name, 7); | |
916b6181 | 1628 | return CRM_Core_BAO_CustomField::addQuickFormElement($this, $name, $fieldId, $required, $context == 'search', CRM_Utils_Array::value('label', $props)); |
2b31bc15 CW |
1629 | } |
1630 | ||
1631 | // Core field - get metadata. | |
d60a6fba | 1632 | $fieldSpec = civicrm_api3($props['entity'], 'getfield', $props); |
03225ad6 | 1633 | $fieldSpec = $fieldSpec['values']; |
2e1f50d6 | 1634 | $fieldSpecLabel = $fieldSpec['html']['label'] ?? CRM_Utils_Array::value('title', $fieldSpec); |
80a96508 | 1635 | $label = CRM_Utils_Array::value('label', $props, $fieldSpecLabel); |
7ec4548b | 1636 | |
2e1f50d6 | 1637 | $widget = $props['type'] ?? $fieldSpec['html']['type']; |
916b6181 | 1638 | if ($widget == 'TextArea' && $context == 'search') { |
7ec4548b TM |
1639 | $widget = 'Text'; |
1640 | } | |
1641 | ||
be2fb01f | 1642 | $isSelect = (in_array($widget, [ |
518fa0ee | 1643 | 'Select', |
18680e7a | 1644 | 'Select2', |
518fa0ee SL |
1645 | 'CheckBoxGroup', |
1646 | 'RadioGroup', | |
1647 | 'Radio', | |
be2fb01f | 1648 | ])); |
7ec4548b TM |
1649 | |
1650 | if ($isSelect) { | |
2f32ed10 | 1651 | // Fetch options from the api unless passed explicitly. |
7ec4548b TM |
1652 | if (isset($props['options'])) { |
1653 | $options = $props['options']; | |
1654 | } | |
1655 | else { | |
2e1f50d6 | 1656 | $options = $fieldSpec['options'] ?? NULL; |
7ec4548b | 1657 | } |
916b6181 | 1658 | if ($context == 'search') { |
18680e7a | 1659 | $widget = $widget == 'Select2' ? $widget : 'Select'; |
65e8615b | 1660 | $props['multiple'] = CRM_Utils_Array::value('multiple', $props, TRUE); |
7ec4548b | 1661 | } |
7ec4548b TM |
1662 | |
1663 | // Add data for popup link. | |
3ef93345 MD |
1664 | $canEditOptions = CRM_Core_Permission::check('administer CiviCRM'); |
1665 | $hasOptionUrl = !empty($props['option_url']); | |
1666 | $optionUrlKeyIsSet = array_key_exists('option_url', $props); | |
1667 | $shouldAdd = $context !== 'search' && $isSelect && $canEditOptions; | |
1668 | ||
1669 | // Only add if key is not set, or if non-empty option url is provided | |
1670 | if (($hasOptionUrl || !$optionUrlKeyIsSet) && $shouldAdd) { | |
1671 | $optionUrl = $hasOptionUrl ? $props['option_url'] : | |
1672 | CRM_Core_PseudoConstant::getOptionEditUrl($fieldSpec); | |
1673 | $props['data-option-edit-path'] = $optionUrl; | |
7ec4548b | 1674 | $props['data-api-entity'] = $props['entity']; |
03225ad6 | 1675 | $props['data-api-field'] = $props['name']; |
7ec4548b TM |
1676 | } |
1677 | } | |
be2fb01f | 1678 | $props += CRM_Utils_Array::value('html', $fieldSpec, []); |
abe8ec96 AH |
1679 | if (in_array($widget, ['Select', 'Select2']) |
1680 | && !array_key_exists('placeholder', $props) | |
1681 | && $placeholder = self::selectOrAnyPlaceholder($props, $required, $label)) { | |
1682 | $props['placeholder'] = $placeholder; | |
1683 | } | |
65e8615b | 1684 | CRM_Utils_Array::remove($props, 'entity', 'name', 'context', 'label', 'action', 'type', 'option_url', 'options'); |
599ae208 | 1685 | |
b44e3f84 | 1686 | // TODO: refactor switch statement, to separate methods. |
7ec4548b TM |
1687 | switch ($widget) { |
1688 | case 'Text': | |
d8f1758d CW |
1689 | case 'Url': |
1690 | case 'Number': | |
1691 | case 'Email': | |
7ec4548b | 1692 | //TODO: Autodetect ranges |
2e1f50d6 | 1693 | $props['size'] = $props['size'] ?? 60; |
d8f1758d | 1694 | return $this->add(strtolower($widget), $name, $label, $props, $required); |
7ec4548b | 1695 | |
b4b53245 | 1696 | case 'hidden': |
2a300b65 | 1697 | return $this->add('hidden', $name, NULL, $props, $required); |
b4b53245 | 1698 | |
0efbca68 TM |
1699 | case 'TextArea': |
1700 | //Set default columns and rows for textarea. | |
2e1f50d6 CW |
1701 | $props['rows'] = $props['rows'] ?? 4; |
1702 | $props['cols'] = $props['cols'] ?? 60; | |
079f52de | 1703 | if (empty($props['maxlength']) && isset($fieldSpec['length'])) { |
ed71bbca | 1704 | $props['maxlength'] = $fieldSpec['length']; |
1705 | } | |
599ae208 | 1706 | return $this->add('textarea', $name, $label, $props, $required); |
0efbca68 | 1707 | |
db3ec100 | 1708 | case 'Select Date': |
ed0ca248 | 1709 | // This is a white list for fields that have been tested with |
1710 | // date picker. We should be able to remove the other | |
1711 | if ($legacyDate) { | |
1712 | //TODO: add range support | |
1713 | //TODO: Add date formats | |
1714 | //TODO: Add javascript template for dates. | |
1715 | return $this->addDate($name, $label, $required, $props); | |
1716 | } | |
1717 | else { | |
1718 | $fieldSpec = CRM_Utils_Date::addDateMetadataToField($fieldSpec, $fieldSpec); | |
db91a581 | 1719 | $attributes = ['format' => $fieldSpec['date_format']]; |
ed0ca248 | 1720 | return $this->add('datepicker', $name, $label, $attributes, $required, $fieldSpec['datepicker']['extra']); |
1721 | } | |
db3ec100 | 1722 | |
a4969aee | 1723 | case 'Radio': |
2e1f50d6 | 1724 | $separator = $props['separator'] ?? NULL; |
125d54e1 | 1725 | unset($props['separator']); |
ef3a048a | 1726 | if (!isset($props['allowClear'])) { |
125d54e1 | 1727 | $props['allowClear'] = !$required; |
ef3a048a | 1728 | } |
2a300b65 | 1729 | return $this->addRadio($name, $label, $options, $props, $separator, $required); |
a4969aee | 1730 | |
b248d52b | 1731 | case 'ChainSelect': |
be2fb01f | 1732 | $props += [ |
b248d52b CW |
1733 | 'required' => $required, |
1734 | 'label' => $label, | |
916b6181 | 1735 | 'multiple' => $context == 'search', |
be2fb01f | 1736 | ]; |
b248d52b CW |
1737 | return $this->addChainSelect($name, $props); |
1738 | ||
7ec4548b | 1739 | case 'Select': |
18680e7a | 1740 | case 'Select2': |
b248d52b | 1741 | $props['class'] = CRM_Utils_Array::value('class', $props, 'big') . ' crm-select2'; |
7ec4548b | 1742 | // TODO: Add and/or option for fields that store multiple values |
18680e7a | 1743 | return $this->add(strtolower($widget), $name, $label, $options, $required, $props); |
7ec4548b | 1744 | |
dd4706ef | 1745 | case 'CheckBoxGroup': |
2a300b65 | 1746 | return $this->addCheckBox($name, $label, array_flip($options), $required, $props); |
dd4706ef TM |
1747 | |
1748 | case 'RadioGroup': | |
2a300b65 | 1749 | return $this->addRadio($name, $label, $options, $props, NULL, $required); |
dd4706ef | 1750 | |
a4969aee | 1751 | case 'CheckBox': |
95c2e666 | 1752 | if ($context === 'search') { |
1753 | $this->addYesNo($name, $label, TRUE, FALSE, $props); | |
1754 | return; | |
1755 | } | |
2e1f50d6 | 1756 | $text = $props['text'] ?? NULL; |
999ab5e1 | 1757 | unset($props['text']); |
2a300b65 | 1758 | return $this->addElement('checkbox', $name, $label, $text, $props); |
a4969aee | 1759 | |
50471995 | 1760 | //add support for 'Advcheckbox' field |
1761 | case 'advcheckbox': | |
2e1f50d6 | 1762 | $text = $props['text'] ?? NULL; |
b0964781 | 1763 | unset($props['text']); |
1764 | return $this->addElement('advcheckbox', $name, $label, $text, $props); | |
50471995 | 1765 | |
33fa033c TM |
1766 | case 'File': |
1767 | // We should not build upload file in search mode. | |
916b6181 | 1768 | if ($context == 'search') { |
33fa033c TM |
1769 | return; |
1770 | } | |
2a300b65 | 1771 | $file = $this->add('file', $name, $label, $props, $required); |
33fa033c | 1772 | $this->addUploadElement($name); |
2a300b65 | 1773 | return $file; |
33fa033c | 1774 | |
b66c1d2c CW |
1775 | case 'RichTextEditor': |
1776 | return $this->add('wysiwyg', $name, $label, $props, $required); | |
1777 | ||
b58770ea | 1778 | case 'EntityRef': |
2a300b65 | 1779 | return $this->addEntityRef($name, $label, $props, $required); |
b58770ea | 1780 | |
e9bc5dcc | 1781 | case 'Password': |
2e1f50d6 | 1782 | $props['size'] = $props['size'] ?? 60; |
e9bc5dcc SL |
1783 | return $this->add('password', $name, $label, $props, $required); |
1784 | ||
7ec4548b TM |
1785 | // Check datatypes of fields |
1786 | // case 'Int': | |
1787 | //case 'Float': | |
1788 | //case 'Money': | |
7ec4548b TM |
1789 | //case read only fields |
1790 | default: | |
1791 | throw new Exception("Unsupported html-element " . $widget); | |
1792 | } | |
1793 | } | |
1794 | ||
6a488035 TO |
1795 | /** |
1796 | * Add a widget for selecting/editing/creating/copying a profile form | |
1797 | * | |
6a0b768e TO |
1798 | * @param string $name |
1799 | * HTML form-element name. | |
1800 | * @param string $label | |
1801 | * Printable label. | |
1802 | * @param string $allowCoreTypes | |
1803 | * Only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity'. | |
1804 | * @param string $allowSubTypes | |
1805 | * Only present a UFGroup if its group_type is compatible with $allowSubypes. | |
6a488035 | 1806 | * @param array $entities |
6a0b768e TO |
1807 | * @param bool $default |
1808 | * //CRM-15427. | |
54957108 | 1809 | * @param string $usedFor |
6a488035 | 1810 | */ |
37375016 | 1811 | public function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities, $default = FALSE, $usedFor = NULL) { |
6a488035 TO |
1812 | // Output widget |
1813 | // FIXME: Instead of adhoc serialization, use a single json_encode() | |
1814 | CRM_UF_Page_ProfileEditor::registerProfileScripts(); | |
1815 | CRM_UF_Page_ProfileEditor::registerSchemas(CRM_Utils_Array::collect('entity_type', $entities)); | |
be2fb01f | 1816 | $this->add('text', $name, $label, [ |
6a488035 TO |
1817 | 'class' => 'crm-profile-selector', |
1818 | // Note: client treats ';;' as equivalent to \0, and ';;' works better in HTML | |
1819 | 'data-group-type' => CRM_Core_BAO_UFGroup::encodeGroupType($allowCoreTypes, $allowSubTypes, ';;'), | |
1820 | 'data-entities' => json_encode($entities), | |
99e239bc | 1821 | //CRM-15427 |
1822 | 'data-default' => $default, | |
37375016 | 1823 | 'data-usedfor' => json_encode($usedFor), |
be2fb01f | 1824 | ]); |
6a488035 TO |
1825 | } |
1826 | ||
a0ee3941 EM |
1827 | /** |
1828 | * @return null | |
1829 | */ | |
6a488035 TO |
1830 | public function getRootTitle() { |
1831 | return NULL; | |
1832 | } | |
1833 | ||
a0ee3941 EM |
1834 | /** |
1835 | * @return string | |
1836 | */ | |
6a488035 TO |
1837 | public function getCompleteTitle() { |
1838 | return $this->getRootTitle() . $this->getTitle(); | |
1839 | } | |
1840 | ||
a0ee3941 EM |
1841 | /** |
1842 | * @return CRM_Core_Smarty | |
1843 | */ | |
00be9182 | 1844 | public static function &getTemplate() { |
6a488035 TO |
1845 | return self::$_template; |
1846 | } | |
1847 | ||
a0ee3941 EM |
1848 | /** |
1849 | * @param $elementName | |
1850 | */ | |
00be9182 | 1851 | public function addUploadElement($elementName) { |
6a488035 TO |
1852 | $uploadNames = $this->get('uploadNames'); |
1853 | if (!$uploadNames) { | |
be2fb01f | 1854 | $uploadNames = []; |
6a488035 TO |
1855 | } |
1856 | if (is_array($elementName)) { | |
1857 | foreach ($elementName as $name) { | |
1858 | if (!in_array($name, $uploadNames)) { | |
1859 | $uploadNames[] = $name; | |
1860 | } | |
1861 | } | |
1862 | } | |
1863 | else { | |
1864 | if (!in_array($elementName, $uploadNames)) { | |
1865 | $uploadNames[] = $elementName; | |
1866 | } | |
1867 | } | |
1868 | $this->set('uploadNames', $uploadNames); | |
1869 | ||
1870 | $config = CRM_Core_Config::singleton(); | |
1871 | if (!empty($uploadNames)) { | |
1872 | $this->controller->addUploadAction($config->customFileUploadDir, $uploadNames); | |
1873 | } | |
1874 | } | |
1875 | ||
a0ee3941 EM |
1876 | /** |
1877 | * @param $name | |
1878 | * | |
1879 | * @return null | |
1880 | */ | |
00be9182 | 1881 | public function getVar($name) { |
2e1f50d6 | 1882 | return $this->$name ?? NULL; |
6a488035 TO |
1883 | } |
1884 | ||
a0ee3941 EM |
1885 | /** |
1886 | * @param $name | |
1887 | * @param $value | |
1888 | */ | |
00be9182 | 1889 | public function setVar($name, $value) { |
6a488035 TO |
1890 | $this->$name = $value; |
1891 | } | |
1892 | ||
1893 | /** | |
fe482240 | 1894 | * Add date. |
6a488035 | 1895 | * |
013ac5df CW |
1896 | * @deprecated |
1897 | * Use $this->add('datepicker', ...) instead. | |
a1a2a83d TO |
1898 | * |
1899 | * @param string $name | |
1900 | * Name of the element. | |
1901 | * @param string $label | |
1902 | * Label of the element. | |
6a0b768e TO |
1903 | * @param bool $required |
1904 | * True if required. | |
a1a2a83d TO |
1905 | * @param array $attributes |
1906 | * Key / value pair. | |
6a488035 | 1907 | */ |
00be9182 | 1908 | public function addDate($name, $label, $required = FALSE, $attributes = NULL) { |
a7488080 | 1909 | if (!empty($attributes['formatType'])) { |
6a488035 | 1910 | // get actual format |
be2fb01f CW |
1911 | $params = ['name' => $attributes['formatType']]; |
1912 | $values = []; | |
6a488035 TO |
1913 | |
1914 | // cache date information | |
1915 | static $dateFormat; | |
1916 | $key = "dateFormat_" . str_replace(' ', '_', $attributes['formatType']); | |
a7488080 | 1917 | if (empty($dateFormat[$key])) { |
6a488035 TO |
1918 | CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_PreferencesDate', $params, $values); |
1919 | $dateFormat[$key] = $values; | |
1920 | } | |
1921 | else { | |
1922 | $values = $dateFormat[$key]; | |
1923 | } | |
1924 | ||
1925 | if ($values['date_format']) { | |
1926 | $attributes['format'] = $values['date_format']; | |
1927 | } | |
1928 | ||
a7488080 | 1929 | if (!empty($values['time_format'])) { |
6a488035 TO |
1930 | $attributes['timeFormat'] = $values['time_format']; |
1931 | } | |
1932 | $attributes['startOffset'] = $values['start']; | |
1933 | $attributes['endOffset'] = $values['end']; | |
1934 | } | |
1935 | ||
1936 | $config = CRM_Core_Config::singleton(); | |
a7488080 | 1937 | if (empty($attributes['format'])) { |
6a488035 TO |
1938 | $attributes['format'] = $config->dateInputFormat; |
1939 | } | |
1940 | ||
1941 | if (!isset($attributes['startOffset'])) { | |
1942 | $attributes['startOffset'] = 10; | |
1943 | } | |
1944 | ||
1945 | if (!isset($attributes['endOffset'])) { | |
1946 | $attributes['endOffset'] = 10; | |
1947 | } | |
1948 | ||
1949 | $this->add('text', $name, $label, $attributes); | |
1950 | ||
8cc574cf | 1951 | if (!empty($attributes['addTime']) || !empty($attributes['timeFormat'])) { |
6a488035 TO |
1952 | |
1953 | if (!isset($attributes['timeFormat'])) { | |
1954 | $timeFormat = $config->timeInputFormat; | |
1955 | } | |
1956 | else { | |
1957 | $timeFormat = $attributes['timeFormat']; | |
1958 | } | |
1959 | ||
1960 | // 1 - 12 hours and 2 - 24 hours, but for jquery widget it is 0 and 1 respectively | |
1961 | if ($timeFormat) { | |
1962 | $show24Hours = TRUE; | |
1963 | if ($timeFormat == 1) { | |
1964 | $show24Hours = FALSE; | |
1965 | } | |
1966 | ||
1967 | //CRM-6664 -we are having time element name | |
1968 | //in either flat string or an array format. | |
1969 | $elementName = $name . '_time'; | |
1970 | if (substr($name, -1) == ']') { | |
1971 | $elementName = substr($name, 0, strlen($name) - 1) . '_time]'; | |
1972 | } | |
1973 | ||
be2fb01f | 1974 | $this->add('text', $elementName, ts('Time'), ['timeFormat' => $show24Hours]); |
6a488035 TO |
1975 | } |
1976 | } | |
1977 | ||
1978 | if ($required) { | |
be2fb01f | 1979 | $this->addRule($name, ts('Please select %1', [1 => $label]), 'required'); |
8cc574cf | 1980 | if (!empty($attributes['addTime']) && !empty($attributes['addTimeRequired'])) { |
6a488035 TO |
1981 | $this->addRule($elementName, ts('Please enter a time.'), 'required'); |
1982 | } | |
1983 | } | |
1984 | } | |
1985 | ||
1986 | /** | |
013ac5df CW |
1987 | * Function that will add date and time. |
1988 | * | |
1989 | * @deprecated | |
1990 | * Use $this->add('datepicker', ...) instead. | |
54957108 | 1991 | * |
1992 | * @param string $name | |
1993 | * @param string $label | |
1994 | * @param bool $required | |
1995 | * @param null $attributes | |
6a488035 | 1996 | */ |
00be9182 | 1997 | public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) { |
be2fb01f | 1998 | $addTime = ['addTime' => TRUE]; |
6a488035 TO |
1999 | if (is_array($attributes)) { |
2000 | $attributes = array_merge($attributes, $addTime); | |
2001 | } | |
2002 | else { | |
2003 | $attributes = $addTime; | |
2004 | } | |
2005 | ||
2006 | $this->addDate($name, $label, $required, $attributes); | |
2007 | } | |
2008 | ||
2009 | /** | |
fe482240 | 2010 | * Add a currency and money element to the form. |
3bdf1f3a | 2011 | * |
2012 | * @param string $name | |
2013 | * @param string $label | |
2014 | * @param bool $required | |
2015 | * @param null $attributes | |
2016 | * @param bool $addCurrency | |
2017 | * @param string $currencyName | |
2018 | * @param null $defaultCurrency | |
2019 | * @param bool $freezeCurrency | |
2020 | * | |
2021 | * @return \HTML_QuickForm_Element | |
6a488035 | 2022 | */ |
2da40d21 | 2023 | public function addMoney( |
f9f40af3 | 2024 | $name, |
6a488035 | 2025 | $label, |
f9f40af3 TO |
2026 | $required = FALSE, |
2027 | $attributes = NULL, | |
2028 | $addCurrency = TRUE, | |
2029 | $currencyName = 'currency', | |
6a488035 | 2030 | $defaultCurrency = NULL, |
f9f40af3 | 2031 | $freezeCurrency = FALSE |
6a488035 TO |
2032 | ) { |
2033 | $element = $this->add('text', $name, $label, $attributes, $required); | |
2034 | $this->addRule($name, ts('Please enter a valid amount.'), 'money'); | |
2035 | ||
2036 | if ($addCurrency) { | |
2037 | $ele = $this->addCurrency($currencyName, NULL, TRUE, $defaultCurrency, $freezeCurrency); | |
2038 | } | |
2039 | ||
2040 | return $element; | |
2041 | } | |
2042 | ||
2043 | /** | |
fe482240 | 2044 | * Add currency element to the form. |
54957108 | 2045 | * |
2046 | * @param string $name | |
2047 | * @param null $label | |
2048 | * @param bool $required | |
2049 | * @param string $defaultCurrency | |
2050 | * @param bool $freezeCurrency | |
483a53a8 | 2051 | * @param bool $setDefaultCurrency |
6a488035 | 2052 | */ |
2da40d21 | 2053 | public function addCurrency( |
f9f40af3 TO |
2054 | $name = 'currency', |
2055 | $label = NULL, | |
2056 | $required = TRUE, | |
6a488035 | 2057 | $defaultCurrency = NULL, |
483a53a8 | 2058 | $freezeCurrency = FALSE, |
2059 | $setDefaultCurrency = TRUE | |
6a488035 TO |
2060 | ) { |
2061 | $currencies = CRM_Core_OptionGroup::values('currencies_enabled'); | |
91a33228 | 2062 | if (!empty($defaultCurrency) && !array_key_exists($defaultCurrency, $currencies)) { |
b740ee4b MW |
2063 | Civi::log()->warning('addCurrency: Currency ' . $defaultCurrency . ' is disabled but still in use!'); |
2064 | $currencies[$defaultCurrency] = $defaultCurrency; | |
2065 | } | |
be2fb01f | 2066 | $options = ['class' => 'crm-select2 eight']; |
6a488035 | 2067 | if (!$required) { |
be2fb01f | 2068 | $currencies = ['' => ''] + $currencies; |
e1462487 | 2069 | $options['placeholder'] = ts('- none -'); |
6a488035 | 2070 | } |
e1462487 | 2071 | $ele = $this->add('select', $name, $label, $currencies, $required, $options); |
6a488035 TO |
2072 | if ($freezeCurrency) { |
2073 | $ele->freeze(); | |
2074 | } | |
2075 | if (!$defaultCurrency) { | |
2076 | $config = CRM_Core_Config::singleton(); | |
2077 | $defaultCurrency = $config->defaultCurrency; | |
2078 | } | |
483a53a8 | 2079 | // In some case, setting currency field by default might override the default value |
2080 | // as encountered in CRM-20527 for batch data entry | |
2081 | if ($setDefaultCurrency) { | |
be2fb01f | 2082 | $this->setDefaults([$name => $defaultCurrency]); |
483a53a8 | 2083 | } |
6a488035 TO |
2084 | } |
2085 | ||
47f21f3a | 2086 | /** |
fe482240 | 2087 | * Create a single or multiple entity ref field. |
47f21f3a CW |
2088 | * @param string $name |
2089 | * @param string $label | |
6a0b768e TO |
2090 | * @param array $props |
2091 | * Mix of html and widget properties, including:. | |
16b10e64 | 2092 | * - select - params to give to select2 widget |
2229cf4f | 2093 | * - entity - defaults to Contact |
16b10e64 | 2094 | * - create - can the user create a new entity on-the-fly? |
79ae07d9 | 2095 | * Set to TRUE if entity is contact and you want the default profiles, |
2229cf4f | 2096 | * or pass in your own set of links. @see CRM_Campaign_BAO_Campaign::getEntityRefCreateLinks for format |
353ea873 | 2097 | * note that permissions are checked automatically |
16b10e64 | 2098 | * - api - array of settings for the getlist api wrapper |
353ea873 | 2099 | * note that it accepts a 'params' setting which will be passed to the underlying api |
16b10e64 CW |
2100 | * - placeholder - string |
2101 | * - multiple - bool | |
2102 | * - class, etc. - other html properties | |
fd36866a | 2103 | * @param bool $required |
79ae07d9 | 2104 | * |
47f21f3a CW |
2105 | * @return HTML_QuickForm_Element |
2106 | */ | |
be2fb01f | 2107 | public function addEntityRef($name, $label = '', $props = [], $required = FALSE) { |
76ec9ca7 | 2108 | // Default properties |
be2fb01f | 2109 | $props['api'] = CRM_Utils_Array::value('api', $props, []); |
a2eb6152 | 2110 | $props['entity'] = CRM_Core_DAO_AllCoreTables::convertEntityNameToCamel($props['entity'] ?? 'Contact'); |
9ca69805 | 2111 | $props['class'] = ltrim(($props['class'] ?? '') . ' crm-form-entityref'); |
47f21f3a | 2112 | |
8dbd6052 | 2113 | if (array_key_exists('create', $props) && empty($props['create'])) { |
79ae07d9 CW |
2114 | unset($props['create']); |
2115 | } | |
79ae07d9 | 2116 | |
a2eb6152 | 2117 | $props['placeholder'] = $props['placeholder'] ?? self::selectOrAnyPlaceholder($props, $required); |
a88cf11a | 2118 | |
be2fb01f | 2119 | $defaults = []; |
a88cf11a CW |
2120 | if (!empty($props['multiple'])) { |
2121 | $defaults['multiple'] = TRUE; | |
79ae07d9 | 2122 | } |
be2fb01f | 2123 | $props['select'] = CRM_Utils_Array::value('select', $props, []) + $defaults; |
47f21f3a | 2124 | |
f9585de5 | 2125 | $this->formatReferenceFieldAttributes($props, get_class($this)); |
47f21f3a CW |
2126 | return $this->add('text', $name, $label, $props, $required); |
2127 | } | |
2128 | ||
2129 | /** | |
f9585de5 | 2130 | * @param array $props |
2131 | * @param string $formName | |
47f21f3a | 2132 | */ |
f9585de5 | 2133 | private function formatReferenceFieldAttributes(&$props, $formName) { |
2134 | CRM_Utils_Hook::alterEntityRefParams($props, $formName); | |
47f21f3a | 2135 | $props['data-select-params'] = json_encode($props['select']); |
76ec9ca7 CW |
2136 | $props['data-api-params'] = $props['api'] ? json_encode($props['api']) : NULL; |
2137 | $props['data-api-entity'] = $props['entity']; | |
79ae07d9 CW |
2138 | if (!empty($props['create'])) { |
2139 | $props['data-create-links'] = json_encode($props['create']); | |
47f21f3a | 2140 | } |
a88cf11a | 2141 | CRM_Utils_Array::remove($props, 'multiple', 'select', 'api', 'entity', 'create'); |
47f21f3a CW |
2142 | } |
2143 | ||
5d86176b | 2144 | /** |
2145 | * Convert all date fields within the params to mysql date ready for the | |
2146 | * BAO layer. In this case fields are checked against the $_datefields defined for the form | |
2147 | * and if time is defined it is incorporated | |
2148 | * | |
6a0b768e TO |
2149 | * @param array $params |
2150 | * Input params from the form. | |
5d86176b | 2151 | * |
2152 | * @todo it would probably be better to work on $this->_params than a passed array | |
2153 | * @todo standardise the format which dates are passed to the BAO layer in & remove date | |
2154 | * handling from BAO | |
2155 | */ | |
9b873358 TO |
2156 | public function convertDateFieldsToMySQL(&$params) { |
2157 | foreach ($this->_dateFields as $fieldName => $specs) { | |
2158 | if (!empty($params[$fieldName])) { | |
5d86176b | 2159 | $params[$fieldName] = CRM_Utils_Date::isoToMysql( |
2160 | CRM_Utils_Date::processDate( | |
353ffa53 TO |
2161 | $params[$fieldName], |
2162 | CRM_Utils_Array::value("{$fieldName}_time", $params), TRUE) | |
5d86176b | 2163 | ); |
2164 | } | |
92e4c2a5 | 2165 | else { |
9b873358 | 2166 | if (isset($specs['default'])) { |
5d86176b | 2167 | $params[$fieldName] = date('YmdHis', strtotime($specs['default'])); |
2168 | } | |
2169 | } | |
2170 | } | |
2171 | } | |
2172 | ||
a0ee3941 EM |
2173 | /** |
2174 | * @param $elementName | |
2175 | */ | |
00be9182 | 2176 | public function removeFileRequiredRules($elementName) { |
be2fb01f | 2177 | $this->_required = array_diff($this->_required, [$elementName]); |
6a488035 TO |
2178 | if (isset($this->_rules[$elementName])) { |
2179 | foreach ($this->_rules[$elementName] as $index => $ruleInfo) { | |
2180 | if ($ruleInfo['type'] == 'uploadedfile') { | |
2181 | unset($this->_rules[$elementName][$index]); | |
2182 | } | |
2183 | } | |
2184 | if (empty($this->_rules[$elementName])) { | |
2185 | unset($this->_rules[$elementName]); | |
2186 | } | |
2187 | } | |
2188 | } | |
2189 | ||
2190 | /** | |
fe482240 | 2191 | * Function that can be defined in Form to override or. |
6a488035 | 2192 | * perform specific action on cancel action |
6a488035 | 2193 | */ |
f9f40af3 TO |
2194 | public function cancelAction() { |
2195 | } | |
7cb3d4f0 CW |
2196 | |
2197 | /** | |
fe482240 | 2198 | * Helper function to verify that required fields have been filled. |
3bdf1f3a | 2199 | * |
7cb3d4f0 | 2200 | * Typically called within the scope of a FormRule function |
3bdf1f3a | 2201 | * |
2202 | * @param array $fields | |
2203 | * @param array $values | |
2204 | * @param array $errors | |
7cb3d4f0 | 2205 | */ |
00be9182 | 2206 | public static function validateMandatoryFields($fields, $values, &$errors) { |
7cb3d4f0 CW |
2207 | foreach ($fields as $name => $fld) { |
2208 | if (!empty($fld['is_required']) && CRM_Utils_System::isNull(CRM_Utils_Array::value($name, $values))) { | |
be2fb01f | 2209 | $errors[$name] = ts('%1 is a required field.', [1 => $fld['title']]); |
7cb3d4f0 CW |
2210 | } |
2211 | } | |
2212 | } | |
da8d9879 | 2213 | |
aa1b1481 EM |
2214 | /** |
2215 | * Get contact if for a form object. Prioritise | |
16b10e64 | 2216 | * - cid in URL if 0 (on behalf on someoneelse) |
aa1b1481 | 2217 | * (@todo consider setting a variable if onbehalf for clarity of downstream 'if's |
16b10e64 CW |
2218 | * - logged in user id if it matches the one in the cid in the URL |
2219 | * - contact id validated from a checksum from a checksum | |
2220 | * - cid from the url if the caller has ACL permission to view | |
2221 | * - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?) | |
aa1b1481 | 2222 | * |
5c766a0b | 2223 | * @return NULL|int |
aa1b1481 | 2224 | */ |
8d388047 | 2225 | protected function setContactID() { |
da8d9879 | 2226 | $tempID = CRM_Utils_Request::retrieve('cid', 'Positive', $this); |
7b4d7ab8 | 2227 | if (isset($this->_params) && !empty($this->_params['select_contact_id'])) { |
596bff78 | 2228 | $tempID = $this->_params['select_contact_id']; |
2229 | } | |
22e263ad | 2230 | if (isset($this->_params, $this->_params[0]) && !empty($this->_params[0]['select_contact_id'])) { |
e1ce628e | 2231 | // event form stores as an indexed array, contribution form not so much... |
2232 | $tempID = $this->_params[0]['select_contact_id']; | |
2233 | } | |
c156d4d6 | 2234 | |
da8d9879 | 2235 | // force to ignore the authenticated user |
c156d4d6 E |
2236 | if ($tempID === '0' || $tempID === 0) { |
2237 | // we set the cid on the form so that this will be retained for the Confirm page | |
2238 | // in the multi-page form & prevent us returning the $userID when this is called | |
2239 | // from that page | |
2240 | // we don't really need to set it when $tempID is set because the params have that stored | |
2241 | $this->set('cid', 0); | |
be2fb01f | 2242 | CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]); |
aa288d3f | 2243 | return (int) $tempID; |
da8d9879 DG |
2244 | } |
2245 | ||
596bff78 | 2246 | $userID = $this->getLoggedInUserContactID(); |
da8d9879 | 2247 | |
18406494 | 2248 | if (!is_null($tempID) && $tempID === $userID) { |
be2fb01f | 2249 | CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]); |
aa288d3f | 2250 | return (int) $userID; |
da8d9879 DG |
2251 | } |
2252 | ||
2253 | //check if this is a checksum authentication | |
2254 | $userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this); | |
2255 | if ($userChecksum) { | |
2256 | //check for anonymous user. | |
2257 | $validUser = CRM_Contact_BAO_Contact_Utils::validChecksum($tempID, $userChecksum); | |
2258 | if ($validUser) { | |
be2fb01f CW |
2259 | CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]); |
2260 | CRM_Core_Resources::singleton()->addVars('coreForm', ['checksum' => $userChecksum]); | |
da8d9879 DG |
2261 | return $tempID; |
2262 | } | |
2263 | } | |
2264 | // check if user has permission, CRM-12062 | |
4c9b6178 | 2265 | elseif ($tempID && CRM_Contact_BAO_Contact_Permission::allow($tempID)) { |
be2fb01f | 2266 | CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $tempID]); |
da8d9879 DG |
2267 | return $tempID; |
2268 | } | |
064af727 | 2269 | if (is_numeric($userID)) { |
be2fb01f | 2270 | CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $userID]); |
064af727 | 2271 | } |
f03d4901 | 2272 | return is_numeric($userID) ? $userID : NULL; |
da8d9879 | 2273 | } |
596bff78 | 2274 | |
3bdf1f3a | 2275 | /** |
2276 | * Get the contact id that the form is being submitted for. | |
2277 | * | |
e97c66ff | 2278 | * @return int|null |
3bdf1f3a | 2279 | */ |
8d388047 | 2280 | public function getContactID() { |
2281 | return $this->setContactID(); | |
2282 | } | |
2283 | ||
f9f40af3 | 2284 | /** |
fe482240 | 2285 | * Get the contact id of the logged in user. |
3f4728dd | 2286 | * |
2287 | * @return int|false | |
f9f40af3 | 2288 | */ |
00be9182 | 2289 | public function getLoggedInUserContactID() { |
596bff78 | 2290 | // check if the user is logged in and has a contact ID |
2291 | $session = CRM_Core_Session::singleton(); | |
3f4728dd | 2292 | return $session->get('userID') ? (int) $session->get('userID') : FALSE; |
596bff78 | 2293 | } |
2294 | ||
2295 | /** | |
100fef9d | 2296 | * Add autoselector field -if user has permission to view contacts |
596bff78 | 2297 | * If adding this to a form you also need to add to the tpl e.g |
2298 | * | |
2299 | * {if !empty($selectable)} | |
2300 | * <div class="crm-summary-row"> | |
2301 | * <div class="crm-label">{$form.select_contact.label}</div> | |
2302 | * <div class="crm-content"> | |
2303 | * {$form.select_contact.html} | |
2304 | * </div> | |
2305 | * </div> | |
2306 | * {/if} | |
77b97be7 | 2307 | * |
6a0b768e TO |
2308 | * @param array $profiles |
2309 | * Ids of profiles that are on the form (to be autofilled). | |
77b97be7 EM |
2310 | * @param array $autoCompleteField |
2311 | * | |
16b10e64 CW |
2312 | * - name_field |
2313 | * - id_field | |
2314 | * - url (for ajax lookup) | |
596bff78 | 2315 | * |
3f4728dd | 2316 | * @throws \CRM_Core_Exception |
77b97be7 | 2317 | * @todo add data attributes so we can deal with multiple instances on a form |
596bff78 | 2318 | */ |
be2fb01f CW |
2319 | public function addAutoSelector($profiles = [], $autoCompleteField = []) { |
2320 | $autoCompleteField = array_merge([ | |
353ffa53 TO |
2321 | 'id_field' => 'select_contact_id', |
2322 | 'placeholder' => ts('Select someone else ...'), | |
2323 | 'show_hide' => TRUE, | |
be2fb01f CW |
2324 | 'api' => ['params' => ['contact_type' => 'Individual']], |
2325 | ], $autoCompleteField); | |
596bff78 | 2326 | |
22e263ad | 2327 | if ($this->canUseAjaxContactLookups()) { |
25977d86 | 2328 | $this->assign('selectable', $autoCompleteField['id_field']); |
be2fb01f | 2329 | $this->addEntityRef($autoCompleteField['id_field'], NULL, [ |
518fa0ee SL |
2330 | 'placeholder' => $autoCompleteField['placeholder'], |
2331 | 'api' => $autoCompleteField['api'], | |
2332 | ]); | |
596bff78 | 2333 | |
96ed17aa | 2334 | CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/AlternateContactSelector.js', 1, 'html-header') |
be2fb01f CW |
2335 | ->addSetting([ |
2336 | 'form' => ['autocompletes' => $autoCompleteField], | |
2337 | 'ids' => ['profile' => $profiles], | |
2338 | ]); | |
596bff78 | 2339 | } |
2340 | } | |
2341 | ||
dc677c00 | 2342 | /** |
dc677c00 | 2343 | */ |
00be9182 | 2344 | public function canUseAjaxContactLookups() { |
be2fb01f CW |
2345 | if (0 < (civicrm_api3('contact', 'getcount', ['check_permissions' => 1])) && |
2346 | CRM_Core_Permission::check([['access AJAX API', 'access CiviCRM']]) | |
353ffa53 | 2347 | ) { |
f9f40af3 TO |
2348 | return TRUE; |
2349 | } | |
dc677c00 EM |
2350 | } |
2351 | ||
596bff78 | 2352 | /** |
2353 | * Add the options appropriate to cid = zero - ie. autocomplete | |
2354 | * | |
2355 | * @todo there is considerable code duplication between the contribution forms & event forms. It is apparent | |
2356 | * that small pieces of duplication are not being refactored into separate functions because their only shared parent | |
2357 | * is this form. Inserting a class FrontEndForm.php between the contribution & event & this class would allow functions like this | |
2358 | * and a dozen other small ones to be refactored into a shared parent with the reduction of much code duplication | |
2359 | */ | |
f956cd24 | 2360 | public function addCIDZeroOptions() { |
596bff78 | 2361 | $this->assign('nocid', TRUE); |
be2fb01f | 2362 | $profiles = []; |
22e263ad | 2363 | if ($this->_values['custom_pre_id']) { |
596bff78 | 2364 | $profiles[] = $this->_values['custom_pre_id']; |
2365 | } | |
22e263ad | 2366 | if ($this->_values['custom_post_id']) { |
cc57909a | 2367 | $profiles = array_merge($profiles, (array) $this->_values['custom_post_id']); |
596bff78 | 2368 | } |
f956cd24 | 2369 | $profiles[] = 'billing'; |
22e263ad | 2370 | if (!empty($this->_values)) { |
596bff78 | 2371 | $this->addAutoSelector($profiles); |
2372 | } | |
2373 | } | |
9d665938 | 2374 | |
2375 | /** | |
2376 | * Set default values on form for given contact (or no contact defaults) | |
77b97be7 | 2377 | * |
6a0b768e TO |
2378 | * @param mixed $profile_id |
2379 | * (can be id, or profile name). | |
2380 | * @param int $contactID | |
77b97be7 EM |
2381 | * |
2382 | * @return array | |
9d665938 | 2383 | */ |
00be9182 | 2384 | public function getProfileDefaults($profile_id = 'Billing', $contactID = NULL) { |
92e4c2a5 | 2385 | try { |
be2fb01f | 2386 | $defaults = civicrm_api3('profile', 'getsingle', [ |
9d665938 | 2387 | 'profile_id' => (array) $profile_id, |
2388 | 'contact_id' => $contactID, | |
be2fb01f | 2389 | ]); |
9d665938 | 2390 | return $defaults; |
2391 | } | |
2392 | catch (Exception $e) { | |
9d665938 | 2393 | // the try catch block gives us silent failure -not 100% sure this is a good idea |
2394 | // as silent failures are often worse than noisy ones | |
be2fb01f | 2395 | return []; |
9d665938 | 2396 | } |
2397 | } | |
cae80d9f CW |
2398 | |
2399 | /** | |
fe482240 | 2400 | * Sets form attribute. |
cae80d9f CW |
2401 | * @see CRM.loadForm |
2402 | */ | |
00be9182 | 2403 | public function preventAjaxSubmit() { |
cae80d9f CW |
2404 | $this->setAttribute('data-no-ajax-submit', 'true'); |
2405 | } | |
2406 | ||
2407 | /** | |
fe482240 | 2408 | * Sets form attribute. |
cae80d9f CW |
2409 | * @see CRM.loadForm |
2410 | */ | |
00be9182 | 2411 | public function allowAjaxSubmit() { |
cae80d9f CW |
2412 | $this->removeAttribute('data-no-ajax-submit'); |
2413 | } | |
e2046b33 CW |
2414 | |
2415 | /** | |
fe482240 | 2416 | * Sets page title based on entity and action. |
e2046b33 CW |
2417 | * @param string $entityLabel |
2418 | */ | |
00be9182 | 2419 | public function setPageTitle($entityLabel) { |
e2046b33 CW |
2420 | switch ($this->_action) { |
2421 | case CRM_Core_Action::ADD: | |
be2fb01f | 2422 | CRM_Utils_System::setTitle(ts('New %1', [1 => $entityLabel])); |
e2046b33 | 2423 | break; |
f9f40af3 | 2424 | |
e2046b33 | 2425 | case CRM_Core_Action::UPDATE: |
be2fb01f | 2426 | CRM_Utils_System::setTitle(ts('Edit %1', [1 => $entityLabel])); |
e2046b33 | 2427 | break; |
f9f40af3 | 2428 | |
e2046b33 CW |
2429 | case CRM_Core_Action::VIEW: |
2430 | case CRM_Core_Action::PREVIEW: | |
be2fb01f | 2431 | CRM_Utils_System::setTitle(ts('View %1', [1 => $entityLabel])); |
e2046b33 | 2432 | break; |
f9f40af3 | 2433 | |
e2046b33 | 2434 | case CRM_Core_Action::DELETE: |
be2fb01f | 2435 | CRM_Utils_System::setTitle(ts('Delete %1', [1 => $entityLabel])); |
e2046b33 CW |
2436 | break; |
2437 | } | |
2438 | } | |
1d07e7ab CW |
2439 | |
2440 | /** | |
2441 | * Create a chain-select target field. All settings are optional; the defaults usually work. | |
2442 | * | |
2443 | * @param string $elementName | |
2444 | * @param array $settings | |
2445 | * | |
2446 | * @return HTML_QuickForm_Element | |
2447 | */ | |
be2fb01f | 2448 | public function addChainSelect($elementName, $settings = []) { |
a9442e6e | 2449 | $required = $settings['required'] ?? FALSE; |
a2eb6152 | 2450 | $label = strpos($elementName, 'rovince') ? CRM_Core_DAO_StateProvince::getEntityTitle() : CRM_Core_DAO_County::getEntityTitle(); |
be2fb01f CW |
2451 | $props = $settings += [ |
2452 | 'control_field' => str_replace(['state_province', 'StateProvince', 'county', 'County'], [ | |
518fa0ee SL |
2453 | 'country', |
2454 | 'Country', | |
2455 | 'state_province', | |
2456 | 'StateProvince', | |
2457 | ], $elementName), | |
1d07e7ab | 2458 | 'data-callback' => strpos($elementName, 'rovince') ? 'civicrm/ajax/jqState' : 'civicrm/ajax/jqCounty', |
a2eb6152 | 2459 | 'label' => $label, |
1d07e7ab CW |
2460 | 'data-empty-prompt' => strpos($elementName, 'rovince') ? ts('Choose country first') : ts('Choose state first'), |
2461 | 'data-none-prompt' => ts('- N/A -'), | |
2462 | 'multiple' => FALSE, | |
a9442e6e | 2463 | 'required' => $required, |
a2eb6152 | 2464 | 'placeholder' => ts('- select %1 -', [1 => $label]), |
be2fb01f | 2465 | ]; |
b248d52b | 2466 | CRM_Utils_Array::remove($props, 'label', 'required', 'control_field', 'context'); |
a9442e6e | 2467 | $props['class'] = (empty($props['class']) ? '' : "{$props['class']} ") . 'crm-select2' . ($required ? ' required crm-field-required' : ''); |
1d07e7ab CW |
2468 | $props['data-select-prompt'] = $props['placeholder']; |
2469 | $props['data-name'] = $elementName; | |
2470 | ||
2471 | $this->_chainSelectFields[$settings['control_field']] = $elementName; | |
2472 | ||
6a6ab43a CW |
2473 | // Passing NULL instead of an array of options |
2474 | // CRM-15225 - normally QF will reject any selected values that are not part of the field's options, but due to a | |
2475 | // quirk in our patched version of HTML_QuickForm_select, this doesn't happen if the options are NULL | |
2476 | // which seems a bit dirty but it allows our dynamically-popuplated select element to function as expected. | |
a9442e6e | 2477 | return $this->add('select', $elementName, $settings['label'], NULL, $required, $props); |
1d07e7ab CW |
2478 | } |
2479 | ||
87ecd5b7 | 2480 | /** |
2481 | * Add actions menu to results form. | |
2482 | * | |
c794f667 | 2483 | * @param array $tasks |
87ecd5b7 | 2484 | */ |
2485 | public function addTaskMenu($tasks) { | |
2486 | if (is_array($tasks) && !empty($tasks)) { | |
1a7356e7 | 2487 | // Set constants means this will always load with an empty value, not reloading any submitted value. |
2488 | // This is appropriate as it is a pseudofield. | |
be2fb01f | 2489 | $this->setConstants(['task' => '']); |
44543184 | 2490 | $this->assign('taskMetaData', $tasks); |
be2fb01f | 2491 | $select = $this->add('select', 'task', NULL, ['' => ts('Actions')], FALSE, [ |
518fa0ee SL |
2492 | 'class' => 'crm-select2 crm-action-menu fa-check-circle-o huge crm-search-result-actions', |
2493 | ] | |
44543184 | 2494 | ); |
2495 | foreach ($tasks as $key => $task) { | |
be2fb01f | 2496 | $attributes = []; |
1a7356e7 | 2497 | if (isset($task['data'])) { |
2498 | foreach ($task['data'] as $dataKey => $dataValue) { | |
2499 | $attributes['data-' . $dataKey] = $dataValue; | |
2500 | } | |
44543184 | 2501 | } |
2502 | $select->addOption($task['title'], $key, $attributes); | |
2503 | } | |
87ecd5b7 | 2504 | if (empty($this->_actionButtonName)) { |
2505 | $this->_actionButtonName = $this->getButtonName('next', 'action'); | |
2506 | } | |
2507 | $this->assign('actionButtonName', $this->_actionButtonName); | |
cbd83dde AH |
2508 | $this->add('xbutton', $this->_actionButtonName, ts('Go'), [ |
2509 | 'type' => 'submit', | |
2510 | 'class' => 'hiddenElement crm-search-go-button', | |
2511 | ]); | |
87ecd5b7 | 2512 | |
2513 | // Radio to choose "All items" or "Selected items only" | |
be2fb01f | 2514 | $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', ['checked' => 'checked']); |
87ecd5b7 | 2515 | $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all'); |
2516 | $this->assign('ts_sel_id', $selectedRowsRadio->_attributes['id']); | |
2517 | $this->assign('ts_all_id', $allRowsRadio->_attributes['id']); | |
2518 | ||
2519 | CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.searchForm.js', 1, 'html-header'); | |
2520 | } | |
2521 | } | |
2522 | ||
1d07e7ab CW |
2523 | /** |
2524 | * Set options and attributes for chain select fields based on the controlling field's value | |
2525 | */ | |
2526 | private function preProcessChainSelectFields() { | |
2527 | foreach ($this->_chainSelectFields as $control => $target) { | |
a3984622 OB |
2528 | // The 'target' might get missing if extensions do removeElement() in a form hook. |
2529 | if ($this->elementExists($target)) { | |
2530 | $targetField = $this->getElement($target); | |
2531 | $targetType = $targetField->getAttribute('data-callback') == 'civicrm/ajax/jqCounty' ? 'county' : 'stateProvince'; | |
be2fb01f | 2532 | $options = []; |
a3984622 OB |
2533 | // If the control field is on the form, setup chain-select and dynamically populate options |
2534 | if ($this->elementExists($control)) { | |
2535 | $controlField = $this->getElement($control); | |
2536 | $controlType = $targetType == 'county' ? 'stateProvince' : 'country'; | |
2537 | ||
2538 | $targetField->setAttribute('class', $targetField->getAttribute('class') . ' crm-chain-select-target'); | |
2539 | ||
2540 | $css = (string) $controlField->getAttribute('class'); | |
be2fb01f | 2541 | $controlField->updateAttributes([ |
a3984622 OB |
2542 | 'class' => ($css ? "$css " : 'crm-select2 ') . 'crm-chain-select-control', |
2543 | 'data-target' => $target, | |
be2fb01f | 2544 | ]); |
a3984622 OB |
2545 | $controlValue = $controlField->getValue(); |
2546 | if ($controlValue) { | |
2547 | $options = CRM_Core_BAO_Location::getChainSelectValues($controlValue, $controlType, TRUE); | |
2548 | if (!$options) { | |
2549 | $targetField->setAttribute('placeholder', $targetField->getAttribute('data-none-prompt')); | |
2550 | } | |
4a44fd8a | 2551 | } |
b71cb966 | 2552 | else { |
a3984622 OB |
2553 | $targetField->setAttribute('placeholder', $targetField->getAttribute('data-empty-prompt')); |
2554 | $targetField->setAttribute('disabled', 'disabled'); | |
8f9c3cbe | 2555 | } |
0db6c3e1 | 2556 | } |
a3984622 | 2557 | // Control field not present - fall back to loading default options |
0db6c3e1 | 2558 | else { |
a3984622 | 2559 | $options = CRM_Core_PseudoConstant::$targetType(); |
1d07e7ab | 2560 | } |
a3984622 | 2561 | if (!$targetField->getAttribute('multiple')) { |
be2fb01f | 2562 | $options = ['' => $targetField->getAttribute('placeholder')] + $options; |
a3984622 OB |
2563 | $targetField->removeAttribute('placeholder'); |
2564 | } | |
be2fb01f | 2565 | $targetField->_options = []; |
a3984622 | 2566 | $targetField->loadArray($options); |
1d07e7ab | 2567 | } |
1d07e7ab CW |
2568 | } |
2569 | } | |
bc999cd1 CW |
2570 | |
2571 | /** | |
2572 | * Validate country / state / county match and suppress unwanted "required" errors | |
2573 | */ | |
2574 | private function validateChainSelectFields() { | |
2575 | foreach ($this->_chainSelectFields as $control => $target) { | |
a3984622 | 2576 | if ($this->elementExists($control) && $this->elementExists($target)) { |
f9f40af3 | 2577 | $controlValue = (array) $this->getElementValue($control); |
14b2ff15 CW |
2578 | $targetField = $this->getElement($target); |
2579 | $controlType = $targetField->getAttribute('data-callback') == 'civicrm/ajax/jqCounty' ? 'stateProvince' : 'country'; | |
f9f40af3 | 2580 | $targetValue = array_filter((array) $targetField->getValue()); |
14b2ff15 CW |
2581 | if ($targetValue || $this->getElementError($target)) { |
2582 | $options = CRM_Core_BAO_Location::getChainSelectValues($controlValue, $controlType, TRUE); | |
2583 | if ($targetValue) { | |
2584 | if (!array_intersect($targetValue, array_keys($options))) { | |
2585 | $this->setElementError($target, $controlType == 'country' ? ts('State/Province does not match the selected Country') : ts('County does not match the selected State/Province')); | |
2586 | } | |
518fa0ee SL |
2587 | } |
2588 | // Suppress "required" error for field if it has no options | |
14b2ff15 CW |
2589 | elseif (!$options) { |
2590 | $this->setElementError($target, NULL); | |
bc999cd1 CW |
2591 | } |
2592 | } | |
bc999cd1 CW |
2593 | } |
2594 | } | |
2595 | } | |
96025800 | 2596 | |
0b50eca0 | 2597 | /** |
2598 | * Assign billing name to the template. | |
2599 | * | |
2600 | * @param array $params | |
2601 | * Form input params, default to $this->_params. | |
f3f00653 | 2602 | * |
2603 | * @return string | |
0b50eca0 | 2604 | */ |
be2fb01f | 2605 | public function assignBillingName($params = []) { |
0b50eca0 | 2606 | $name = ''; |
2607 | if (empty($params)) { | |
2608 | $params = $this->_params; | |
2609 | } | |
2610 | if (!empty($params['billing_first_name'])) { | |
2611 | $name = $params['billing_first_name']; | |
2612 | } | |
2613 | ||
2614 | if (!empty($params['billing_middle_name'])) { | |
2615 | $name .= " {$params['billing_middle_name']}"; | |
2616 | } | |
2617 | ||
2618 | if (!empty($params['billing_last_name'])) { | |
2619 | $name .= " {$params['billing_last_name']}"; | |
2620 | } | |
2621 | $name = trim($name); | |
2622 | $this->assign('billingName', $name); | |
2623 | return $name; | |
2624 | } | |
2625 | ||
fd0770bc | 2626 | /** |
2627 | * Get the currency for the form. | |
2628 | * | |
2629 | * @todo this should be overriden on the forms rather than having this | |
2630 | * historic, possible handling in here. As we clean that up we should | |
2631 | * add deprecation notices into here. | |
e9bb043a | 2632 | * |
2633 | * @param array $submittedValues | |
2634 | * Array allowed so forms inheriting this class do not break. | |
2635 | * Ideally we would make a clear standard around how submitted values | |
2636 | * are stored (is $this->_values consistently doing that?). | |
2637 | * | |
2638 | * @return string | |
fd0770bc | 2639 | */ |
be2fb01f | 2640 | public function getCurrency($submittedValues = []) { |
9c1bc317 | 2641 | $currency = $this->_values['currency'] ?? NULL; |
fd0770bc | 2642 | // For event forms, currency is in a different spot |
2643 | if (empty($currency)) { | |
2644 | $currency = CRM_Utils_Array::value('currency', CRM_Utils_Array::value('event', $this->_values)); | |
2645 | } | |
2646 | if (empty($currency)) { | |
2647 | $currency = CRM_Utils_Request::retrieveValue('currency', 'String'); | |
2648 | } | |
2649 | // @todo If empty there is a problem - we should probably put in a deprecation notice | |
2650 | // to warn if that seems to be happening. | |
2651 | return $currency; | |
2652 | } | |
2653 | ||
240b0e65 | 2654 | /** |
2655 | * Is the form in view or edit mode. | |
2656 | * | |
2657 | * The 'addField' function relies on the form action being one of a set list | |
2658 | * of actions. Checking for these allows for an early return. | |
2659 | * | |
2660 | * @return bool | |
2661 | */ | |
189701bb ML |
2662 | protected function isFormInViewOrEditMode() { |
2663 | return $this->isFormInViewMode() || $this->isFormInEditMode(); | |
2664 | } | |
2665 | ||
2666 | /** | |
2667 | * Is the form in edit mode. | |
2668 | * | |
2669 | * Helper function, notably for extensions implementing the buildForm hook, | |
2670 | * so that they can return early. | |
2671 | * | |
2672 | * @return bool | |
2673 | */ | |
2674 | public function isFormInEditMode() { | |
240b0e65 | 2675 | return in_array($this->_action, [ |
2676 | CRM_Core_Action::UPDATE, | |
2677 | CRM_Core_Action::ADD, | |
240b0e65 | 2678 | CRM_Core_Action::BROWSE, |
2679 | CRM_Core_Action::BASIC, | |
2680 | CRM_Core_Action::ADVANCED, | |
2681 | CRM_Core_Action::PREVIEW, | |
2682 | ]); | |
2683 | } | |
2684 | ||
189701bb ML |
2685 | /** |
2686 | * Is the form in view mode. | |
2687 | * | |
2688 | * Helper function, notably for extensions implementing the buildForm hook, | |
2689 | * so that they can return early. | |
2690 | * | |
2691 | * @return bool | |
2692 | */ | |
2693 | public function isFormInViewMode() { | |
2694 | return $this->_action == CRM_Core_Action::VIEW; | |
2695 | } | |
2696 | ||
7885e669 MW |
2697 | /** |
2698 | * Set the active tab | |
2699 | * | |
2700 | * @param string $default | |
2701 | * | |
2702 | * @throws \CRM_Core_Exception | |
2703 | */ | |
2704 | public function setSelectedChild($default = NULL) { | |
2705 | $selectedChild = CRM_Utils_Request::retrieve('selectedChild', 'Alphanumeric', $this, FALSE, $default); | |
2706 | if (!empty($selectedChild)) { | |
2707 | $this->set('selectedChild', $selectedChild); | |
2708 | $this->assign('selectedChild', $selectedChild); | |
6a6458b6 | 2709 | Civi::resources()->addSetting(['tabSettings' => ['active' => $selectedChild]]); |
7885e669 MW |
2710 | } |
2711 | } | |
2712 | ||
3f4728dd | 2713 | /** |
2714 | * Get the contact if from the url, using the checksum or the cid if it is the logged in user. | |
2715 | * | |
2716 | * This function returns the user being validated. It is not intended to get another user | |
2717 | * they have permission to (setContactID does do that) and can be used to check if the user is | |
2718 | * accessing their own record. | |
2719 | * | |
2720 | * @return int|false | |
2721 | * @throws \CRM_Core_Exception | |
2722 | */ | |
2723 | protected function getContactIDIfAccessingOwnRecord() { | |
2724 | $contactID = (int) CRM_Utils_Request::retrieve('cid', 'Positive', $this); | |
2725 | if (!$contactID) { | |
2726 | return FALSE; | |
2727 | } | |
2728 | if ($contactID === $this->getLoggedInUserContactID()) { | |
2729 | return $contactID; | |
2730 | } | |
2731 | $userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this); | |
2732 | return CRM_Contact_BAO_Contact_Utils::validChecksum($contactID, $userChecksum) ? $contactID : FALSE; | |
2733 | } | |
2734 | ||
6aef1389 | 2735 | /** |
2736 | * Get values submitted by the user. | |
2737 | * | |
2738 | * These values have been validated against the fields added to the form. | |
2739 | * https://pear.php.net/manual/en/package.html.html-quickform.html-quickform.exportvalues.php | |
2740 | * | |
2741 | * @param string $fieldName | |
2742 | * | |
2743 | * @return mixed|null | |
2744 | */ | |
2745 | protected function getSubmittedValue(string $fieldName) { | |
2746 | if (empty($this->exportedValues)) { | |
2747 | $this->exportedValues = $this->controller->exportValues($this->_name); | |
2748 | } | |
2749 | return $this->exportedValues[$fieldName] ?? NULL; | |
2750 | } | |
2751 | ||
6a488035 | 2752 | } |