CRM/Admin/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * Base class for admin forms.
  36  */
  37 class CRM_Admin_Form extends CRM_Core_Form {
  38
  39   /**
  40    * The id of the object being edited / created
  41    *
  42    * @var int
  43    */
  44   protected $_id;
  45
  46   /**
  47    * The default values for form fields.
  48    *
  49    * @var int
  50    */
  51   protected $_values;
  52
  53   /**
  54    * The name of the BAO object for this form.
  55    *
  56    * @var string
  57    */
  58   protected $_BAOName;
  59
  60   /**
  61    * Explicitly declare the form context.
  62    */
  63   public function getDefaultContext() {
  64     return 'create';
  65   }
  66
  67   /**
  68    * Basic setup.
  69    */
  70   public function preProcess() {
  71     Civi::resources()->addStyleFile('civicrm', 'css/admin.css');
  72     Civi::resources()->addScriptFile('civicrm', 'js/jquery/jquery.crmIconPicker.js');
  73
  74     $this->_id = $this->get('id');
  75     $this->_BAOName = $this->get('BAOName');
  76     $this->_values = array();
  77     if (isset($this->_id)) {
  78       $params = array('id' => $this->_id);
  79       // this is needed if the form is outside the CRM name space
  80       $baoName = $this->_BAOName;
  81       $baoName::retrieve($params, $this->_values);
  82     }
  83   }
  84
  85   /**
  86    * Set default values for the form. Note that in edit/view mode
  87    * the default values are retrieved from the database
  88    *
  89    *
  90    * @return array
  91    */
  92   public function setDefaultValues() {
  93     // Fetch defaults from the db
  94     if (!empty($this->_id) && empty($this->_values) && CRM_Utils_Rule::positiveInteger($this->_id)) {
  95       $this->_values = array();
  96       $params = array('id' => $this->_id);
  97       $baoName = $this->_BAOName;
  98       $baoName::retrieve($params, $this->_values);
  99     }
 100     $defaults = $this->_values;
 101
 102     // Allow defaults to be set from the url
 103     if (empty($this->_id) && $this->_action & CRM_Core_Action::ADD) {
 104       foreach ($_GET as $key => $val) {
 105         if ($this->elementExists($key)) {
 106           $defaults[$key] = $val;
 107         }
 108       }
 109     }
 110
 111     if ($this->_action == CRM_Core_Action::DELETE &&
 112       isset($defaults['name'])
 113     ) {
 114       $this->assign('delName', $defaults['name']);
 115     }
 116
 117     // its ok if there is no element called is_active
 118     $defaults['is_active'] = ($this->_id) ? CRM_Utils_Array::value('is_active', $defaults) : 1;
 119     if (!empty($defaults['parent_id'])) {
 120       $this->assign('is_parent', TRUE);
 121     }
 122     return $defaults;
 123   }
 124
 125   /**
 126    * Add standard buttons.
 127    */
 128   public function buildQuickForm() {
 129     if ($this->_action & CRM_Core_Action::VIEW || $this->_action & CRM_Core_Action::PREVIEW) {
 130       $this->addButtons(array(
 131           array(
 132             'type' => 'cancel',
 133             'name' => ts('Done'),
 134             'isDefault' => TRUE,
 135           ),
 136         )
 137       );
 138     }
 139     else {
 140       $this->addButtons(array(
 141           array(
 142             'type' => 'next',
 143             'name' => $this->_action & CRM_Core_Action::DELETE ? ts('Delete') : ts('Save'),
 144             'isDefault' => TRUE,
 145           ),
 146           array(
 147             'type' => 'cancel',
 148             'name' => ts('Cancel'),
 149           ),
 150         )
 151       );
 152     }
 153   }
 154
 155 }