public $ajaxResponse = array();
/**
- * Stores info about reference fields for preprocessing
- * Public so that hooks can access it
+ * Url path used to reach this page
*
* @var array
*/
- public $entityReferenceFields = array();
+ public $urlPath = array();
/**
* constants for attributes for various form elements
// the user can do both the form and set default values with this hook
CRM_Utils_Hook::buildForm(get_class($this), $this);
- $this->preprocessReferenceFields();
-
$this->addRules();
}
return self::$_template->get_template_vars($name);
}
- function &addRadio($name, $title, &$values, $attributes = NULL, $separator = NULL, $required = FALSE) {
+ function &addRadio($name, $title, $values, $attributes = array(), $separator = NULL, $required = FALSE) {
$options = array();
- if (empty($attributes)) {
- $attributes = array('id_suffix' => $name);
- }
- else {
- $attributes = array_merge($attributes, array('id_suffix' => $name));
- }
+ $attributes = $attributes ? $attributes : array();
+ $unselectable = !empty($attributes['unselectable']);
+ unset($attributes['unselectable']);
+ $attributes += array('id_suffix' => $name);
foreach ($values as $key => $var) {
$options[] = $this->createElement('radio', NULL, NULL, $var, $key, $attributes);
}
if ($required) {
$this->addRule($name, ts('%1 is a required field.', array(1 => $title)), 'required');
}
+ if ($unselectable) {
+ $group->setAttribute('unselectable', TRUE);
+ }
return $group;
}
- function addYesNo($id, $title, $dontKnow = NULL, $required = NULL, $attribute = NULL) {
- if (empty($attribute)) {
- $attribute = array('id_suffix' => $id);
- }
- else {
- $attribute = array_merge($attribute, array('id_suffix' => $id));
- }
+ function addYesNo($id, $title, $unselectable = FALSE, $required = NULL, $attributes = array()) {
+ $attributes += array('id_suffix' => $id);
$choice = array();
- $choice[] = $this->createElement('radio', NULL, '11', ts('Yes'), '1', $attribute);
- $choice[] = $this->createElement('radio', NULL, '11', ts('No'), '0', $attribute);
- if ($dontKnow) {
- $choice[] = $this->createElement('radio', NULL, '22', ts("Don't Know"), '2', $attribute);
- }
- $this->addGroup($choice, $id, $title);
+ $choice[] = $this->createElement('radio', NULL, '11', ts('Yes'), '1', $attributes);
+ $choice[] = $this->createElement('radio', NULL, '11', ts('No'), '0', $attributes);
+ $group = $this->addGroup($choice, $id, $title);
+ if ($unselectable) {
+ $group->setAttribute('unselectable', TRUE);
+ }
if ($required) {
$this->addRule($id, ts('%1 is a required field.', array(1 => $title)), 'required');
}
}
}
- function addSelect($name, $label, $prefix = NULL, $required = NULL, $extra = NULL, $select = '- select -') {
- if ($prefix) {
- $this->addElement('select', $name . '_id' . $prefix, $label,
- array(
- '' => $select) + CRM_Core_OptionGroup::values($name), $extra
- );
- if ($required) {
- $this->addRule($name . '_id' . $prefix, ts('Please select %1', array(1 => $label)), 'required');
- }
+ /**
+ * Adds a select based on field metadata
+ * TODO: This could be even more generic and widget type (select in this case) could also be read from metadata
+ * Perhaps a method like $form->bind($name) which would look up all metadata for named field
+ * @param $name - field name to go on the form
+ * @param array $props - mix of html attributes and special properties, namely
+ * - entity (api entity name, can usually be inferred automatically from the form class)
+ * - field (field name - only needed if different from name used on the form)
+ * - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link
+ * - placeholder - set to NULL to disable
+ * @param bool $required
+ * @throws CRM_Core_Exception
+ * @return HTML_QuickForm_Element
+ */
+ function addSelect($name, $props = array(), $required = FALSE) {
+ if (!isset($props['entity'])) {
+ $props['entity'] = CRM_Utils_Api::getEntityName($this);
+ }
+ if (!isset($props['field'])) {
+ $props['field'] = strrpos($name, '[') ? rtrim(substr($name, 1 + strrpos($name, '[')), ']') : $name;
}
+ $info = civicrm_api3($props['entity'], 'getoptions', array(
+ 'field' => $props['field'],
+ 'options' => array('metadata' => array('fields'))
+ )
+ );
+ $options = $info['values'];
+ if (!array_key_exists('placeholder', $props)) {
+ $props['placeholder'] = $required ? ts('- select -') : ts('- none -');
+ }
+ if ($props['placeholder'] !== NULL && empty($props['multiple'])) {
+ $options = array('' => '') + $options;
+ }
+ // Handle custom field
+ if (strpos($name, 'custom_') === 0 && is_numeric($name[7])) {
+ list(, $id) = explode('_', $name);
+ $label = isset($props['label']) ? $props['label'] : CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', 'label', $id);
+ $gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', 'option_group_id', $id);
+ $props['data-option-edit-path'] = array_key_exists('option_url', $props) ? $props['option_url'] : 'civicrm/admin/options/' . CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $gid);
+ }
+ // Core field
else {
- $this->addElement('select', $name . '_id', $label,
- array(
- '' => $select) + CRM_Core_OptionGroup::values($name), $extra
- );
- if ($required) {
- $this->addRule($name . '_id', ts('Please select %1', array(1 => $label)), 'required');
+ foreach($info['metadata']['fields'] as $uniqueName => $fieldSpec) {
+ if (
+ $uniqueName === $props['field'] ||
+ CRM_Utils_Array::value('name', $fieldSpec) === $props['field'] ||
+ in_array($props['field'], CRM_Utils_Array::value('api.aliases', $fieldSpec, array()))
+ ) {
+ break;
+ }
}
+ $label = isset($props['label']) ? $props['label'] : $fieldSpec['title'];
+ $props['data-option-edit-path'] = array_key_exists('option_url', $props) ? $props['option_url'] : $props['data-option-edit-path'] = CRM_Core_PseudoConstant::getOptionEditUrl($fieldSpec);
}
+ $props['class'] = (isset($props['class']) ? $props['class'] . ' ' : '') . "crm-select2";
+ $props['data-api-entity'] = $props['entity'];
+ $props['data-api-field'] = $props['field'];
+ CRM_Utils_Array::remove($props, 'label', 'entity', 'field', 'option_url');
+ return $this->add('select', $name, $label, $options, $required, $props);
}
/**
$freezeCurrency = FALSE
) {
$currencies = CRM_Core_OptionGroup::values('currencies_enabled');
+ $options = array('class' => 'crm-select2 eight');
if (!$required) {
- $currencies = array(
- '' => ts('- select -')) + $currencies;
+ $currencies = array('' => '') + $currencies;
+ $options['placeholder'] = ts('- none -');
}
- $ele = $this->add('select', $name, $label, $currencies, $required);
+ $ele = $this->add('select', $name, $label, $currencies, $required, $options);
if ($freezeCurrency) {
$ele->freeze();
}
}
/**
- * Create a single or multiple contact ref field
+ * Create a single or multiple entity ref field
* @param string $name
* @param string $label
* @param array $props mix of html and widget properties, including:
- * - select - params to give to select2 widget
- * - api - array of settings for the api, keys include "entity", "action", "params", "search", "key", "label"
- * - placeholder - string
- * - multiple - bool
- * - class, etc. - other html properties
+ * - select - params to give to select2 widget
+ * - entity - defaults to contact
+ * - create - can the user create a new entity on-the-fly?
+ * Set to TRUE if entity is contact and you want the default profiles,
+ * or pass in your own set of links. @see CRM_Core_BAO_UFGroup::getCreateLinks for format
+ * - api - array of settings for the getlist api
+ * - placeholder - string
+ * - multiple - bool
+ * - class, etc. - other html properties
* @param bool $required
+ *
+ * @access public
* @return HTML_QuickForm_Element
*/
- function addEntityRef($name, $label, $props = array(), $required = FALSE) {
- $props['class'] = isset($props['class']) ? $props['class'] . ' crm-select2' : 'crm-select2';
+ function addEntityRef($name, $label = '', $props = array(), $required = FALSE) {
+ $config = CRM_Core_Config::singleton();
+ // Default properties
+ $props['api'] = CRM_Utils_Array::value('api', $props, array());
+ $props['entity'] = CRM_Utils_Array::value('entity', $props, 'contact');
+
+ $props['class'] = isset($props['class']) ? $props['class'] . ' ' : '';
+ $props['class'] .= "crm-select2 crm-form-entityref";
+
+ if ($props['entity'] == 'contact' && isset($props['create']) && !(CRM_Core_Permission::check('edit all contacts') || CRM_Core_Permission::check('add contacts'))) {
+ unset($props['create']);
+ }
+ // Convenient shortcut to passing in array create links
+ if ($props['entity'] == 'contact' && isset($props['create']) && $props['create'] === TRUE) {
+ if (empty($props['api']['params']['contact_type'])) {
+ $props['create'] = CRM_Core_BAO_UFGroup::getCreateLinks(array('new_individual', 'new_organization', 'new_household'));
+ }
+ else {
+ $props['create'] = CRM_Core_BAO_UFGroup::getCreateLinks('new_' . strtolower($props['api']['params']['contact_type']));
+ }
+ }
- $props['select'] = CRM_Utils_Array::value('select', $props, array()) + array(
+ $defaults = array(
'minimumInputLength' => 1,
'multiple' => !empty($props['multiple']),
- 'placeholder' => CRM_Utils_Array::value('placeholder', $props, $required ? ts('- select -') : ts('- none -')),
+ 'placeholder' => CRM_Utils_Array::value('placeholder', $props, $required ? ts('- select %1 -', array(1 => ts($props['entity']))) : ts('- none -')),
'allowClear' => !$required,
- // Disabled pending https://github.com/ivaynberg/select2/pull/2092
- //'formatInputTooShort' => ts('Start typing a name or email address...'),
- //'formatNoMatches' => ts('No contacts found.'),
- );
-
- $props['api'] = CRM_Utils_Array::value('api', $props, array()) + array(
- 'entity' => 'contact',
- 'action' => 'getquick',
- 'search' => 'name',
- 'label' => 'data',
- 'key' => 'id',
);
+ if ($props['entity'] == 'contact') {
+ $defaults['formatInputTooShort'] = $config->includeEmailInName ? ts('Start typing a name or email...') : ts('Start typing a name...');
+ }
+ $props['select'] = CRM_Utils_Array::value('select', $props, array()) + $defaults;
- $this->entityReferenceFields[] = $name;
$this->formatReferenceFieldAttributes($props);
return $this->add('text', $name, $label, $props, $required);
}
*/
private function formatReferenceFieldAttributes(&$props) {
$props['data-select-params'] = json_encode($props['select']);
- $props['data-api-params'] = json_encode($props['api']);
- CRM_Utils_Array::remove($props, 'multiple', 'select', 'api', 'placeholder');
- }
-
- /**
- * Convert IDs to values and format for display
- */
- private function preprocessReferenceFields() {
- foreach ($this->entityReferenceFields as $name) {
- $field = $this->getElement($name);
- $val = $field->getValue();
- // Support array values
- if (is_array($val)) {
- $val = implode(',', $val);
- $field->setValue($val);
- }
- if ($val) {
- $data = $labels = array();
- $api = json_decode($field->getAttribute('data-api-params'), TRUE);
- $select = json_decode($field->getAttribute('data-select-params'), TRUE);
- // Support serialized values
- if (strpos($val, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
- $val = str_replace(CRM_Core_DAO::VALUE_SEPARATOR, ',', trim($val, CRM_Core_DAO::VALUE_SEPARATOR));
- $field->setValue($val);
- }
- foreach (explode(',', $val) as $v) {
- $result = civicrm_api3($api['entity'], $api['action'], array('sequential' => 1, $api['key'] => $v));
- if (!empty($result['values'])) {
- $data[] = array('id' => $v, 'text' => $result['values'][0][$api['label']]);
- $labels[] = $result['values'][0][$api['label']];
- }
- }
- if ($field->isFrozen()) {
- $field->removeAttribute('class');
- $field->setValue(implode(', ', $labels));
- }
- elseif ($data) {
- if (empty($select['multiple'])) {
- $data = $data[0];
- }
- $field->setAttribute('data-entity-value', json_encode($data));
- }
- }
+ $props['data-api-params'] = $props['api'] ? json_encode($props['api']) : NULL;
+ $props['data-api-entity'] = $props['entity'];
+ if (!empty($props['create'])) {
+ $props['data-create-links'] = json_encode($props['create']);
}
+ CRM_Utils_Array::remove($props, 'multiple', 'select', 'api', 'entity', 'placeholder', 'create');
}
/**
projects / civicrm-core.git / blobdiff