[civicrm-core.git] / CRM / Core / Form / Renderer.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.7                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2015                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
 */

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2015
 * $Id$
 *
 */

require_once 'HTML/QuickForm/Renderer/ArraySmarty.php';

/**
 * Customize QF output to meet our specific requirements
 */
class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty {

  /**
   * We only need one instance of this object. So we use the singleton
   * pattern and cache the instance in this variable
   *
   * @var object
   */
  static private $_singleton = NULL;

  /**
   * The converter from array size to css class.
   *
   * @var array
   */
  static $_sizeMapper = array(
    2 => 'two',
    4 => 'four',
    6 => 'six',
    8 => 'eight',
    12 => 'twelve',
    20 => 'medium',
    30 => 'big',
    45 => 'huge',
  );

  /**
   * Constructor.
   */
  public function __construct() {
    $template = CRM_Core_Smarty::singleton();
    parent::__construct($template);
  }

  /**
   * Static instance provider.
   *
   * Method providing static instance of as in Singleton pattern.
   */
  public static function &singleton() {
    if (!isset(self::$_singleton)) {
      self::$_singleton = new CRM_Core_Form_Renderer();
    }
    return self::$_singleton;
  }

  /**
   * Creates an array representing an element containing.
   * the key for storing this. We allow the parent to do most of the
   * work, but then we add some CiviCRM specific enhancements to
   * make the html compliant with our css etc
   *
   *
   * @param HTML_QuickForm_element $element
   * @param bool $required
   *   Whether an element is required.
   * @param string $error
   *   Error associated with the element.
   *
   * @return array
   */
  public function _elementToArray(&$element, $required, $error) {
    self::updateAttributes($element, $required, $error);

    $el = parent::_elementToArray($element, $required, $error);

    // add label html
    if (!empty($el['label'])) {
      $id = $element->getAttribute('id');
      if (!empty($id)) {
        $el['label'] = '<label for="' . $id . '">' . $el['label'] . '</label>';
      }
      else {
        $el['label'] = "<label>{$el['label']}</label>";
      }
    }

    // Display-only (frozen) elements
    if (!empty($el['frozen'])) {
      if ($element->getAttribute('data-api-entity') && $element->getAttribute('data-entity-value')) {
        $this->renderFrozenEntityRef($el, $element);
      }
      elseif ($element->getAttribute('type') == 'text' && $element->getAttribute('formatType')) {
        list($date, $time) = CRM_Utils_Date::setDateDefaults($element->getValue(), $element->getAttribute('formatType'), $element->getAttribute('format'), $element->getAttribute('timeformat'));
        $date .= ($element->getAttribute('timeformat')) ? " $time" : '';
        $el['html'] = $date . '<input type="hidden" value="' . $element->getValue() . '" name="' . $element->getAttribute('name') . '">';
      }

      $el['html'] = '<span class="crm-frozen-field">' . $el['html'] . '</span>';
    }
    // Active form elements
    else {
      if ($element->getType() == 'select' && $element->getAttribute('data-option-edit-path')) {
        $this->addOptionsEditLink($el, $element);
      }

      if ($element->getType() == 'group' && $element->getAttribute('allowClear')) {
        $this->appendUnselectButton($el, $element);
      }
    }

    return $el;
  }

  /**
   * Update the attributes of this element and add a few CiviCRM
   * based attributes so we can style this form element better
   *
   *
   * @param HTML_QuickForm_element $element
   * @param bool $required
   *   Whether an element is required.
   * @param string $error
   *   Error associated with the element.
   *
   */
  public static function updateAttributes(&$element, $required, $error) {
    // lets create an id for all input elements, so we can generate nice label tags
    // to make it nice and clean, we'll just use the elementName if it is non null
    $attributes = array();
    if (!$element->getAttribute('id')) {
      $name = $element->getAttribute('name');
      if ($name) {
        $attributes['id'] = str_replace(array(']', '['),
          array('', '_'),
          $name
        );
      }
    }

    $class = $element->getAttribute('class');
    $type = $element->getType();
    if (!$class) {
      if ($type == 'text') {
        $size = $element->getAttribute('size');
        if (!empty($size)) {
          $class = CRM_Utils_Array::value($size, self::$_sizeMapper);
        }
      }
    }

    if ($type == 'select' && $element->getAttribute('multiple')) {
      $type = 'multiselect';
    }
    // Add widget-specific class
    if (!$class || strpos($class, 'crm-form-') === FALSE) {
      $class = ($class ? "$class " : '') . 'crm-form-' . $type;
    }
    elseif (strpos($class, 'crm-form-entityref') !== FALSE) {
      self::preProcessEntityRef($element);
    }
    elseif (strpos($class, 'crm-form-contact-reference') !== FALSE) {
      self::preprocessContactReference($element);
    }

    if ($required) {
      $class .= ' required';
    }

    if ($error) {
      $class .= ' error';
    }

    $attributes['class'] = $class;
    $element->updateAttributes($attributes);
  }

