CRM/Core/Form/Renderer.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 require_once 'HTML/QuickForm/Renderer/ArraySmarty.php';
  37
  38 /**
  39  * customize the 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    * @static
  49    */
  50   static private $_singleton = NULL;
  51
  52   /**
  53    * the converter from array size to css class
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_sizeMapper = array(
  59     2 => 'two',
  60     4 => 'four',
  61     6 => 'six',
  62     8 => 'eight',
  63     12 => 'twelve',
  64     20 => 'medium',
  65     30 => 'big',
  66     45 => 'huge',
  67   );
  68
  69   /**
  70    * Constructor
  71    *
  72    * @access public
  73    */ function __construct() {
  74     $template = CRM_Core_Smarty::singleton();
  75     parent::__construct($template);
  76   }
  77
  78   /**
  79    * Static instance provider.
  80    *
  81    * Method providing static instance of as in Singleton pattern.
  82    */
  83   static function &singleton() {
  84     if (!isset(self::$_singleton)) {
  85       self::$_singleton = new CRM_Core_Form_Renderer();
  86     }
  87     return self::$_singleton;
  88   }
  89
  90   /**
  91    * Creates an array representing an element containing
  92    * the key for storing this. We allow the parent to do most of the
  93    * work, but then we add some CiviCRM specific enhancements to
  94    * make the html compliant with our css etc
  95    *
  96    * @access private
  97    *
  98    * @param  $element HTML_QuickForm_element
  99    * @param  $required bool - Whether an element is required
 100    * @param  $error string - Error associated with the element
 101    *
 102    * @return array
 103    */
 104   function _elementToArray(&$element, $required, $error) {
 105     self::updateAttributes($element, $required, $error);
 106
 107     $el = parent::_elementToArray($element, $required, $error);
 108
 109     // add label html
 110     if (!empty($el['label'])) {
 111       $id = $element->getAttribute('id');
 112       if (!empty($id)) {
 113         $el['label'] = '<label for="' . $id . '">' . $el['label'] . '</label>';
 114       }
 115       else {
 116         $el['label'] = "<label>{$el['label']}</label>";
 117       }
 118     }
 119
 120     // Display-only (frozen) elements
 121     if (!empty($el['frozen'])) {
 122       if ($element->getAttribute('data-api-entity') && $element->getAttribute('data-entity-value')) {
 123         $this->renderFrozenEntityRef($el, $element);
 124       }
 125       $el['html'] = '<span class="crm-frozen-field">' . $el['html'] . '</span>';
 126     }
 127     // Active form elements
 128     else {
 129       if ($element->getType() == 'select' && $element->getAttribute('data-option-edit-path')) {
 130         $this->addOptionsEditLink($el, $element);
 131       }
 132
 133       if ($element->getType() == 'group' && $element->getAttribute('allowClear')) {
 134         $this->appendUnselectButton($el, $element);
 135       }
 136     }
 137
 138     return $el;
 139   }
 140
 141   /**
 142    * Update the attributes of this element and add a few CiviCRM
 143    * based attributes so we can style this form element better
 144    *
 145    * @access private
 146    *
 147    * @param  $element  HTML_QuickForm_element object
 148    * @param  $required bool      Whether an element is required
 149    * @param  $error    string    Error associated with the element
 150    *
 151    * @return array
 152    * @static
 153    */
 154   static function updateAttributes(&$element, $required, $error) {
 155     // lets create an id for all input elements, so we can generate nice label tags
 156     // to make it nice and clean, we'll just use the elementName if it is non null
 157     $attributes = array();
 158     if (!$element->getAttribute('id')) {
 159       $name = $element->getAttribute('name');
 160       if ($name) {
 161         $attributes['id'] = str_replace(array(']', '['),
 162           array('', '_'),
 163           $name
 164         );
 165       }
 166     }
 167
 168     $class = $element->getAttribute('class');
 169     $type = $element->getType();
 170     if (!$class) {
 171       if ($type == 'text') {
 172         $size = $element->getAttribute('size');
 173         if (!empty($size)) {
 174           $class = CRM_Utils_Array::value($size, self::$_sizeMapper);
 175         }
 176       }
 177     }
 178
 179     if ($type == 'select' && $element->getAttribute('multiple')) {
 180       $type = 'multiselect';
 181     }
 182     // Add widget-specific class
 183     if (!$class || strpos($class, 'crm-form-') === FALSE) {
 184       $class = ($class ? "$class " : '') . 'crm-form-' . $type;
 185     }
 186     elseif (strpos($class, 'crm-form-entityref') !== FALSE) {
 187       self::preProcessEntityRef($element);
 188     }
 189     elseif (strpos($class, 'crm-form-contact-reference') !== FALSE) {
 190       self::preprocessContactReference($element);
 191     }
 192
 193     if ($required) {
 194       $class .= ' required';
 195     }
 196
 197     if ($error) {
 198       $class .= ' error';
 199     }
 200
 201     $attributes['class'] = $class;
 202     $element->updateAttributes($attributes);
 203   }
 204
 205   /**
 206    * Convert IDs to values and format for display
 207    *
 208    * @param $field HTML_QuickForm_element
 209    */
 210   static function preProcessEntityRef($field) {
 211     $val = $field->getValue();
 212     // Support array values
 213     if (is_array($val)) {
 214       $val = implode(',', $val);
 215       $field->setValue($val);
 216     }
 217     if ($val) {
 218       $entity = $field->getAttribute('data-api-entity');
 219       $api = json_decode($field->getAttribute('data-api-params'), TRUE);
 220       $params = CRM_Utils_Array::value('params', $api, array());
 221       // Support serialized values
 222       if (strpos($val, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
 223         $val = str_replace(CRM_Core_DAO::VALUE_SEPARATOR, ',', trim($val, CRM_Core_DAO::VALUE_SEPARATOR));
 224         $field->setValue($val);
 225       }
 226       $result = civicrm_api3($entity, 'getlist', array('id' => $val, 'params' => $params));
 227       if ($field->isFrozen()) {
 228         $field->removeAttribute('class');
 229       }
 230       if (!empty($result['values'])) {
 231         $field->setAttribute('data-entity-value', json_encode($result['values']));
 232       }
 233     }
 234   }
 235
 236   /**
 237    * Render entity references as text.
 238    * If user has permission, format as link (for now limited to contacts).
 239    * @param $el array
 240    * @param $field HTML_QuickForm_element
 241    */
 242   function renderFrozenEntityRef(&$el, $field) {
 243     $entity = $field->getAttribute('data-api-entity');
 244     $vals = json_decode($field->getAttribute('data-entity-value'), TRUE);
 245     $display = array();
 246     foreach ($vals as $val) {
 247       // Format contact as link
 248       if ($entity == 'contact' && CRM_Contact_BAO_Contact_Permission::allow($val['id'], CRM_Core_Permission::VIEW)) {
 249         $url = CRM_Utils_System::url("civicrm/contact/view", array('reset' => 1, 'cid' => $val['id']));
 250         $val['label'] = '<a class="view-' . $entity . ' no-popup" href="' . $url . '" title="' . ts('View Contact') . '">' . $val['label'] . '</a>';
 251       }
 252       $display[] = $val['label'];
 253     }
 254
 255     $el['html'] = implode('; ', $display) . '<input type="hidden" value="'. $field->getValue() . '" name="' . $field->getAttribute('name') . '">';
 256   }
 257
 258   /**
 259    * Pre-fill contact name for a custom field of type ContactReference
 260    *
 261    * Todo: Migrate contact reference fields to use EntityRef
 262    *
 263    * @param $field HTML_QuickForm_element
 264    */
 265   static function preprocessContactReference($field) {
 266     $val = $field->getValue();
 267     if ($val && is_numeric($val)) {
 268
 269       $list = array_keys(CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 270         'contact_reference_options'
 271       ), '1');
 272
 273       $return = array_unique(array_merge(array('sort_name'), $list));
 274
 275       $contact = civicrm_api('contact', 'getsingle', array('id' => $val, 'return' => $return, 'version' => 3));
 276
 277       if (!empty($contact['id'])) {
 278         $view = array();
 279         foreach ($return as $fld) {
 280           if (!empty($contact[$fld])) {
 281             $view[] = $contact[$fld];
 282           }
 283         }
 284         $field->setAttribute('data-entity-value', json_encode(array('id' => $contact['id'], 'text' => implode(' :: ', $view))));
 285       }
 286     }
 287   }
 288
 289   /**
 290    * @param array $el
 291    * @param HTML_QuickForm_element $field
 292    */
 293   function addOptionsEditLink(&$el, $field) {
 294     if (CRM_Core_Permission::check('administer CiviCRM')) {
 295       // NOTE: $path is used on the client-side to know which option lists need rebuilding,
 296       // that's why we need that bit of data both in the link and in the form element
 297       $path = $field->getAttribute('data-option-edit-path');
 298       // NOTE: If we ever needed to support arguments in this link other than reset=1 we could split $path here if it contains a ?
 299       $url = CRM_Utils_System::url($path, 'reset=1');
 300       $el['html'] .= ' <a href="' . $url . '" class="crm-option-edit-link crm-hover-button" target="_blank" title="' . ts('Edit Options') . '" data-option-edit-path="' . $path . '"><span class="icon edit-icon"></span></a>';
 301     }
 302   }
 303
 304   /**
 305    * @param array $el
 306    * @param HTML_QuickForm_element $field
 307    */
 308   function appendUnselectButton(&$el, $field) {
 309     // Initially hide if not needed
 310     // Note: visibility:hidden prevents layout jumping around unlike display:none
 311     $display = $field->getValue() !== NULL ? '' : ' style="visibility:hidden;"';
 312     $el['html'] .= ' <a href="#" class="crm-hover-button crm-clear-link"' . $display . ' title="' . ts('Clear') . '"><span class="icon close-icon"></span></a>';
 313   }
 314 }
 315