CRM/Price/Form/Set.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * form to process actions on Price Sets
  38  */
  39 class CRM_Price_Form_Set extends CRM_Core_Form {
  40
  41   /**
  42    * The set id saved to the session for an update
  43    *
  44    * @var int
  45    */
  46   protected $_sid;
  47
  48   /**
  49    * Set variables up before form is built
  50    *
  51    * @param null
  52    *
  53    * @return void
  54    */
  55   public function preProcess() {
  56     // current set id
  57     $this->_sid = $this->get('sid');
  58
  59     // setting title for html page
  60     $title = ts('New Price Set');
  61     if ($this->_sid) {
  62       $title = CRM_Price_BAO_PriceSet::getTitle($this->_sid);
  63     }
  64     if ($this->_action & CRM_Core_Action::UPDATE) {
  65       $title = ts('Edit %1', array(1 => $title));
  66     }
  67     elseif ($this->_action & CRM_Core_Action::VIEW) {
  68       $title = ts('Preview %1', array(1 => $title));
  69     }
  70     CRM_Utils_System::setTitle($title);
  71
  72     $url = CRM_Utils_System::url('civicrm/admin/price', 'reset=1');
  73     $breadCrumb = array(array(
  74     'title' => ts('Price Sets'),
  75         'url' => $url,
  76       ));
  77     CRM_Utils_System::appendBreadCrumb($breadCrumb);
  78   }
  79
  80   /**
  81    * Global form rule
  82    *
  83    * @param array $fields
  84    *   The input form values.
  85    * @param array $files
  86    *   The uploaded files if any.
  87    * @param array $options
  88    *   Additional user data.
  89    *
  90    * @return true if no errors, else array of errors
  91    * @static
  92    */
  93   public static function formRule($fields, $files, $options) {
  94     $errors = array();
  95     $count = count(CRM_Utils_Array::value('extends', $fields));
  96     //price sets configured for membership
  97     if ($count && array_key_exists(CRM_Core_Component::getComponentID('CiviMember'), $fields['extends'])) {
  98       if ($count > 1) {
  99         $errors['extends'] = ts('If you plan on using this price set for membership signup and renewal, you can not also use it for Events or Contributions. However, a membership price set may include additional fields for non-membership options that require an additional fee (e.g. magazine subscription).');
 100       }
 101     }
 102     //checks the given price set doesnot start with digit
 103     $title = $fields['title'];
 104     // gives the ascii value
 105     $asciiValue = ord($title{0});
 106     if ($asciiValue >= 48 && $asciiValue <= 57) {
 107       $errors['title'] = ts("Name cannot not start with a digit");
 108     }
 109     return empty($errors) ? TRUE : $errors;
 110   }
 111
 112   /**
 113    * Build the form object
 114    *
 115    * @param null
 116    *
 117    * @return void
 118    */
 119   public function buildQuickForm() {
 120     $this->applyFilter('__ALL__', 'trim');
 121
 122     $this->assign('sid', $this->_sid);
 123
 124     // title
 125     $this->add('text', 'title', ts('Set Name'), CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceSet', 'title'), TRUE);
 126     $this->addRule('title', ts('Name already exists in Database.'),
 127       'objectExists', array('CRM_Price_DAO_PriceSet', $this->_sid, 'title')
 128     );
 129
 130     $priceSetUsedTables = $extends = array();
 131     if ($this->_action == CRM_Core_Action::UPDATE && $this->_sid) {
 132       $priceSetUsedTables = CRM_Price_BAO_PriceSet::getUsedBy($this->_sid, 'table');
 133     }
 134
 135     $config           = CRM_Core_Config::singleton();
 136     $showContribution = FALSE;
 137     $enabledComponents = CRM_Core_Component::getEnabledComponents();
 138
 139     foreach ($enabledComponents as $name => $compObj) {
 140       switch ($name) {
 141         case 'CiviEvent':
 142           $option = $this->createElement('checkbox', $compObj->componentID, NULL, ts('Event'));
 143           if (!empty($priceSetUsedTables)) {
 144             foreach (array('civicrm_event', 'civicrm_participant') as $table) {
 145               if (in_array($table, $priceSetUsedTables)) {
 146                 $option->freeze();
 147                 break;
 148               }
 149             }
 150           }
 151           $extends[] = $option;
 152           break;
 153
 154         case 'CiviContribute':
 155           $option = $this->createElement('checkbox', $compObj->componentID, NULL, ts('Contribution'));
 156           if (!empty($priceSetUsedTables)) {
 157             foreach (array('civicrm_contribution', 'civicrm_contribution_page') as $table) {
 158               if (in_array($table, $priceSetUsedTables)) {
 159                 $option->freeze();
 160                 break;
 161               }
 162             }
 163           }
 164           $extends[] = $option;
 165           break;
 166
 167         case 'CiviMember':
 168           $option = $this->createElement('checkbox', $compObj->componentID, NULL, ts('Membership'));
 169           if (!empty($priceSetUsedTables)) {
 170             foreach (array('civicrm_membership', 'civicrm_contribution_page') as $table) {
 171               if (in_array($table, $priceSetUsedTables)) {
 172                 $option->freeze();
 173                 break;
 174               }
 175             }
 176           }
 177           $extends[] = $option;
 178           break;
 179       }
 180     }
 181
 182     if (CRM_Utils_System::isNull($extends)) {
 183       $this->assign('extends', FALSE);
 184     }
 185     else {
 186       $this->assign('extends', TRUE);
 187     }
 188
 189     $this->addGroup($extends, 'extends', ts('Used For'), '&nbsp;', TRUE);
 190
 191     $this->addRule('extends', ts('%1 is a required field.', array(1 => ts('Used For'))), 'required');
 192
 193     // financial type
 194     $financialType = CRM_Financial_BAO_FinancialType::getIncomeFinancialType();
 195
 196     $this->add('select', 'financial_type_id',
 197       ts('Default Financial Type'),
 198           array('' => ts('- select -')) + $financialType, 'required'
 199     );
 200
 201     // help text
 202     $this->add('textarea', 'help_pre', ts('Pre-form Help'),
 203       CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceSet', 'help_pre')
 204     );
 205     $this->add('textarea', 'help_post', ts('Post-form Help'),
 206       CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceSet', 'help_post')
 207     );
 208
 209     // is this set active ?
 210     $this->addElement('checkbox', 'is_active', ts('Is this Price Set active?'));
 211
 212     $this->addButtons(array(
 213         array(
 214           'type' => 'next',
 215           'name' => ts('Save'),
 216           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 217           'isDefault' => TRUE,
 218         ),
 219         array(
 220           'type' => 'cancel',
 221           'name' => ts('Cancel'),
 222         ),
 223       )
 224     );
 225
 226     $this->addFormRule(array('CRM_Price_Form_Set', 'formRule'));
 227
 228     // views are implemented as frozen form
 229     if ($this->_action & CRM_Core_Action::VIEW) {
 230       $this->freeze();
 231       //$this->addElement('button', 'done', ts('Done'), array('onclick' => "location.href='civicrm/admin/price?reset=1&action=browse'"));
 232     }
 233   }
 234
 235   /**
 236    * Set default values for the form. Note that in edit/view mode
 237    * the default values are retrieved from the database
 238    *
 239    * @param null
 240    *
 241    * @return array   array of default values
 242    */
 243   public function setDefaultValues() {
 244     $defaults = array('is_active' => TRUE);
 245     if ($this->_sid) {
 246       $params = array('id' => $this->_sid);
 247       CRM_Price_BAO_PriceSet::retrieve($params, $defaults);
 248       $extends = explode(CRM_Core_DAO::VALUE_SEPARATOR, $defaults['extends']);
 249       unset($defaults['extends']);
 250       foreach ($extends as $compId) {
 251         $defaults['extends'][$compId] = 1;
 252       }
 253     }
 254
 255     return $defaults;
 256   }
 257
 258   /**
 259    * Process the form
 260    *
 261    * @param null
 262    *
 263    * @return void
 264    */
 265   public function postProcess() {
 266     // get the submitted form values.
 267     $params = $this->controller->exportValues('Set');
 268     $nameLength = CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceSet', 'name');
 269     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 270     $params['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $params, FALSE);
 271
 272     $compIds = array();
 273     $extends = CRM_Utils_Array::value('extends', $params);
 274     if (is_array($extends)) {
 275       foreach ($extends as $compId => $selected) {
 276         if ($selected) {
 277           $compIds[] = $compId;
 278         }
 279       }
 280     }
 281     $params['extends'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $compIds);
 282
 283     if ($this->_action & CRM_Core_Action::UPDATE) {
 284       $params['id'] = $this->_sid;
 285     }
 286     else {
 287       $params['name'] = CRM_Utils_String::titleToVar($params['title'],
 288         CRM_Utils_Array::value('maxlength', $nameLength));
 289     }
 290
 291     $set = CRM_Price_BAO_PriceSet::create($params);
 292     if ($this->_action & CRM_Core_Action::UPDATE) {
 293       CRM_Core_Session::setStatus(ts('The Set \'%1\' has been saved.', array(1 => $set->title)), ts('Saved'), 'success');
 294     }
 295     else {
 296       // Jump directly to adding a field if popups are disabled
 297       $action = CRM_Core_Resources::singleton()->ajaxPopupsEnabled ? 'browse' : 'add';
 298       $url = CRM_Utils_System::url('civicrm/admin/price/field', array('reset' => 1, 'action' => $action, 'sid' => $set->id, 'new' => 1));
 299       CRM_Core_Session::setStatus(ts("Your Set '%1' has been added. You can add fields to this set now.",
 300           array(1 => $set->title)
 301         ), ts('Saved'), 'success');
 302       $session = CRM_Core_Session::singleton();
 303       $session->replaceUserContext($url);
 304     }
 305   }
 306 }