CRM/Price/Page/Option.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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  * Create a page for displaying Custom Options.
  38  *
  39  * Heart of this class is the run method which checks
  40  * for action type and then displays the appropriate
  41  * page.
  42  *
  43  */
  44 class CRM_Price_Page_Option extends CRM_Core_Page {
  45
  46   public $useLivePageJS = TRUE;
  47
  48   /**
  49    * The field id of the option
  50    *
  51    * @var int
  52    * @access protected
  53    */
  54   protected $_fid;
  55
  56   /**
  57    * The field id of the option
  58    *
  59    * @var int
  60    * @access protected
  61    */
  62   protected $_sid;
  63
  64   /**
  65    * The price set is reserved or not
  66    *
  67    * @var boolean
  68    * @access protected
  69    */
  70   protected $_isSetReserved = false;
  71
  72   /**
  73    * The action links that we need to display for the browse screen
  74    *
  75    * @var array
  76    * @access private
  77    */
  78   private static $_actionLinks;
  79
  80   /**
  81    * Get the action links for this page.
  82    *
  83    * @param null
  84    *
  85    * @return array  array of action links that we need to display for the browse screen
  86    * @access public
  87    */ function &actionLinks() {
  88     if (!isset(self::$_actionLinks)) {
  89       self::$_actionLinks = array(
  90         CRM_Core_Action::UPDATE => array(
  91           'name' => ts('Edit Option'),
  92           'url' => 'civicrm/admin/price/field/option',
  93           'qs' => 'reset=1&action=update&oid=%%oid%%&fid=%%fid%%&sid=%%sid%%',
  94           'title' => ts('Edit Price Option'),
  95         ),
  96         CRM_Core_Action::VIEW => array(
  97           'name' => ts('View'),
  98           'url' => 'civicrm/admin/price/field/option',
  99           'qs' => 'action=view&oid=%%oid%%',
 100           'title' => ts('View Price Option'),
 101         ),
 102         CRM_Core_Action::DISABLE => array(
 103           'name' => ts('Disable'),
 104           'ref' => 'crm-enable-disable',
 105           'title' => ts('Disable Price Option'),
 106         ),
 107         CRM_Core_Action::ENABLE => array(
 108           'name' => ts('Enable'),
 109           'ref' => 'crm-enable-disable',
 110           'title' => ts('Enable Price Option'),
 111         ),
 112         CRM_Core_Action::DELETE => array(
 113           'name' => ts('Delete'),
 114           'url' => 'civicrm/admin/price/field/option',
 115           'qs' => 'action=delete&oid=%%oid%%',
 116           'title' => ts('Disable Price Option'),
 117         ),
 118       );
 119     }
 120     return self::$_actionLinks;
 121   }
 122
 123   /**
 124    * Browse all price fields.
 125    *
 126    * @param null
 127    *
 128    * @return void
 129    * @access public
 130    */
 131   function browse() {
 132     $customOption = array();
 133     CRM_Price_BAO_PriceFieldValue::getValues($this->_fid, $customOption);
 134     $config = CRM_Core_Config::singleton();
 135     $financialType = CRM_Contribute_PseudoConstant::financialType();
 136     $taxRate = CRM_Core_PseudoConstant::getTaxRates();
 137     $getTaxDetails = FALSE;
 138     foreach ($customOption as $id => $values) {
 139       $action = array_sum(array_keys($this->actionLinks()));
 140       // Adding the required fields in the array
 141       if (isset($taxRate[$values['financial_type_id']])) {
 142         $customOption[$id]['tax_rate'] = $taxRate[$values['financial_type_id']];
 143         if (isset($customOption[$id]['tax_rate'])) {
 144           $getTaxDetails = TRUE;
 145         }
 146         $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($customOption[$id]['amount'], $customOption[$id]['tax_rate']);
 147         $customOption[$id]['tax_amount'] = $taxAmount['tax_amount'];
 148       }
 149       if (!empty($values['financial_type_id'])){
 150         $customOption[$id]['financial_type_id'] = $financialType[$values['financial_type_id']];
 151       }
 152       // update enable/disable links depending on price_field properties.
 153       if ($this->_isSetReserved) {
 154         $action -= CRM_Core_Action::UPDATE + CRM_Core_Action::DELETE + CRM_Core_Action::DISABLE + CRM_Core_Action::ENABLE;
 155       }
 156       else {
 157         if ($values['is_active']) {
 158           $action -= CRM_Core_Action::ENABLE;
 159         }
 160         else {
 161           $action -= CRM_Core_Action::DISABLE;
 162         }
 163       }
 164       if (!empty($customOption[$id]['is_default'])) {
 165         $customOption[$id]['is_default'] = '<img src="' . $config->resourceBase . 'i/check.gif" />';
 166       }
 167       else {
 168         $customOption[$id]['is_default'] = '';
 169       }
 170       $customOption[$id]['order'] = $customOption[$id]['weight'];
 171       $customOption[$id]['action'] = CRM_Core_Action::formLink(self::actionLinks(), $action,
 172         array(
 173           'oid' => $id,
 174           'fid' => $this->_fid,
 175           'sid' => $this->_sid,
 176         ),
 177         ts('more'),
 178         FALSE,
 179         'priceFieldValue.row.actions',
 180         'PriceFieldValue',
 181         $id
 182       );
 183     }
 184     // Add order changing widget to selector
 185     $returnURL = CRM_Utils_System::url('civicrm/admin/price/field/option', "action=browse&reset=1&fid={$this->_fid}&sid={$this->_sid}");
 186     $filter = "price_field_id = {$this->_fid}";
 187     CRM_Utils_Weight::addOrder($customOption, 'CRM_Price_DAO_PriceFieldValue',
 188       'id', $returnURL, $filter
 189     );
 190
 191     $this->assign('getTaxDetails', $getTaxDetails);
 192     $this->assign('customOption', $customOption);
 193     $this->assign('sid', $this->_sid);
 194   }
 195
 196   /**
 197    * edit custom Option.
 198    *
 199    * editing would involved modifying existing fields + adding data to new fields.
 200    *
 201    * @param string  $action   the action to be invoked
 202    *
 203    * @return void
 204    * @access public
 205    */
 206   function edit($action) {
 207     $oid = CRM_Utils_Request::retrieve('oid', 'Positive',
 208       $this, FALSE, 0
 209     );
 210     $params = array();
 211     if ($oid) {
 212       $params['oid'] = $oid;
 213       $sid = CRM_Price_BAO_PriceSet::getSetId($params);
 214
 215       $usedBy = CRM_Price_BAO_PriceSet::getUsedBy($sid);
 216     }
 217     // set the userContext stack
 218     $session = CRM_Core_Session::singleton();
 219
 220     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/price/field/option',
 221         "reset=1&action=browse&fid={$this->_fid}&sid={$this->_sid}"
 222       ));
 223     $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Option', ts('Price Field Option'), $action);
 224     $controller->set('fid', $this->_fid);
 225     $controller->setEmbedded(TRUE);
 226     $controller->process();
 227     $controller->run();
 228
 229
 230     $this->browse();
 231
 232     if ($action & CRM_Core_Action::DELETE) {
 233       // add breadcrumb
 234       $url = CRM_Utils_System::url('civicrm/admin/price/field/option', 'reset=1');
 235       CRM_Utils_System::appendBreadCrumb(ts('Price Option'),
 236         $url
 237       );
 238       $this->assign('usedPriceSetTitle', CRM_Price_BAO_PriceFieldValue::getOptionLabel($oid));
 239       $this->assign('usedBy', $usedBy);
 240       $comps = array(
 241         "Event" => "civicrm_event",
 242         "Contribution" => "civicrm_contribution_page",
 243       );
 244       $priceSetContexts = array();
 245       foreach ($comps as $name => $table) {
 246         if (array_key_exists($table, $usedBy)) {
 247           $priceSetContexts[] = $name;
 248         }
 249       }
 250       $this->assign('contexts', $priceSetContexts);
 251     }
 252   }
 253
 254   /**
 255    * Run the page.
 256    *
 257    * This method is called after the page is created. It checks for the
 258    * type of action and executes that action.
 259    *
 260    * @param null
 261    *
 262    * @return void
 263    * @access public
 264    */
 265   function run() {
 266
 267     // get the field id
 268     $this->_fid = CRM_Utils_Request::retrieve('fid', 'Positive',
 269       $this, FALSE, 0
 270     );
 271     //get the price set id
 272     if (!$this->_sid) {
 273       $this->_sid = CRM_Utils_Request::retrieve('sid', 'Positive', $this);
 274     }
 275
 276     if ($this->_sid) {
 277       CRM_Price_BAO_PriceSet::checkPermission($this->_sid);
 278       $this->_isSetReserved= CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid, 'is_reserved');
 279       $this->assign('isReserved', $this->_isSetReserved);
 280     }
 281     //as url contain $sid so append breadcrumb dynamically.
 282     $breadcrumb = array(array('title' => ts('Price Fields'),
 283         'url' => CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1&sid=' . $this->_sid),
 284       ));
 285     CRM_Utils_System::appendBreadCrumb($breadcrumb);
 286
 287     if ($this->_fid) {
 288       $fieldTitle = CRM_Price_BAO_PriceField::getTitle($this->_fid);
 289       $this->assign('fid', $this->_fid);
 290       $this->assign('fieldTitle', $fieldTitle);
 291       CRM_Utils_System::setTitle(ts('%1 - Price Options', array(1 => $fieldTitle)));
 292
 293       $htmlType = CRM_Core_DAO::getFieldValue('CRM_Price_BAO_PriceField', $this->_fid, 'html_type');
 294       $this->assign('addMoreFields', TRUE);
 295       //for text price field only single option present
 296       if ($htmlType == 'Text') {
 297         $this->assign('addMoreFields', FALSE);
 298       }
 299     }
 300
 301     // get the requested action
 302     $action = CRM_Utils_Request::retrieve('action', 'String',
 303       // default to 'browse'
 304       $this, FALSE, 'browse'
 305     );
 306
 307     // assign vars to templates
 308     $this->assign('action', $action);
 309
 310     $oid = CRM_Utils_Request::retrieve('oid', 'Positive',
 311       $this, FALSE, 0
 312     );
 313     // what action to take ?
 314     if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD |
 315         CRM_Core_Action::VIEW | CRM_Core_Action::DELETE
 316       ) && !$this->_isSetReserved) {
 317       // no browse for edit/update/view
 318       $this->edit($action);
 319     }
 320     else {
 321       $this->browse();
 322     }
 323     // Call the parents run method
 324     return parent::run();
 325   }
 326 }
 327