  /**
   * Convert IDs to values and format for display.
   *
   * @param HTML_QuickForm_element $field
   */
  public static function preProcessEntityRef($field) {
    $val = $field->getValue();
    // Temporarily convert string values to an array
    if (!is_array($val)) {
      // Try to auto-detect method of serialization
      $val = strpos($val, ',') ? explode(',', str_replace(', ', ',', $val)) : (array) CRM_Utils_Array::explodePadded($val);
    }
    if ($val) {
      $entity = $field->getAttribute('data-api-entity');
      // Get api params, ensure it is an array
      $params = $field->getAttribute('data-api-params');
      $params = $params ? json_decode($params, TRUE) : array();
      $result = civicrm_api3($entity, 'getlist', array('id' => $val) + $params);
      if ($field->isFrozen()) {
        // Prevent js from treating frozen entityRef as a "live" field
        $field->removeAttribute('class');
      }
      if (!empty($result['values'])) {
        $field->setAttribute('data-entity-value', json_encode($result['values']));
      }
      // CRM-15803 - Remove invalid values
      $val = array_intersect($val, CRM_Utils_Array::collect('id', $result['values']));
    }
    // Convert array values back to a string
    $field->setValue(implode(',', $val));
  }

  /**
   * Render entity references as text.
   * If user has permission, format as link (for now limited to contacts).
   *
   * @param array $el
   * @param HTML_QuickForm_element $field
   */
  public function renderFrozenEntityRef(&$el, $field) {
    $entity = $field->getAttribute('data-api-entity');
    $vals = json_decode($field->getAttribute('data-entity-value'), TRUE);
    $display = array();

    // Custom fields of type contactRef store their data in a slightly different format
    if ($field->getAttribute('data-crm-custom') && $entity == 'contact') {
      $vals = array(array('id' => $vals['id'], 'label' => $vals['text']));
    }

    foreach ($vals as $val) {
      // Format contact as link
      if ($entity == 'contact' && CRM_Contact_BAO_Contact_Permission::allow($val['id'], CRM_Core_Permission::VIEW)) {
        $url = CRM_Utils_System::url("civicrm/contact/view", array('reset' => 1, 'cid' => $val['id']));
        $val['label'] = '<a class="view-' . $entity . ' no-popup" href="' . $url . '" title="' . ts('View Contact') . '">' . $val['label'] . '</a>';
      }
      $display[] = $val['label'];
    }

    $el['html'] = implode('; ', $display) . '<input type="hidden" value="' . $field->getValue() . '" name="' . $field->getAttribute('name') . '">';
  }

