CRM/Core/Form/Renderer.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35
  36 require_once 'HTML/QuickForm/Renderer/ArraySmarty.php';
  37
  38 /**
  39  * Customize QF output to meet our specific requirements
  40  */
  41 class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty {
  42
  43   /**
  44    * We only need one instance of this object. So we use the singleton
  45    * pattern and cache the instance in this variable
  46    *
  47    * @var object
  48    */
  49   static private $_singleton = NULL;
  50
  51   /**
  52    * The converter from array size to css class.
  53    *
  54    * @var array
  55    */
  56   static $_sizeMapper = array(
  57     2 => 'two',
  58     4 => 'four',
  59     6 => 'six',
  60     8 => 'eight',
  61     12 => 'twelve',
  62     20 => 'medium',
  63     30 => 'big',
  64     45 => 'huge',
  65   );
  66
  67   /**
  68    * Constructor.
  69    */
  70   public function __construct() {
  71     $template = CRM_Core_Smarty::singleton();
  72     parent::__construct($template);
  73   }
  74
  75   /**
  76    * Static instance provider.
  77    *
  78    * Method providing static instance of as in Singleton pattern.
  79    */
  80   public static function &singleton() {
  81     if (!isset(self::$_singleton)) {
  82       self::$_singleton = new CRM_Core_Form_Renderer();
  83     }
  84     return self::$_singleton;
  85   }
  86
  87   /**
  88    * Creates an array representing an element containing.
  89    * the key for storing this. We allow the parent to do most of the
  90    * work, but then we add some CiviCRM specific enhancements to
  91    * make the html compliant with our css etc
  92    *
  93    *
  94    * @param HTML_QuickForm_element $element
  95    * @param bool $required
  96    *   Whether an element is required.
  97    * @param string $error
  98    *   Error associated with the element.
  99    *
 100    * @return array
 101    */
 102   public function _elementToArray(&$element, $required, $error) {
 103     self::updateAttributes($element, $required, $error);
 104
 105     $el = parent::_elementToArray($element, $required, $error);
 106
 107     // add label html
 108     if (!empty($el['label'])) {
 109       $id = $element->getAttribute('id');
 110       if (!empty($id)) {
 111         $el['label'] = '<label for="' . $id . '">' . $el['label'] . '</label>';
 112       }
 113       else {
 114         $el['label'] = "<label>{$el['label']}</label>";
 115       }
 116     }
 117
 118     // Display-only (frozen) elements
 119     if (!empty($el['frozen'])) {
 120       if ($element->getAttribute('data-api-entity') && $element->getAttribute('data-entity-value')) {
 121         $this->renderFrozenEntityRef($el, $element);
 122       }
 123       elseif ($element->getAttribute('type') == 'text' && $element->getAttribute('data-select-params')) {
 124         $this->renderFrozenSelect2($el, $element);
 125       }
 126       elseif ($element->getAttribute('type') == 'text' && $element->getAttribute('data-crm-datepicker')) {
 127         $this->renderFrozenDatepicker($el, $element);
 128       }
 129       elseif ($element->getAttribute('type') == 'text' && $element->getAttribute('formatType')) {
 130         list($date, $time) = CRM_Utils_Date::setDateDefaults($element->getValue(), $element->getAttribute('formatType'), $element->getAttribute('format'), $element->getAttribute('timeformat'));
 131         $date .= ($element->getAttribute('timeformat')) ? " $time" : '';
 132         $el['html'] = $date . '<input type="hidden" value="' . $element->getValue() . '" name="' . $element->getAttribute('name') . '">';
 133       }
 134       // Render html for wysiwyg textareas
 135       if ($el['type'] == 'textarea' && isset($element->_attributes['class']) && strstr($element->_attributes['class'], 'wysiwyg')) {
 136         $el['html'] = '<span class="crm-frozen-field">' . $el['value'] . '</span>';
 137       }
 138       else {
 139         $el['html'] = '<span class="crm-frozen-field">' . $el['html'] . '</span>';
 140       }
 141     }
 142     // Active form elements
 143     else {
 144       $typesToShowEditLink = array('select', 'group');
 145       $hasEditPath = NULL !== $element->getAttribute('data-option-edit-path');
 146
 147       if (in_array($element->getType(), $typesToShowEditLink) && $hasEditPath) {
 148         $this->addOptionsEditLink($el, $element);
 149       }
 150
 151       if ($element->getAttribute('allowClear')) {
 152         $this->appendUnselectButton($el, $element);
 153       }
 154     }
 155
 156     return $el;
 157   }
 158
 159   /**
 160    * Update the attributes of this element and add a few CiviCRM
 161    * based attributes so we can style this form element better
 162    *
 163    *
 164    * @param HTML_QuickForm_element $element
 165    * @param bool $required
 166    *   Whether an element is required.
 167    * @param string $error
 168    *   Error associated with the element.
 169    *
 170    */
 171   public static function updateAttributes(&$element, $required, $error) {
 172     // lets create an id for all input elements, so we can generate nice label tags
 173     // to make it nice and clean, we'll just use the elementName if it is non null
 174     $attributes = array();
 175     if (!$element->getAttribute('id')) {
 176       $name = $element->getAttribute('name');
 177       if ($name) {
 178         $attributes['id'] = str_replace(array(']', '['),
 179           array('', '_'),
 180           $name
 181         );
 182       }
 183     }
 184
 185     $class = $element->getAttribute('class');
 186     $type = $element->getType();
 187     if (!$class) {
 188       if ($type == 'text' || $type == 'password') {
 189         $size = $element->getAttribute('size');
 190         if (!empty($size)) {
 191           $class = CRM_Utils_Array::value($size, self::$_sizeMapper);
 192         }
 193       }
 194     }
 195
 196     if ($type == 'select' && $element->getAttribute('multiple')) {
 197       $type = 'multiselect';
 198     }
 199     // Add widget-specific class
 200     if (!$class || strpos($class, 'crm-form-') === FALSE) {
 201       $class = ($class ? "$class " : '') . 'crm-form-' . $type;
 202     }
 203     elseif (strpos($class, 'crm-form-entityref') !== FALSE) {
 204       self::preProcessEntityRef($element);
 205     }
 206     elseif (strpos($class, 'crm-form-contact-reference') !== FALSE) {
 207       self::preprocessContactReference($element);
 208     }
 209     // Hack to support html5 fields (number, url, etc)
 210     else {
 211       foreach (CRM_Core_Form::$html5Types as $type) {
 212         if (strpos($class, "crm-form-$type") !== FALSE) {
 213           $element->setAttribute('type', $type);
 214           // Also add the "base" class for consistent styling
 215           $class .= ' crm-form-text';
 216           break;
 217         }
 218       }
 219     }
 220
 221     if ($required) {
 222       $class .= ' required';
 223     }
 224
 225     if ($error) {
 226       $class .= ' error';
 227     }
 228
 229     $attributes['class'] = $class;
 230     $element->updateAttributes($attributes);
 231   }
 232
 233   /**
 234    * Convert IDs to values and format for display.
 235    *
 236    * @param HTML_QuickForm_element $field
 237    */
 238   public static function preProcessEntityRef($field) {
 239     $val = $field->getValue();
 240     // Temporarily convert string values to an array
 241     if (!is_array($val)) {
 242       // Try to auto-detect method of serialization
 243       $val = strpos($val, ',') ? explode(',', str_replace(', ', ',', $val)) : (array) CRM_Utils_Array::explodePadded($val);
 244     }
 245     if ($val) {
 246       $entity = $field->getAttribute('data-api-entity');
 247       // Get api params, ensure it is an array
 248       $params = $field->getAttribute('data-api-params');
 249       $params = $params ? json_decode($params, TRUE) : array();
 250       $result = civicrm_api3($entity, 'getlist', array('id' => $val) + $params);
 251       // Purify label output of entityreference fields
 252       if (!empty($result['values'])) {
 253         foreach ($result['values'] as &$res) {
 254           if (!empty($res['label'])) {
 255             $res['label'] = CRM_Utils_String::purifyHTML($res['label']);
 256           }
 257         }
 258       }
 259       if ($field->isFrozen()) {
 260         // Prevent js from treating frozen entityRef as a "live" field
 261         $field->removeAttribute('class');
 262       }
 263       if (!empty($result['values'])) {
 264         $field->setAttribute('data-entity-value', json_encode($result['values']));
 265       }
 266       // CRM-15803 - Remove invalid values
 267       $val = array_intersect($val, CRM_Utils_Array::collect('id', $result['values']));
 268     }
 269     // Convert array values back to a string
 270     $field->setValue(implode(',', $val));
 271   }
 272
 273   /**
 274    * Render datepicker as text.
 275    *
 276    * @param array $el
 277    * @param HTML_QuickForm_element $field
 278    */
 279   public function renderFrozenDatepicker(&$el, $field) {
 280     $settings = json_decode($field->getAttribute('data-crm-datepicker'), TRUE);
 281     $settings += ['date' => TRUE, 'time' => TRUE];
 282     $val = $field->getValue();
 283     if ($val) {
 284       $dateFormat = NULL;
 285       if (!$settings['time']) {
 286         $val = substr($val, 0, 10);
 287       }
 288       elseif (!$settings['date']) {
 289         $dateFormat = Civi::settings()->get('dateformatTime');
 290       }
 291       $val = CRM_Utils_Date::customFormat($val, $dateFormat);
 292     }
 293     $el['html'] = $val . '<input type="hidden" value="' . $field->getValue() . '" name="' . $field->getAttribute('name') . '">';
 294   }
 295
 296   /**
 297    * Render select2 as text.
 298    *
 299    * @param array $el
 300    * @param HTML_QuickForm_element $field
 301    */
 302   public function renderFrozenSelect2(&$el, $field) {
 303     $params = json_decode($field->getAttribute('data-select-params'), TRUE);
 304     $val = $field->getValue();
 305     if ($val && !empty($params['data'])) {
 306       $display = array();
 307       foreach (explode(',', $val) as $item) {
 308         $match = CRM_Utils_Array::findInTree($item, $params['data']);
 309         if (isset($match['text']) && strlen($match['text'])) {
 310           $display[] = CRM_Utils_String::purifyHTML($match['text']);
 311         }
 312       }
 313       $el['html'] = implode('; ', $display) . '<input type="hidden" value="' . $field->getValue() . '" name="' . $field->getAttribute('name') . '">';
 314     }
 315   }
 316
 317   /**
 318    * Render entity references as text.
 319    * If user has permission, format as link (for now limited to contacts).
 320    *
 321    * @param array $el
 322    * @param HTML_QuickForm_element $field
 323    */
 324   public function renderFrozenEntityRef(&$el, $field) {
 325     $entity = strtolower($field->getAttribute('data-api-entity'));
 326     $vals = json_decode($field->getAttribute('data-entity-value'), TRUE);
 327     $display = array();
 328
 329     // Custom fields of type contactRef store their data in a slightly different format
 330     if ($field->getAttribute('data-crm-custom') && $entity == 'contact') {
 331       $vals = array(array('id' => $vals['id'], 'label' => $vals['text']));
 332     }
 333
 334     foreach ($vals as $val) {
 335       // Format contact as link
 336       if ($entity == 'contact' && CRM_Contact_BAO_Contact_Permission::allow($val['id'], CRM_Core_Permission::VIEW)) {
 337         $url = CRM_Utils_System::url("civicrm/contact/view", array('reset' => 1, 'cid' => $val['id']));
 338         $val['label'] = '<a class="view-' . $entity . ' no-popup" href="' . $url . '" title="' . ts('View Contact') . '">' . CRM_Utils_String::purifyHTML($val['label']) . '</a>';
 339       }
 340       $display[] = $val['label'];
 341     }
 342
 343     $el['html'] = implode('; ', $display) . '<input type="hidden" value="' . $field->getValue() . '" name="' . $field->getAttribute('name') . '">';
 344   }
 345
 346   /**
 347    * Pre-fill contact name for a custom field of type ContactReference
 348    *
 349    * Todo: Migrate contact reference fields to use EntityRef
 350    *
 351    * @param HTML_QuickForm_element $field
 352    */
 353   public static function preprocessContactReference($field) {
 354     $val = $field->getValue();
 355     if ($val && is_numeric($val)) {
 356
 357       $list = array_keys(CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 358         'contact_reference_options'
 359       ), '1');
 360
 361       $return = array_unique(array_merge(array('sort_name'), $list));
 362
 363       $contact = civicrm_api('contact', 'getsingle', array('id' => $val, 'return' => $return, 'version' => 3));
 364
 365       if (!empty($contact['id'])) {
 366         $view = array();
 367         foreach ($return as $fld) {
 368           if (!empty($contact[$fld])) {
 369             $view[] = $contact[$fld];
 370           }
 371         }
 372         $field->setAttribute('data-entity-value', json_encode(array(
 373               'id' => $contact['id'],
 374               'text' => implode(' :: ', $view),
 375             )));
 376       }
 377     }
 378   }
 379
 380   /**
 381    * @param array $el
 382    * @param HTML_QuickForm_element $field
 383    */
 384   public function addOptionsEditLink(&$el, $field) {
 385     if (CRM_Core_Permission::check('administer CiviCRM')) {
 386       // NOTE: $path is used on the client-side to know which option lists need rebuilding,
 387       // that's why we need that bit of data both in the link and in the form element
 388       $path = $field->getAttribute('data-option-edit-path');
 389       // NOTE: If we ever needed to support arguments in this link other than reset=1 we could split $path here if it contains a ?
 390       $url = CRM_Utils_System::url($path, 'reset=1');
 391       $el['html'] .= ' <a href="' . $url . '" class="crm-option-edit-link medium-popup crm-hover-button" target="_blank" title="' . ts('Edit Options') . '" data-option-edit-path="' . $path . '"><i class="crm-i fa-wrench"></i></a>';
 392     }
 393   }
 394
 395   /**
 396    * @param array $el
 397    * @param HTML_QuickForm_element $field
 398    */
 399   public function appendUnselectButton(&$el, $field) {
 400     // Initially hide if not needed
 401     // Note: visibility:hidden prevents layout jumping around unlike display:none
 402     $display = $field->getValue() !== NULL ? '' : ' style="visibility:hidden;"';
 403     $el['html'] .= ' <a href="#" class="crm-hover-button crm-clear-link"' . $display . ' title="' . ts('Clear') . '"><i class="crm-i fa-times"></i></a>';
 404   }
 405
 406 }