3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
36 require_once 'HTML/QuickForm/Renderer/ArraySmarty.php';
39 * Customize QF output to meet our specific requirements
41 class CRM_Core_Form_Renderer
extends HTML_QuickForm_Renderer_ArraySmarty
{
44 * We only need one instance of this object. So we use the singleton
45 * pattern and cache the instance in this variable
49 static private $_singleton = NULL;
52 * The converter from array size to css class.
56 static $_sizeMapper = array(
70 public function __construct() {
71 $template = CRM_Core_Smarty
::singleton();
72 parent
::__construct($template);
76 * Static instance provider.
78 * Method providing static instance of as in Singleton pattern.
80 public static function &singleton() {
81 if (!isset(self
::$_singleton)) {
82 self
::$_singleton = new CRM_Core_Form_Renderer();
84 return self
::$_singleton;
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
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.
102 public function _elementToArray(&$element, $required, $error) {
103 self
::updateAttributes($element, $required, $error);
105 $el = parent
::_elementToArray($element, $required, $error);
108 if (!empty($el['label'])) {
109 $id = $element->getAttribute('id');
111 $el['label'] = '<label for="' . $id . '">' . $el['label'] . '</label>';
114 $el['label'] = "<label>{$el['label']}</label>";
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);
123 elseif ($element->getAttribute('type') == 'text' && $element->getAttribute('data-select-params')) {
124 $this->renderFrozenSelect2($el, $element);
126 elseif ($element->getAttribute('type') == 'text' && $element->getAttribute('formatType')) {
127 list($date, $time) = CRM_Utils_Date
::setDateDefaults($element->getValue(), $element->getAttribute('formatType'), $element->getAttribute('format'), $element->getAttribute('timeformat'));
128 $date .= ($element->getAttribute('timeformat')) ?
" $time" : '';
129 $el['html'] = $date . '<input type="hidden" value="' . $element->getValue() . '" name="' . $element->getAttribute('name') . '">';
131 // Render html for wysiwyg textareas
132 if ($el['type'] == 'textarea' && isset($element->_attributes
['class']) && strstr($element->_attributes
['class'], 'wysiwyg')) {
133 $el['html'] = '<span class="crm-frozen-field">' . $el['value'] . '</span>';
136 $el['html'] = '<span class="crm-frozen-field">' . $el['html'] . '</span>';
139 // Active form elements
141 $typesToShowEditLink = array('select', 'group');
142 $hasEditPath = NULL !== $element->getAttribute('data-option-edit-path');
144 if (in_array($element->getType(), $typesToShowEditLink) && $hasEditPath) {
145 $this->addOptionsEditLink($el, $element);
148 if ($element->getAttribute('allowClear')) {
149 $this->appendUnselectButton($el, $element);
157 * Update the attributes of this element and add a few CiviCRM
158 * based attributes so we can style this form element better
161 * @param HTML_QuickForm_element $element
162 * @param bool $required
163 * Whether an element is required.
164 * @param string $error
165 * Error associated with the element.
168 public static function updateAttributes(&$element, $required, $error) {
169 // lets create an id for all input elements, so we can generate nice label tags
170 // to make it nice and clean, we'll just use the elementName if it is non null
171 $attributes = array();
172 if (!$element->getAttribute('id')) {
173 $name = $element->getAttribute('name');
175 $attributes['id'] = str_replace(array(']', '['),
182 $class = $element->getAttribute('class');
183 $type = $element->getType();
185 if ($type == 'text' ||
$type == 'password') {
186 $size = $element->getAttribute('size');
188 $class = CRM_Utils_Array
::value($size, self
::$_sizeMapper);
193 if ($type == 'select' && $element->getAttribute('multiple')) {
194 $type = 'multiselect';
196 // Add widget-specific class
197 if (!$class ||
strpos($class, 'crm-form-') === FALSE) {
198 $class = ($class ?
"$class " : '') . 'crm-form-' . $type;
200 elseif (strpos($class, 'crm-form-entityref') !== FALSE) {
201 self
::preProcessEntityRef($element);
203 elseif (strpos($class, 'crm-form-contact-reference') !== FALSE) {
204 self
::preprocessContactReference($element);
206 // Hack to support html5 fields (number, url, etc)
208 foreach (CRM_Core_Form
::$html5Types as $type) {
209 if (strpos($class, "crm-form-$type") !== FALSE) {
210 $element->setAttribute('type', $type);
211 // Also add the "base" class for consistent styling
212 $class .= ' crm-form-text';
219 $class .= ' required';
226 $attributes['class'] = $class;
227 $element->updateAttributes($attributes);
231 * Convert IDs to values and format for display.
233 * @param HTML_QuickForm_element $field
235 public static function preProcessEntityRef($field) {
236 $val = $field->getValue();
237 // Temporarily convert string values to an array
238 if (!is_array($val)) {
239 // Try to auto-detect method of serialization
240 $val = strpos($val, ',') ?
explode(',', str_replace(', ', ',', $val)) : (array) CRM_Utils_Array
::explodePadded($val);
243 $entity = $field->getAttribute('data-api-entity');
244 // Get api params, ensure it is an array
245 $params = $field->getAttribute('data-api-params');
246 $params = $params ?
json_decode($params, TRUE) : array();
247 $result = civicrm_api3($entity, 'getlist', array('id' => $val) +
$params);
248 if ($field->isFrozen()) {
249 // Prevent js from treating frozen entityRef as a "live" field
250 $field->removeAttribute('class');
252 if (!empty($result['values'])) {
253 $field->setAttribute('data-entity-value', json_encode($result['values']));
255 // CRM-15803 - Remove invalid values
256 $val = array_intersect($val, CRM_Utils_Array
::collect('id', $result['values']));
258 // Convert array values back to a string
259 $field->setValue(implode(',', $val));
263 * Render select2 as text.
266 * @param HTML_QuickForm_element $field
268 public function renderFrozenSelect2(&$el, $field) {
269 $params = json_decode($field->getAttribute('data-select-params'), TRUE);
270 $val = $field->getValue();
271 if ($val && !empty($params['data'])) {
273 foreach (explode(',', $val) as $item) {
274 $match = CRM_Utils_Array
::findInTree($item, $params['data']);
275 if (isset($match['text']) && strlen($match['text'])) {
276 $display[] = $match['text'];
279 $el['html'] = implode('; ', $display) . '<input type="hidden" value="' . $field->getValue() . '" name="' . $field->getAttribute('name') . '">';
284 * Render entity references as text.
285 * If user has permission, format as link (for now limited to contacts).
288 * @param HTML_QuickForm_element $field
290 public function renderFrozenEntityRef(&$el, $field) {
291 $entity = strtolower($field->getAttribute('data-api-entity'));
292 $vals = json_decode($field->getAttribute('data-entity-value'), TRUE);
295 // Custom fields of type contactRef store their data in a slightly different format
296 if ($field->getAttribute('data-crm-custom') && $entity == 'contact') {
297 $vals = array(array('id' => $vals['id'], 'label' => $vals['text']));
300 foreach ($vals as $val) {
301 // Format contact as link
302 if ($entity == 'contact' && CRM_Contact_BAO_Contact_Permission
::allow($val['id'], CRM_Core_Permission
::VIEW
)) {
303 $url = CRM_Utils_System
::url("civicrm/contact/view", array('reset' => 1, 'cid' => $val['id']));
304 $val['label'] = '<a class="view-' . $entity . ' no-popup" href="' . $url . '" title="' . ts('View Contact') . '">' . $val['label'] . '</a>';
306 $display[] = $val['label'];
309 $el['html'] = implode('; ', $display) . '<input type="hidden" value="' . $field->getValue() . '" name="' . $field->getAttribute('name') . '">';
313 * Pre-fill contact name for a custom field of type ContactReference
315 * Todo: Migrate contact reference fields to use EntityRef
317 * @param HTML_QuickForm_element $field
319 public static function preprocessContactReference($field) {
320 $val = $field->getValue();
321 if ($val && is_numeric($val)) {
323 $list = array_keys(CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
324 'contact_reference_options'
327 $return = array_unique(array_merge(array('sort_name'), $list));
329 $contact = civicrm_api('contact', 'getsingle', array('id' => $val, 'return' => $return, 'version' => 3));
331 if (!empty($contact['id'])) {
333 foreach ($return as $fld) {
334 if (!empty($contact[$fld])) {
335 $view[] = $contact[$fld];
338 $field->setAttribute('data-entity-value', json_encode(array(
339 'id' => $contact['id'],
340 'text' => implode(' :: ', $view),
348 * @param HTML_QuickForm_element $field
350 public function addOptionsEditLink(&$el, $field) {
351 if (CRM_Core_Permission
::check('administer CiviCRM')) {
352 // NOTE: $path is used on the client-side to know which option lists need rebuilding,
353 // that's why we need that bit of data both in the link and in the form element
354 $path = $field->getAttribute('data-option-edit-path');
355 // NOTE: If we ever needed to support arguments in this link other than reset=1 we could split $path here if it contains a ?
356 $url = CRM_Utils_System
::url($path, 'reset=1');
357 $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>';
363 * @param HTML_QuickForm_element $field
365 public function appendUnselectButton(&$el, $field) {
366 // Initially hide if not needed
367 // Note: visibility:hidden prevents layout jumping around unlike display:none
368 $display = $field->getValue() !== NULL ?
'' : ' style="visibility:hidden;"';
369 $el['html'] .= ' <a href="#" class="crm-hover-button crm-clear-link"' . $display . ' title="' . ts('Clear') . '"><i class="crm-i fa-times"></i></a>';