3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This is our base form. It is part of the Form/Controller/StateMachine
30 * trifecta. Each form is associated with a specific state in the state
31 * machine. Each form can also operate in various modes
34 * @copyright CiviCRM LLC (c) 2004-2013
39 require_once 'HTML/QuickForm/Page.php';
40 class CRM_Core_Form
extends HTML_QuickForm_Page
{
43 * The state object that this form belongs to
49 * The name of this form
55 * The title of this form
58 protected $_title = NULL;
61 * The options passed into this form
64 protected $_options = NULL;
67 * The mode of operation for this form
73 * the renderer used for this form
80 * An array to hold a list of datefields on the form
81 * so that they can be converted to ISO in a consistent manner
85 * e.g on a form declare $_dateFields = array(
86 * 'receive_date' => array('default' => 'now'),
88 * then in postProcess call $this->convertDateFieldsToMySQL($formValues)
89 * to have the time field re-incorporated into the field & 'now' set if
90 * no value has been passed in
92 protected $_dateFields = array();
95 * cache the smarty template for efficiency reasons
97 * @var CRM_Core_Smarty
99 static protected $_template;
102 * constants for attributes for various form elements
103 * attempt to standardize on the number of variations that we
104 * use of the below form elements
108 CONST ATTR_SPACING
= ' ';
111 * All checkboxes are defined with a common prefix. This allows us to
112 * have the same javascript to check / clear all the checkboxes etc
113 * If u have multiple groups of checkboxes, you will need to give them different
114 * ids to avoid potential name collision
116 * @var const string / int
118 CONST CB_PREFIX
= 'mark_x_', CB_PREFIY
= 'mark_y_', CB_PREFIZ
= 'mark_z_', CB_PREFIX_LEN
= 7;
121 * Constructor for the basic form page
123 * We should not use QuickForm directly. This class provides a lot
124 * of default convenient functions, rules and buttons
126 * @param object $state State associated with this form
127 * @param enum $action The mode the form is operating in (None/Create/View/Update/Delete)
128 * @param string $method The type of http method used (GET/POST)
129 * @param string $name The name of the form if different from class name
134 function __construct(
136 $action = CRM_Core_Action
::NONE
,
142 $this->_name
= $name;
145 $this->_name
= CRM_Utils_String
::getClassName(CRM_Utils_System
::getClassName($this));
148 $this->HTML_QuickForm_Page($this->_name
, $method);
150 $this->_state
=& $state;
152 $this->_state
->setName($this->_name
);
154 $this->_action
= (int) $action;
156 $this->registerRules();
158 // let the constructor initialize this, should happen only once
159 if (!isset(self
::$_template)) {
160 self
::$_template = CRM_Core_Smarty
::singleton();
164 static function generateID() {
168 * register all the standard rules that most forms potentially use
174 function registerRules() {
175 static $rules = array(
176 'title', 'longTitle', 'variable', 'qfVariable',
177 'phone', 'integer', 'query',
179 'domain', 'numberOfDigit',
180 'date', 'currentDate',
181 'asciiFile', 'htmlFile', 'utf8File',
182 'objectExists', 'optionExists', 'postalCode', 'money', 'positiveInteger',
183 'xssString', 'fileExists', 'autocomplete', 'validContact',
186 foreach ($rules as $rule) {
187 $this->registerRule($rule, 'callback', $rule, 'CRM_Utils_Rule');
192 * Simple easy to use wrapper around addElement. Deal with
193 * simple validation rules
195 * @param string type of html element to be added
196 * @param string name of the html element
197 * @param string display label for the html element
198 * @param string attributes used for this element.
199 * These are not default values
200 * @param bool is this a required field
202 * @return object html element, could be an error object
206 function &add($type, $name, $label = '',
207 $attributes = '', $required = FALSE, $javascript = NULL
209 $element = $this->addElement($type, $name, $label, $attributes, $javascript);
210 if (HTML_QuickForm
::isError($element)) {
211 CRM_Core_Error
::fatal(HTML_QuickForm
::errorMessage($element));
215 if ($type == 'file') {
216 $error = $this->addRule($name, ts('%1 is a required field.', array(1 => $label)), 'uploadedfile');
219 $error = $this->addRule($name, ts('%1 is a required field.', array(1 => $label)), 'required');
221 if (HTML_QuickForm
::isError($error)) {
222 CRM_Core_Error
::fatal(HTML_QuickForm
::errorMessage($element));
230 * This function is called before buildForm. Any pre-processing that
231 * needs to be done for buildForm should be done here
233 * This is a virtual function and should be redefined if needed
240 function preProcess() {}
243 * This function is called after the form is validated. Any
244 * processing of form state etc should be done in this function.
245 * Typically all processing associated with a form should be done
246 * here and relevant state should be stored in the session
248 * This is a virtual function and should be redefined if needed
255 function postProcess() {}
258 * This function is just a wrapper, so that we can call all the hook functions
260 function mainProcess() {
261 $this->postProcess();
263 $this->postProcessHook();
267 * The postProcess hook is typically called by the framework
268 * However in a few cases, the form exits or redirects early in which
269 * case it needs to call this function so other modules can do the needful
270 * Calling this function directly should be avoided if possible. In general a
271 * better way is to do setUserContext so the framework does the redirect
274 function postProcessHook() {
275 CRM_Utils_Hook
::postProcess(get_class($this), $this);
279 * This virtual function is used to build the form. It replaces the
280 * buildForm associated with QuickForm_Page. This allows us to put
281 * preProcess in front of the actual form building routine
288 function buildQuickForm() {}
291 * This virtual function is used to set the default values of
292 * various form elements
296 * @return array reference to the array of default values
299 function setDefaultValues() {}
302 * This is a virtual function that adds group and global rules to
303 * the form. Keeping it distinct from the form to keep code small
304 * and localized in the form building code
311 function addRules() {}
313 function validate() {
314 $error = parent
::validate();
316 $hookErrors = CRM_Utils_Hook
::validate(
318 $this->_submitValues
,
323 if (!is_array($hookErrors)) {
324 $hookErrors = array();
327 CRM_Utils_Hook
::validateForm(
329 $this->_submitValues
,
335 if (!empty($hookErrors)) {
336 $this->_errors +
= $hookErrors;
339 return (0 == count($this->_errors
));
343 * Core function that builds the form. We redefine this function
344 * here and expect all CRM forms to build their form in the function
348 function buildForm() {
349 $this->_formBuilt
= TRUE;
353 $this->assign('translatePermission', CRM_Core_Permission
::check('translate CiviCRM'));
356 $this->controller
->_key
&&
357 $this->controller
->_generateQFKey
359 $this->addElement('hidden', 'qfKey', $this->controller
->_key
);
360 $this->assign('qfKey', $this->controller
->_key
);
364 $this->buildQuickForm();
366 $defaults = $this->setDefaultValues();
367 unset($defaults['qfKey']);
369 if (!empty($defaults)) {
370 $this->setDefaults($defaults);
373 // call the form hook
374 // also call the hook function so any modules can set thier own custom defaults
375 // the user can do both the form and set default values with this hook
376 CRM_Utils_Hook
::buildForm(get_class($this), $this);
382 * Add default Next / Back buttons
384 * @param array array of associative arrays in the order in which the buttons should be
385 * displayed. The associate array has 3 fields: 'type', 'name' and 'isDefault'
386 * The base form class will define a bunch of static arrays for commonly used
394 function addButtons($params) {
397 foreach ($params as $button) {
398 $js = CRM_Utils_Array
::value('js', $button);
399 $isDefault = CRM_Utils_Array
::value('isDefault', $button, FALSE);
401 $attrs = array('class' => 'form-submit default');
404 $attrs = array('class' => 'form-submit');
408 $attrs = array_merge($js, $attrs);
411 if ($button['type'] === 'reset') {
412 $prevnext[] = $this->createElement($button['type'], 'reset', $button['name'], $attrs);
415 if (CRM_Utils_Array
::value('subName', $button)) {
416 $buttonName = $this->getButtonName($button['type'], $button['subName']);
419 $buttonName = $this->getButtonName($button['type']);
422 if (in_array($button['type'], array(
423 'next', 'upload')) && $button['name'] === 'Save') {
424 $attrs = array_merge($attrs, (array('accesskey' => 'S')));
426 $prevnext[] = $this->createElement('submit', $buttonName, $button['name'], $attrs);
428 if (CRM_Utils_Array
::value('isDefault', $button)) {
429 $this->setDefaultAction($button['type']);
432 // if button type is upload, set the enctype
433 if ($button['type'] == 'upload') {
434 $this->updateAttributes(array('enctype' => 'multipart/form-data'));
435 $this->setMaxFileSize();
438 // hack - addGroup uses an array to express variable spacing, read from the last element
439 $spacing[] = CRM_Utils_Array
::value('spacing', $button, self
::ATTR_SPACING
);
441 $this->addGroup($prevnext, 'buttons', '', $spacing, FALSE);
445 * getter function for Name
455 * getter function for State
460 function &getState() {
461 return $this->_state
;
465 * getter function for StateType
470 function getStateType() {
471 return $this->_state
->getType();
475 * getter function for title. Should be over-ridden by derived class
480 function getTitle() {
481 return $this->_title ?
$this->_title
: ts('ERROR: Title is not Set');
485 * setter function for title.
487 * @param string $title the title of the form
492 function setTitle($title) {
493 $this->_title
= $title;
497 * Setter function for options
504 function setOptions($options) {
505 $this->_options
= $options;
509 * getter function for link.
515 $config = CRM_Core_Config
::singleton();
516 return CRM_Utils_System
::url($_GET[$config->userFrameworkURLVar
],
517 '_qf_' . $this->_name
. '_display=true'
522 * boolean function to determine if this is a one form page
527 function isSimpleForm() {
528 return $this->_state
->getType() & (CRM_Core_State
::START | CRM_Core_State
::FINISH
);
532 * getter function for Form Action
537 function getFormAction() {
538 return $this->_attributes
['action'];
542 * setter function for Form Action
549 function setFormAction($action) {
550 $this->_attributes
['action'] = $action;
554 * render form and return contents
559 function toSmarty() {
560 $renderer = $this->getRenderer();
561 $this->accept($renderer);
562 $content = $renderer->toArray();
563 $content['formName'] = $this->getName();
568 * getter function for renderer. If renderer is not set
569 * create one and initialize it
574 function &getRenderer() {
575 if (!isset($this->_renderer
)) {
576 $this->_renderer
= CRM_Core_Form_Renderer
::singleton();
578 return $this->_renderer
;
582 * Use the form name to create the tpl file name
587 function getTemplateFileName() {
588 $ext = CRM_Extension_System
::singleton()->getMapper();
589 if ($ext->isExtensionClass(CRM_Utils_System
::getClassName($this))) {
590 $filename = $ext->getTemplateName(CRM_Utils_System
::getClassName($this));
591 $tplname = $ext->getTemplatePath(CRM_Utils_System
::getClassName($this)) . DIRECTORY_SEPARATOR
. $filename;
594 $tplname = str_replace('_',
596 CRM_Utils_System
::getClassName($this)
603 * Default extra tpl file basically just replaces .tpl with .extra.tpl
604 * i.e. we dont override
609 function overrideExtraTemplateFileName() {
614 * Error reporting mechanism
616 * @param string $message Error Message
617 * @param int $code Error Code
618 * @param CRM_Core_DAO $dao A data access object on which we perform a rollback if non - empty
623 function error($message, $code = NULL, $dao = NULL) {
625 $dao->query('ROLLBACK');
628 $error = CRM_Core_Error
::singleton();
630 $error->push($code, $message);
634 * Store the variable with the value in the form scope
636 * @param string name : name of the variable
637 * @param mixed value : value of the variable
644 function set($name, $value) {
645 $this->controller
->set($name, $value);
649 * Get the variable from the form scope
651 * @param string name : name of the variable
658 function get($name) {
659 return $this->controller
->get($name);
668 function getAction() {
669 return $this->_action
;
675 * @param int $action the mode we want to set the form
680 function setAction($action) {
681 $this->_action
= $action;
685 * assign value to name in template
687 * @param array|string $name name of variable
688 * @param mixed $value value of varaible
693 function assign($var, $value = NULL) {
694 self
::$_template->assign($var, $value);
698 * assign value to name in template by reference
700 * @param array|string $name name of variable
701 * @param mixed $value value of varaible
706 function assign_by_ref($var, &$value) {
707 self
::$_template->assign_by_ref($var, $value);
710 function &addRadio($name, $title, &$values, $attributes = NULL, $separator = NULL, $required = FALSE) {
712 if (empty($attributes)) {
713 $attributes = array('id_suffix' => $name);
716 $attributes = array_merge($attributes, array('id_suffix' => $name));
718 foreach ($values as $key => $var) {
719 $options[] = $this->createElement('radio', NULL, NULL, $var, $key, $attributes);
721 $group = $this->addGroup($options, $name, $title, $separator);
723 $this->addRule($name, ts('%1 is a required field.', array(1 => $title)), 'required');
728 function addYesNo($id, $title, $dontKnow = NULL, $required = NULL, $attribute = NULL) {
729 if (empty($attribute)) {
730 $attribute = array('id_suffix' => $id);
733 $attribute = array_merge($attribute, array('id_suffix' => $id));
736 $choice[] = $this->createElement('radio', NULL, '11', ts('Yes'), '1', $attribute);
737 $choice[] = $this->createElement('radio', NULL, '11', ts('No'), '0', $attribute);
739 $choice[] = $this->createElement('radio', NULL, '22', ts("Don't Know"), '2', $attribute);
741 $this->addGroup($choice, $id, $title);
744 $this->addRule($id, ts('%1 is a required field.', array(1 => $title)), 'required');
748 function addCheckBox($id, $title, $values, $other = NULL,
749 $attributes = NULL, $required = NULL,
750 $javascriptMethod = NULL,
751 $separator = '<br />', $flipValues = FALSE
755 if ($javascriptMethod) {
756 foreach ($values as $key => $var) {
758 $options[] = $this->createElement('checkbox', $var, NULL, $key, $javascriptMethod);
761 $options[] = $this->createElement('checkbox', $key, NULL, $var, $javascriptMethod);
766 foreach ($values as $key => $var) {
768 $options[] = $this->createElement('checkbox', $var, NULL, $key);
771 $options[] = $this->createElement('checkbox', $key, NULL, $var);
776 $this->addGroup($options, $id, $title, $separator);
779 $this->addElement('text', $id . '_other', ts('Other'), $attributes[$id . '_other']);
784 ts('%1 is a required field.', array(1 => $title)),
790 function resetValues() {
791 $data = $this->controller
->container();
792 $data['values'][$this->_name
] = array();
796 * simple shell that derived classes can call to add buttons to
797 * the form with a customized title for the main Submit
799 * @param string $title title of the main button
800 * @param string $type button type for the form after processing
801 * @param string $submitOnce If true, add javascript to next button submit which prevents it from being clicked more than once
806 function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
808 if ($backType != NULL) {
811 'name' => ts('Previous'),
814 if ($nextType != NULL) {
821 $nextButton['js'] = array('onclick' => "return submitOnce(this,'{$this->_name}','" . ts('Processing') . "');");
823 $buttons[] = $nextButton;
825 $this->addButtons($buttons);
828 function addDateRange($name, $from = '_from', $to = '_to', $label = 'From:', $dateFormat = 'searchDate', $required = FALSE, $displayTime = FALSE) {
830 $this->addDateTime($name . $from, $label, $required, array('formatType' => $dateFormat));
831 $this->addDateTime($name . $to, ts('To:'), $required, array('formatType' => $dateFormat));
833 $this->addDate($name . $from, $label, $required, array('formatType' => $dateFormat));
834 $this->addDate($name . $to, ts('To:'), $required, array('formatType' => $dateFormat));
838 function addSelect($name, $label, $prefix = NULL, $required = NULL, $extra = NULL, $select = '- select -') {
840 $this->addElement('select', $name . '_id' . $prefix, $label,
842 '' => $select) + CRM_Core_OptionGroup
::values($name), $extra
845 $this->addRule($name . '_id' . $prefix, ts('Please select %1', array(1 => $label)), 'required');
849 $this->addElement('select', $name . '_id', $label,
851 '' => $select) + CRM_Core_OptionGroup
::values($name), $extra
854 $this->addRule($name . '_id', ts('Please select %1', array(1 => $label)), 'required');
860 * Add a widget for selecting/editing/creating/copying a profile form
862 * @param string $name HTML form-element name
863 * @param string $label Printable label
864 * @param string $allowCoreTypes only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity'
865 * @param string $allowSubTypes only present a UFGroup if its group_type is compatible with $allowSubypes
866 * @param array $entities
868 function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities) {
870 // FIXME: Instead of adhoc serialization, use a single json_encode()
871 CRM_UF_Page_ProfileEditor
::registerProfileScripts();
872 CRM_UF_Page_ProfileEditor
::registerSchemas(CRM_Utils_Array
::collect('entity_type', $entities));
873 $this->add('text', $name, $label, array(
874 'class' => 'crm-profile-selector',
875 // Note: client treats ';;' as equivalent to \0, and ';;' works better in HTML
876 'data-group-type' => CRM_Core_BAO_UFGroup
::encodeGroupType($allowCoreTypes, $allowSubTypes, ';;'),
877 'data-entities' => json_encode($entities),
881 function addWysiwyg($name, $label, $attributes, $forceTextarea = FALSE) {
882 // 1. Get configuration option for editor (tinymce, ckeditor, pure textarea)
883 // 2. Based on the option, initialise proper editor
884 $editorID = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
887 $editor = strtolower(CRM_Utils_Array
::value($editorID,
888 CRM_Core_PseudoConstant
::wysiwygEditor()
890 if (!$editor ||
$forceTextarea) {
891 $editor = 'textarea';
893 if ($editor == 'joomla default editor') {
894 $editor = 'joomlaeditor';
897 if ($editor == 'drupal default editor') {
898 $editor = 'drupalwysiwyg';
901 //lets add the editor as a attribute
902 $attributes['editor'] = $editor;
904 $this->addElement($editor, $name, $label, $attributes);
905 $this->assign('editor', $editor);
907 // include wysiwyg editor js files
908 $includeWysiwygEditor = FALSE;
909 $includeWysiwygEditor = $this->get('includeWysiwygEditor');
910 if (!$includeWysiwygEditor) {
911 $includeWysiwygEditor = TRUE;
912 $this->set('includeWysiwygEditor', $includeWysiwygEditor);
915 $this->assign('includeWysiwygEditor', $includeWysiwygEditor);
918 function addCountry($id, $title, $required = NULL, $extra = NULL) {
919 $this->addElement('select', $id, $title,
921 '' => ts('- select -')) + CRM_Core_PseudoConstant
::country(), $extra
924 $this->addRule($id, ts('Please select %1', array(1 => $title)), 'required');
928 function addSelectOther($name, $label, $options, $attributes, $required = NULL, $javascriptMethod = NULL) {
930 $this->addElement('select', $name . '_id', $label, $options, $javascriptMethod);
933 $this->addRule($name . '_id', ts('Please select %1', array(1 => $label)), 'required');
937 function buildAddressBlock($locationId, $title, $phone,
938 $alternatePhone = NULL, $addressRequired = NULL,
939 $phoneRequired = NULL, $altPhoneRequired = NULL,
942 if (!$locationName) {
943 $locationName = "location";
946 $config = CRM_Core_Config
::singleton();
947 $attributes = CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Address');
949 $location[$locationId]['address']['street_address'] = $this->addElement('text', "{$locationName}[$locationId][address][street_address]", $title,
950 $attributes['street_address']
952 if ($addressRequired) {
953 $this->addRule("{$locationName}[$locationId][address][street_address]", ts("Please enter the Street Address for %1.", array(1 => $title)), 'required');
956 $location[$locationId]['address']['supplemental_address_1'] = $this->addElement('text', "{$locationName}[$locationId][address][supplemental_address_1]", ts('Additional Address 1'),
957 $attributes['supplemental_address_1']
959 $location[$locationId]['address']['supplemental_address_2'] = $this->addElement('text', "{$locationName}[$locationId][address][supplemental_address_2]", ts('Additional Address 2'),
960 $attributes['supplemental_address_2']
963 $location[$locationId]['address']['city'] = $this->addElement('text', "{$locationName}[$locationId][address][city]", ts('City'),
966 if ($addressRequired) {
967 $this->addRule("{$locationName}[$locationId][address][city]", ts("Please enter the City for %1.", array(1 => $title)), 'required');
970 $location[$locationId]['address']['postal_code'] = $this->addElement('text', "{$locationName}[$locationId][address][postal_code]", ts('Zip / Postal Code'),
971 $attributes['postal_code']
973 if ($addressRequired) {
974 $this->addRule("{$locationName}[$locationId][address][postal_code]", ts("Please enter the Zip/Postal Code for %1.", array(1 => $title)), 'required');
977 $location[$locationId]['address']['postal_code_suffix'] = $this->addElement('text', "{$locationName}[$locationId][address][postal_code_suffix]", ts('Add-on Code'),
978 array('size' => 4, 'maxlength' => 12)
980 $this->addRule("{$locationName}[$locationId][address][postal_code_suffix]", ts('Zip-Plus not valid.'), 'positiveInteger');
982 if ($config->includeCounty
) {
983 $location[$locationId]['address']['county_id'] = $this->addElement('select', "{$locationName}[$locationId][address][county_id]", ts('County'),
984 array('' => ts('- select -')) + CRM_Core_PseudoConstant
::county()
988 $location[$locationId]['address']['state_province_id'] = $this->addElement('select', "{$locationName}[$locationId][address][state_province_id]", ts('State / Province'),
989 array('' => ts('- select -')) + CRM_Core_PseudoConstant
::stateProvince()
992 $location[$locationId]['address']['country_id'] = $this->addElement('select', "{$locationName}[$locationId][address][country_id]", ts('Country'),
993 array('' => ts('- select -')) + CRM_Core_PseudoConstant
::country()
995 if ($addressRequired) {
996 $this->addRule("{$locationName}[$locationId][address][country_id]", ts("Please select the Country for %1.", array(1 => $title)), 'required');
1001 $location[$locationId]['phone'][1]['phone'] = $this->addElement('text',
1002 "{$locationName}[$locationId][phone][1][phone]",
1004 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Phone',
1008 if ($phoneRequired) {
1009 $this->addRule("{$locationName}[$locationId][phone][1][phone]", ts('Please enter a value for %1', array(1 => $phone)), 'required');
1011 $this->addRule("{$locationName}[$locationId][phone][1][phone]", ts('Please enter a valid number for %1', array(1 => $phone)), 'phone');
1014 if ($alternatePhone) {
1015 $location[$locationId]['phone'][2]['phone'] = $this->addElement('text',
1016 "{$locationName}[$locationId][phone][2][phone]",
1018 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Phone',
1022 if ($alternatePhoneRequired) {
1023 $this->addRule("{$locationName}[$locationId][phone][2][phone]", ts('Please enter a value for %1', array(1 => $alternatePhone)), 'required');
1025 $this->addRule("{$locationName}[$locationId][phone][2][phone]", ts('Please enter a valid number for %1', array(1 => $alternatePhone)), 'phone');
1029 public function getRootTitle() {
1033 public function getCompleteTitle() {
1034 return $this->getRootTitle() . $this->getTitle();
1037 static function &getTemplate() {
1038 return self
::$_template;
1041 function addUploadElement($elementName) {
1042 $uploadNames = $this->get('uploadNames');
1043 if (!$uploadNames) {
1044 $uploadNames = array();
1046 if (is_array($elementName)) {
1047 foreach ($elementName as $name) {
1048 if (!in_array($name, $uploadNames)) {
1049 $uploadNames[] = $name;
1054 if (!in_array($elementName, $uploadNames)) {
1055 $uploadNames[] = $elementName;
1058 $this->set('uploadNames', $uploadNames);
1060 $config = CRM_Core_Config
::singleton();
1061 if (!empty($uploadNames)) {
1062 $this->controller
->addUploadAction($config->customFileUploadDir
, $uploadNames);
1066 function buttonType() {
1067 $uploadNames = $this->get('uploadNames');
1068 $buttonType = (is_array($uploadNames) && !empty($uploadNames)) ?
'upload' : 'next';
1069 $this->assign('buttonType', $buttonType);
1073 function getVar($name) {
1074 return isset($this->$name) ?
$this->$name : NULL;
1077 function setVar($name, $value) {
1078 $this->$name = $value;
1082 * Function to add date
1083 * @param string $name name of the element
1084 * @param string $label label of the element
1085 * @param array $attributes key / value pair
1088 * $attributes = array ( 'addTime' => true,
1089 * 'formatType' => 'relative' or 'birth' etc check advanced date settings
1091 * @param boolean $required true if required
1094 function addDate($name, $label, $required = FALSE, $attributes = NULL) {
1095 if (CRM_Utils_Array
::value('formatType', $attributes)) {
1096 // get actual format
1097 $params = array('name' => $attributes['formatType']);
1100 // cache date information
1102 $key = "dateFormat_" . str_replace(' ', '_', $attributes['formatType']);
1103 if (!CRM_Utils_Array
::value($key, $dateFormat)) {
1104 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_PreferencesDate', $params, $values);
1105 $dateFormat[$key] = $values;
1108 $values = $dateFormat[$key];
1111 if ($values['date_format']) {
1112 $attributes['format'] = $values['date_format'];
1115 if (CRM_Utils_Array
::value('time_format', $values)) {
1116 $attributes['timeFormat'] = $values['time_format'];
1118 $attributes['startOffset'] = $values['start'];
1119 $attributes['endOffset'] = $values['end'];
1122 $config = CRM_Core_Config
::singleton();
1123 if (!CRM_Utils_Array
::value('format', $attributes)) {
1124 $attributes['format'] = $config->dateInputFormat
;
1127 if (!isset($attributes['startOffset'])) {
1128 $attributes['startOffset'] = 10;
1131 if (!isset($attributes['endOffset'])) {
1132 $attributes['endOffset'] = 10;
1135 $this->add('text', $name, $label, $attributes);
1137 if (CRM_Utils_Array
::value('addTime', $attributes) ||
1138 CRM_Utils_Array
::value('timeFormat', $attributes)
1141 if (!isset($attributes['timeFormat'])) {
1142 $timeFormat = $config->timeInputFormat
;
1145 $timeFormat = $attributes['timeFormat'];
1148 // 1 - 12 hours and 2 - 24 hours, but for jquery widget it is 0 and 1 respectively
1150 $show24Hours = TRUE;
1151 if ($timeFormat == 1) {
1152 $show24Hours = FALSE;
1155 //CRM-6664 -we are having time element name
1156 //in either flat string or an array format.
1157 $elementName = $name . '_time';
1158 if (substr($name, -1) == ']') {
1159 $elementName = substr($name, 0, strlen($name) - 1) . '_time]';
1162 $this->add('text', $elementName, ts('Time'), array('timeFormat' => $show24Hours));
1167 $this->addRule($name, ts('Please select %1', array(1 => $label)), 'required');
1168 if (CRM_Utils_Array
::value('addTime', $attributes) && CRM_Utils_Array
::value('addTimeRequired', $attributes)) {
1169 $this->addRule($elementName, ts('Please enter a time.'), 'required');
1175 * Function that will add date and time
1177 function addDateTime($name, $label, $required = FALSE, $attributes = NULL) {
1178 $addTime = array('addTime' => TRUE);
1179 if (is_array($attributes)) {
1180 $attributes = array_merge($attributes, $addTime);
1183 $attributes = $addTime;
1186 $this->addDate($name, $label, $required, $attributes);
1190 * add a currency and money element to the form
1192 function addMoney($name,
1196 $addCurrency = TRUE,
1197 $currencyName = 'currency',
1198 $defaultCurrency = NULL,
1199 $freezeCurrency = FALSE
1201 $element = $this->add('text', $name, $label, $attributes, $required);
1202 $this->addRule($name, ts('Please enter a valid amount.'), 'money');
1205 $ele = $this->addCurrency($currencyName, NULL, TRUE, $defaultCurrency, $freezeCurrency);
1212 * add currency element to the form
1214 function addCurrency($name = 'currency',
1217 $defaultCurrency = NULL,
1218 $freezeCurrency = FALSE
1220 $currencies = CRM_Core_OptionGroup
::values('currencies_enabled');
1222 $currencies = array(
1223 '' => ts('- select -')) +
$currencies;
1225 $ele = $this->add('select', $name, $label, $currencies, $required);
1226 if ($freezeCurrency) {
1229 if (!$defaultCurrency) {
1230 $config = CRM_Core_Config
::singleton();
1231 $defaultCurrency = $config->defaultCurrency
;
1233 $this->setDefaults(array($name => $defaultCurrency));
1237 * Convert all date fields within the params to mysql date ready for the
1238 * BAO layer. In this case fields are checked against the $_datefields defined for the form
1239 * and if time is defined it is incorporated
1241 * @param array $params input params from the form
1243 * @todo it would probably be better to work on $this->_params than a passed array
1244 * @todo standardise the format which dates are passed to the BAO layer in & remove date
1247 function convertDateFieldsToMySQL(&$params){
1248 foreach ($this->_dateFields
as $fieldName => $specs){
1249 if(!empty($params[$fieldName])){
1250 $params[$fieldName] = CRM_Utils_Date
::isoToMysql(
1251 CRM_Utils_Date
::processDate(
1252 $params[$fieldName],
1253 CRM_Utils_Array
::value("{$fieldName}_time", $params), TRUE)
1257 if(isset($specs['default'])){
1258 $params[$fieldName] = date('YmdHis', strtotime($specs['default']));
1264 function removeFileRequiredRules($elementName) {
1265 $this->_required
= array_diff($this->_required
, array($elementName));
1266 if (isset($this->_rules
[$elementName])) {
1267 foreach ($this->_rules
[$elementName] as $index => $ruleInfo) {
1268 if ($ruleInfo['type'] == 'uploadedfile') {
1269 unset($this->_rules
[$elementName][$index]);
1272 if (empty($this->_rules
[$elementName])) {
1273 unset($this->_rules
[$elementName]);
1279 * Function that can be defined in Form to override or
1280 * perform specific action on cancel action
1284 function cancelAction() {}
1287 * Helper function to verify that required fields have been filled
1288 * Typically called within the scope of a FormRule function
1290 static function validateMandatoryFields($fields, $values, &$errors) {
1291 foreach ($fields as $name => $fld) {
1292 if (!empty($fld['is_required']) && CRM_Utils_System
::isNull(CRM_Utils_Array
::value($name, $values))) {
1293 $errors[$name] = ts('%1 is a required field.', array(1 => $fld['title']));