<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
* machine. Each form can also operate in various modes
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
*/
static protected $_template;
+ /**
+ * Indicate if this form should warn users of unsaved changes
+ */
+ protected $unsavedChangesWarn;
+
/**
* What to return to the client if in ajax mode (snippet=json)
*
* We should not use QuickForm directly. This class provides a lot
* of default convenient functions, rules and buttons
*
- * @param object $state State associated with this form
- * @param enum $action The mode the form is operating in (None/Create/View/Update/Delete)
- * @param string $method The type of http method used (GET/POST)
- * @param string $name The name of the form if different from class name
+ * @param object $state State associated with this form
+ * @param \const|\enum $action The mode the form is operating in (None/Create/View/Update/Delete)
+ * @param string $method The type of http method used (GET/POST)
+ * @param string $name The name of the form if different from class name
*
- * @return object
- * @access public
+ * @return \CRM_Core_Form
+ @access public
*/
function __construct(
$state = NULL,
self::$_template = CRM_Core_Smarty::singleton();
}
- $this->assign('snippet', (int) CRM_Utils_Array::value('snippet', $_REQUEST));
+ $this->assign('snippet', CRM_Utils_Array::value('snippet', $_GET));
}
static function generateID() {
* Simple easy to use wrapper around addElement. Deal with
* simple validation rules
*
- * @param string type of html element to be added
- * @param string name of the html element
- * @param string display label for the html element
- * @param string attributes used for this element.
+ * @param $type
+ * @param $name
+ * @param string $label
+ * @param string $attributes
+ * @param bool $required
+ * @param null $extra
+ *
+ * @internal param \type $string of html element to be added
+ * @internal param \name $string of the html element
+ * @internal param \display $string label for the html element
+ * @internal param \attributes $string used for this element.
* These are not default values
- * @param bool is this a required field
+ * @internal param \is $bool this a required field
*
* @return HTML_QuickForm_Element could be an error object
* @access public
- *
*/
function &add($type, $name, $label = '',
- $attributes = '', $required = FALSE, $javascript = NULL
+ $attributes = '', $required = FALSE, $extra = NULL
) {
- $element = $this->addElement($type, $name, $label, $attributes, $javascript);
+ // Normalize this property
+ if ($type == 'select' && is_array($extra) && !empty($extra['multiple'])) {
+ $extra['multiple'] = 'multiple';
+ }
+ $element = $this->addElement($type, $name, $label, $attributes, $extra);
if (HTML_QuickForm::isError($element)) {
CRM_Core_Error::fatal(HTML_QuickForm::errorMessage($element));
}
CRM_Utils_Hook::buildForm(get_class($this), $this);
$this->addRules();
+
+ //Set html data-attribute to enable warning user of unsaved changes
+ if ($this->unsavedChangesWarn === true
+ || (!isset($this->unsavedChangesWarn)
+ && ($this->_action & CRM_Core_Action::ADD || $this->_action & CRM_Core_Action::UPDATE)
+ )
+ ) {
+ $this->setAttribute('data-warn-changes', 'true');
+ }
}
/**
$attrs = array_merge($js, $attrs);
}
+ if ($button['type'] === 'cancel') {
+ $attrs['class'] .= ' cancel';
+ }
+
if ($button['type'] === 'reset') {
$prevnext[] = $this->createElement($button['type'], 'reset', $button['name'], $attrs);
}
$buttonName = $this->getButtonName($button['type']);
}
- if (in_array($button['type'], array(
- 'next', 'upload')) && $button['name'] === 'Save') {
+ if (in_array($button['type'], array('next', 'upload', 'done')) && $button['name'] === ts('Save')) {
$attrs = array_merge($attrs, (array('accesskey' => 'S')));
}
$prevnext[] = $this->createElement('submit', $buttonName, $button['name'], $attrs);
function &addRadio($name, $title, $values, $attributes = array(), $separator = NULL, $required = FALSE) {
$options = array();
$attributes = $attributes ? $attributes : array();
- $unselectable = !empty($attributes['unselectable']);
- unset($attributes['unselectable']);
+ $allowClear = !empty($attributes['allowClear']);
+ unset($attributes['allowClear']);
$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);
+ if ($allowClear) {
+ $group->setAttribute('allowClear', TRUE);
}
return $group;
}
- function addYesNo($id, $title, $unselectable = FALSE, $required = NULL, $attributes = array()) {
+ function addYesNo($id, $title, $allowClear = FALSE, $required = NULL, $attributes = array()) {
$attributes += array('id_suffix' => $id);
$choice = array();
$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 ($allowClear) {
+ $group->setAttribute('allowClear', TRUE);
}
if ($required) {
$this->addRule($id, ts('%1 is a required field.', array(1 => $title)), 'required');
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
- * @param string $type button type for the form after processing
- * @param string $submitOnce If true, add javascript to next button submit which prevents it from being clicked more than once
+ * @param string $nextType
+ * @param string $backType
+ * @param bool|string $submitOnce If true, add javascript to next button submit which prevents it from being clicked more than once
*
+ * @internal param string $type button type for the form after processing
* @return void
* @access public
*/
* - 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
+ * - multiple - bool
* @param bool $required
* @throws CRM_Core_Exception
* @return HTML_QuickForm_Element
* - 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
+ * note that permissions are checked automatically
+ * - api - array of settings for the getlist api wrapper
+ * note that it accepts a 'params' setting which will be passed to the underlying api
* - placeholder - string
* - multiple - bool
* - class, etc. - other html properties
* </div>
* </div>
* {/if}
+ *
* @param array $profiles ids of profiles that are on the form (to be autofilled)
- * @param array $field metadata of field to use as selector including
+ * @param array $autoCompleteField
+ *
+ * @internal param array $field metadata of field to use as selector including
* - name_field
* - id_field
* - url (for ajax lookup)
*
- * @todo add data attributes so we can deal with multiple instances on a form
+ * @todo add data attributes so we can deal with multiple instances on a form
*/
function addAutoSelector($profiles = array(), $autoCompleteField = array()) {
$autoCompleteField = array_merge(array(
- 'name_field' => 'select_contact',
'id_field' => 'select_contact_id',
- 'field_text' => ts('Select Contact'),
+ 'placeholder' => ts('Select someone else ...'),
'show_hide' => TRUE,
- 'show_text' => ts('to select someone already in our database.'),
- 'hide_text' => ts('to clear this person\'s information, and fill the form in for someone else'),
- 'url' => array('civicrm/ajax/rest', 'className=CRM_Contact_Page_AJAX&fnName=getContactList&json=1'),
- 'max' => civicrm_api3('setting', 'getvalue', array(
- 'name' => 'search_autocomplete_count',
- 'group' => 'Search Preferences',
- ))
+ 'api' => array('params' => array('contact_type' => 'Individual'))
), $autoCompleteField);
- if(0 < (civicrm_api3('contact', 'getcount', array('check_permissions' => 1)))) {
- $this->addElement('text', $autoCompleteField['name_field'] , $autoCompleteField['field_text']);
- $this->addElement('hidden', $autoCompleteField['id_field'], '', array('id' => $autoCompleteField['id_field']));
+ if($this->canUseAjaxContactLookups()) {
$this->assign('selectable', $autoCompleteField['id_field']);
+ $this->addEntityRef($autoCompleteField['id_field'], NULL, array('placeholder' => $autoCompleteField['placeholder'], 'api' => $autoCompleteField['api']));
- CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/AutoComplete.js')
+ CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/AlternateContactSelector.js')
->addSetting(array(
'form' => array('autocompletes' => $autoCompleteField),
'ids' => array('profile' => $profiles),
}
}
+ /**
+ *
+ */
+ function canUseAjaxContactLookups() {
+ if (0 < (civicrm_api3('contact', 'getcount', array('check_permissions' => 1))) &&
+ CRM_Core_Permission::check(array(array('access AJAX API', 'access CiviCRM')))) {
+ return TRUE;
+ }
+ }
+
/**
* Add the options appropriate to cid = zero - ie. autocomplete
*
/**
* Set default values on form for given contact (or no contact defaults)
+ *
* @param mixed $profile_id (can be id, or profile name)
* @param integer $contactID
+ *
+ * @return array
*/
function getProfileDefaults($profile_id = 'Billing', $contactID = NULL) {
try{
return array();
}
}
+
+ /**
+ * Sets form attribute
+ * @see CRM.loadForm
+ */
+ function preventAjaxSubmit() {
+ $this->setAttribute('data-no-ajax-submit', 'true');
+ }
+
+ /**
+ * Sets form attribute
+ * @see CRM.loadForm
+ */
+ function allowAjaxSubmit() {
+ $this->removeAttribute('data-no-ajax-submit');
+ }
}
projects / civicrm-core.git / blobdiff