  /**
   * Pre-fill contact name for a custom field of type ContactReference
   *
   * Todo: Migrate contact reference fields to use EntityRef
   *
   * @param HTML_QuickForm_element $field
   */
  public static function preprocessContactReference($field) {
    $val = $field->getValue();
    if ($val && is_numeric($val)) {

      $list = array_keys(CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
        'contact_reference_options'
      ), '1');

      $return = array_unique(array_merge(array('sort_name'), $list));

      $contact = civicrm_api('contact', 'getsingle', array('id' => $val, 'return' => $return, 'version' => 3));

      if (!empty($contact['id'])) {
        $view = array();
        foreach ($return as $fld) {
          if (!empty($contact[$fld])) {
            $view[] = $contact[$fld];
          }
        }
        $field->setAttribute('data-entity-value', json_encode(array(
              'id' => $contact['id'],
              'text' => implode(' :: ', $view),
            )));
      }
    }
  }

  /**
   * @param array $el
   * @param HTML_QuickForm_element $field
   */
  public function addOptionsEditLink(&$el, $field) {
    if (CRM_Core_Permission::check('administer CiviCRM')) {
      // NOTE: $path is used on the client-side to know which option lists need rebuilding,
      // that's why we need that bit of data both in the link and in the form element
      $path = $field->getAttribute('data-option-edit-path');
      // NOTE: If we ever needed to support arguments in this link other than reset=1 we could split $path here if it contains a ?
      $url = CRM_Utils_System::url($path, 'reset=1');
      $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 . '"><span class="icon ui-icon-wrench"></span></a>';
    }
  }

  /**
   * @param array $el
   * @param HTML_QuickForm_element $field
   */
  public function appendUnselectButton(&$el, $field) {
    // Initially hide if not needed
    // Note: visibility:hidden prevents layout jumping around unlike display:none
    $display = $field->getValue() !== NULL ? '' : ' style="visibility:hidden;"';
    $el['html'] .= ' <a href="#" class="crm-hover-button crm-clear-link"' . $display . ' title="' . ts('Clear') . '"><span class="icon ui-icon-close"></span></a>';
  }

}
Commit	Line	Data
6a488035 TO	1	<?php
	2	/*
	3	+--------------------------------------------------------------------+
7e9e8871	4	\| CiviCRM version 4.7 \|
6a488035	5	+--------------------------------------------------------------------+
e7112fa7	6	\| Copyright CiviCRM LLC (c) 2004-2015 \|
6a488035 TO	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	+--------------------------------------------------------------------+
d25dd0ee	26	*/
6a488035 TO	27
	28	/**
	29	*
	30	* @package CRM
e7112fa7	31	* @copyright CiviCRM LLC (c) 2004-2015
6a488035 TO	32	* $Id$
	33	*
	34	*/
	35
	36	require_once 'HTML/QuickForm/Renderer/ArraySmarty.php';
	37
	38	/**
3c7fd868	39	* Customize QF output to meet our specific requirements
6a488035 TO	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
6a488035 TO	48	*/
	49	static private $_singleton = NULL;
	50
	51	/**
fe482240	52	* The converter from array size to css class.
6a488035 TO	53	*
6a488035 TO	54	* @var array
6a488035 TO	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	/**
fe482240	68	* Constructor.
95ea96be	69	*/
317fceb4	70	public function __construct() {
6a488035 TO	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	*/
00be9182	80	public static function &singleton() {
6a488035 TO	81	if (!isset(self::$_singleton)) {
	82	self::$_singleton = new CRM_Core_Form_Renderer();
	83	}
	84	return self::$_singleton;
	85	}
	86
	87	/**
fe482240	88	* Creates an array representing an element containing.
6a488035 TO	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	*
6a488035	93	*
3c7fd868 CW	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.
6a488035 TO	99	*
	100	* @return array
	101	*/
00be9182	102	public function _elementToArray(&$element, $required, $error) {
6a488035 TO	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
4a143c04	118	// Display-only (frozen) elements
704d3260	119	if (!empty($el['frozen'])) {
549be786	120	if ($element->getAttribute('data-api-entity') && $element->getAttribute('data-entity-value')) {
704d3260 CW	121	$this->renderFrozenEntityRef($el, $element);
704d3260 CW	122	}
69b1c921	123	elseif ($element->getAttribute('type') == 'text' && $element->getAttribute('formatType')) {
b691052b	124	list($date, $time) = CRM_Utils_Date::setDateDefaults($element->getValue(), $element->getAttribute('formatType'), $element->getAttribute('format'), $element->getAttribute('timeformat'));
	125	$date .= ($element->getAttribute('timeformat')) ? " $time" : '';
	126	$el['html'] = $date . '<input type="hidden" value="' . $element->getValue() . '" name="' . $element->getAttribute('name') . '">';
657cae7c ML	127	}
657cae7c ML	128
f0366d0b	129	$el['html'] = '<span class="crm-frozen-field">' . $el['html'] . '</span>';
704d3260	130	}
4a143c04 CW	131	// Active form elements
4a143c04 CW	132	else {
87831073	133	if ($element->getType() == 'select' && $element->getAttribute('data-option-edit-path')) {
4a143c04 CW	134	$this->addOptionsEditLink($el, $element);
	135	}
	136
b847e6e7	137	if ($element->getType() == 'group' && $element->getAttribute('allowClear')) {
4a143c04 CW	138	$this->appendUnselectButton($el, $element);
	139	}
	140	}
704d3260	141
6a488035 TO	142	return $el;
	143	}
	144
	145	/**
	146	* Update the attributes of this element and add a few CiviCRM
	147	* based attributes so we can style this form element better
	148	*
6a488035	149	*
3c7fd868 CW	150	* @param HTML_QuickForm_element $element
	151	* @param bool $required
	152	* Whether an element is required.
	153	* @param string $error
	154	* Error associated with the element.
6a488035	155	*
6a488035	156	*/
00be9182	157	public static function updateAttributes(&$element, $required, $error) {
6a488035 TO	158	// lets create an id for all input elements, so we can generate nice label tags
	159	// to make it nice and clean, we'll just use the elementName if it is non null
	160	$attributes = array();
	161	if (!$element->getAttribute('id')) {
	162	$name = $element->getAttribute('name');
	163	if ($name) {
	164	$attributes['id'] = str_replace(array(']', '['),
	165	array('', '_'),
	166	$name
	167	);
	168	}
	169	}
	170
	171	$class = $element->getAttribute('class');
	172	$type = $element->getType();
c5b53a6f	173	if (!$class) {
6a488035 TO	174	if ($type == 'text') {
	175	$size = $element->getAttribute('size');
	176	if (!empty($size)) {
dafd2d75	177	$class = CRM_Utils_Array::value($size, self::$_sizeMapper);
6a488035 TO	178	}
	179	}
	180	}
	181
4f95329c CW	182	if ($type == 'select' && $element->getAttribute('multiple')) {
	183	$type = 'multiselect';
	184	}
76ec9ca7 CW	185	// Add widget-specific class
	186	if (!$class \|\| strpos($class, 'crm-form-') === FALSE) {
	187	$class = ($class ? "$class " : '') . 'crm-form-' . $type;
	188	}
75f59466 CW	189	elseif (strpos($class, 'crm-form-entityref') !== FALSE) {
	190	self::preProcessEntityRef($element);
	191	}
06508628 CW	192	elseif (strpos($class, 'crm-form-contact-reference') !== FALSE) {
	193	self::preprocessContactReference($element);
	194	}
c5b53a6f	195
6a488035 TO	196	if ($required) {
	197	$class .= ' required';
	198	}
	199
	200	if ($error) {
	201	$class .= ' error';
	202	}
	203
	204	$attributes['class'] = $class;
	205	$element->updateAttributes($attributes);
	206	}
704d3260	207
75f59466	208	/**
fe482240	209	* Convert IDs to values and format for display.
06508628	210	*
3c7fd868	211	* @param HTML_QuickForm_element $field
75f59466	212	*/
00be9182	213	public static function preProcessEntityRef($field) {
75f59466	214	$val = $field->getValue();
a8809160 CW	215	// Temporarily convert string values to an array
	216	if (!is_array($val)) {
	217	// Try to auto-detect method of serialization
	218	$val = strpos($val, ',') ? explode(',', str_replace(', ', ',', $val)) : (array) CRM_Utils_Array::explodePadded($val);
75f59466 CW	219	}
	220	if ($val) {
	221	$entity = $field->getAttribute('data-api-entity');
e6d37e50 CW	222	// Get api params, ensure it is an array
	223	$params = $field->getAttribute('data-api-params');
	224	$params = $params ? json_decode($params, TRUE) : array();
61d869af	225	$result = civicrm_api3($entity, 'getlist', array('id' => $val) + $params);
75f59466	226	if ($field->isFrozen()) {
a8809160	227	// Prevent js from treating frozen entityRef as a "live" field
75f59466 CW	228	$field->removeAttribute('class');
	229	}
	230	if (!empty($result['values'])) {
75f59466 CW	231	$field->setAttribute('data-entity-value', json_encode($result['values']));
75f59466 CW	232	}
a8809160 CW	233	// CRM-15803 - Remove invalid values
a8809160 CW	234	$val = array_intersect($val, CRM_Utils_Array::collect('id', $result['values']));
75f59466	235	}
a8809160 CW	236	// Convert array values back to a string
a8809160 CW	237	$field->setValue(implode(',', $val));
75f59466 CW	238	}
75f59466 CW	239
704d3260 CW	240	/**
704d3260 CW	241	* Render entity references as text.
b56fec55	242	* If user has permission, format as link (for now limited to contacts).
3c7fd868 CW	243	*
	244	* @param array $el
	245	* @param HTML_QuickForm_element $field
704d3260	246	*/
00be9182	247	public function renderFrozenEntityRef(&$el, $field) {
549be786	248	$entity = $field->getAttribute('data-api-entity');
704d3260	249	$vals = json_decode($field->getAttribute('data-entity-value'), TRUE);
704d3260	250	$display = array();
a9b69e9f CW	251
	252	// Custom fields of type contactRef store their data in a slightly different format
	253	if ($field->getAttribute('data-crm-custom') && $entity == 'contact') {
	254	$vals = array(array('id' => $vals['id'], 'label' => $vals['text']));
	255	}
	256
704d3260 CW	257	foreach ($vals as $val) {
704d3260 CW	258	// Format contact as link
549be786	259	if ($entity == 'contact' && CRM_Contact_BAO_Contact_Permission::allow($val['id'], CRM_Core_Permission::VIEW)) {
704d3260	260	$url = CRM_Utils_System::url("civicrm/contact/view", array('reset' => 1, 'cid' => $val['id']));
b56fec55	261	$val['label'] = '<a class="view-' . $entity . ' no-popup" href="' . $url . '" title="' . ts('View Contact') . '">' . $val['label'] . '</a>';
704d3260	262	}
549be786	263	$display[] = $val['label'];
704d3260 CW	264	}
704d3260 CW	265
86bfa4f6	266	$el['html'] = implode('; ', $display) . '<input type="hidden" value="' . $field->getValue() . '" name="' . $field->getAttribute('name') . '">';
704d3260	267	}
5fafc9b0	268
06508628 CW	269	/**
	270	* Pre-fill contact name for a custom field of type ContactReference
	271	*
	272	* Todo: Migrate contact reference fields to use EntityRef
	273	*
3c7fd868	274	* @param HTML_QuickForm_element $field
06508628	275	*/
00be9182	276	public static function preprocessContactReference($field) {
06508628 CW	277	$val = $field->getValue();
	278	if ($val && is_numeric($val)) {
	279
	280	$list = array_keys(CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
	281	'contact_reference_options'
	282	), '1');
	283
	284	$return = array_unique(array_merge(array('sort_name'), $list));
	285
	286	$contact = civicrm_api('contact', 'getsingle', array('id' => $val, 'return' => $return, 'version' => 3));
	287
	288	if (!empty($contact['id'])) {
	289	$view = array();
	290	foreach ($return as $fld) {
	291	if (!empty($contact[$fld])) {
	292	$view[] = $contact[$fld];
	293	}
	294	}
353ffa53 TO	295	$field->setAttribute('data-entity-value', json_encode(array(
353ffa53 TO	296	'id' => $contact['id'],
317fceb4	297	'text' => implode(' :: ', $view),
353ffa53	298	)));
06508628 CW	299	}
	300	}
	301	}
	302
5fafc9b0 CW	303	/**
	304	* @param array $el
	305	* @param HTML_QuickForm_element $field
	306	*/
00be9182	307	public function addOptionsEditLink(&$el, $field) {
5fafc9b0	308	if (CRM_Core_Permission::check('administer CiviCRM')) {
87831073 CW	309	// NOTE: $path is used on the client-side to know which option lists need rebuilding,
	310	// that's why we need that bit of data both in the link and in the form element
	311	$path = $field->getAttribute('data-option-edit-path');
	312	// NOTE: If we ever needed to support arguments in this link other than reset=1 we could split $path here if it contains a ?
	313	$url = CRM_Utils_System::url($path, 'reset=1');
5ce7d22c	314	$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 . '"><span class="icon ui-icon-wrench"></span></a>';
5fafc9b0 CW	315	}
5fafc9b0 CW	316	}
4a143c04 CW	317
	318	/**
	319	* @param array $el
	320	* @param HTML_QuickForm_element $field
	321	*/
00be9182	322	public function appendUnselectButton(&$el, $field) {
4a143c04 CW	323	// Initially hide if not needed
4a143c04 CW	324	// Note: visibility:hidden prevents layout jumping around unlike display:none
8a4f27dc	325	$display = $field->getValue() !== NULL ? '' : ' style="visibility:hidden;"';
52604b19	326	$el['html'] .= ' <a href="#" class="crm-hover-button crm-clear-link"' . $display . ' title="' . ts('Clear') . '"><span class="icon ui-icon-close"></span></a>';
4a143c04	327	}
96025800	328
6a488035	329	}