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     foreach ($customOption as $id => $values) {
 137       $action = array_sum(array_keys($this->actionLinks()));
 138       if (!empty($values['financial_type_id'])){
 139         $customOption[$id]['financial_type_id'] = $financialType[$values['financial_type_id']];
 140       }
 141       // update enable/disable links depending on price_field properties.
 142       if ($this->_isSetReserved) {
 143         $action -= CRM_Core_Action::UPDATE + CRM_Core_Action::DELETE + CRM_Core_Action::DISABLE + CRM_Core_Action::ENABLE;
 144       }
 145       else {
 146         if ($values['is_active']) {
 147           $action -= CRM_Core_Action::ENABLE;
 148         }
 149         else {
 150           $action -= CRM_Core_Action::DISABLE;
 151         }
 152       }
 153       if (!empty($customOption[$id]['is_default'])) {
 154         $customOption[$id]['is_default'] = '<img src="' . $config->resourceBase . 'i/check.gif" />';
 155       }
 156       else {
 157         $customOption[$id]['is_default'] = '';
 158       }
 159       $customOption[$id]['order'] = $customOption[$id]['weight'];
 160       $customOption[$id]['action'] = CRM_Core_Action::formLink(self::actionLinks(), $action,
 161         array(
 162           'oid' => $id,
 163           'fid' => $this->_fid,
 164           'sid' => $this->_sid,
 165         ),
 166         ts('more'),
 167         FALSE,
 168         'priceFieldValue.row.actions',
 169         'PriceFieldValue',
 170         $id
 171       );
 172     }
 173     // Add order changing widget to selector
 174     $returnURL = CRM_Utils_System::url('civicrm/admin/price/field/option', "action=browse&reset=1&fid={$this->_fid}&sid={$this->_sid}");
 175     $filter = "price_field_id = {$this->_fid}";
 176     CRM_Utils_Weight::addOrder($customOption, 'CRM_Price_DAO_PriceFieldValue',
 177       'id', $returnURL, $filter
 178     );
 179
 180     $this->assign('customOption', $customOption);
 181     $this->assign('sid', $this->_sid);
 182   }
 183
 184   /**
 185    * edit custom Option.
 186    *
 187    * editing would involved modifying existing fields + adding data to new fields.
 188    *
 189    * @param string  $action   the action to be invoked
 190    *
 191    * @return void
 192    * @access public
 193    */
 194   function edit($action) {
 195     $oid = CRM_Utils_Request::retrieve('oid', 'Positive',
 196       $this, FALSE, 0
 197     );
 198     $params = array();
 199     if ($oid) {
 200       $params['oid'] = $oid;
 201       $sid = CRM_Price_BAO_PriceSet::getSetId($params);
 202
 203       $usedBy = CRM_Price_BAO_PriceSet::getUsedBy($sid);
 204     }
 205     // set the userContext stack
 206     $session = CRM_Core_Session::singleton();
 207
 208     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/price/field/option',
 209         "reset=1&action=browse&fid={$this->_fid}&sid={$this->_sid}"
 210       ));
 211     $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Option', ts('Price Field Option'), $action);
 212     $controller->set('fid', $this->_fid);
 213     $controller->setEmbedded(TRUE);
 214     $controller->process();
 215     $controller->run();
 216
 217     if ($action & CRM_Core_Action::DELETE) {
 218       // add breadcrumb
 219       $url = CRM_Utils_System::url('civicrm/admin/price/field/option', 'reset=1');
 220       CRM_Utils_System::appendBreadCrumb(ts('Price Option'),
 221         $url
 222       );
 223       $this->assign('usedPriceSetTitle', CRM_Price_BAO_PriceFieldValue::getOptionLabel($oid));
 224       $this->assign('usedBy', $usedBy);
 225       $comps = array(
 226         "Event" => "civicrm_event",
 227         "Contribution" => "civicrm_contribution_page",
 228       );
 229       $priceSetContexts = array();
 230       foreach ($comps as $name => $table) {
 231         if (array_key_exists($table, $usedBy)) {
 232           $priceSetContexts[] = $name;
 233         }
 234       }
 235       $this->assign('contexts', $priceSetContexts);
 236     }
 237   }
 238
 239   /**
 240    * Run the page.
 241    *
 242    * This method is called after the page is created. It checks for the
 243    * type of action and executes that action.
 244    *
 245    * @param null
 246    *
 247    * @return void
 248    * @access public
 249    */
 250   function run() {
 251
 252     // get the field id
 253     $this->_fid = CRM_Utils_Request::retrieve('fid', 'Positive',
 254       $this, FALSE, 0
 255     );
 256     //get the price set id
 257     if (!$this->_sid) {
 258       $this->_sid = CRM_Utils_Request::retrieve('sid', 'Positive', $this);
 259     }
 260
 261     if ($this->_sid) {
 262       CRM_Price_BAO_PriceSet::checkPermission($this->_sid);
 263       $this->_isSetReserved= CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid, 'is_reserved');
 264       $this->assign('isReserved', $this->_isSetReserved);
 265     }
 266     //as url contain $sid so append breadcrumb dynamically.
 267     $breadcrumb = array(array('title' => ts('Price Fields'),
 268         'url' => CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1&sid=' . $this->_sid),
 269       ));
 270     CRM_Utils_System::appendBreadCrumb($breadcrumb);
 271
 272     if ($this->_fid) {
 273       $fieldTitle = CRM_Price_BAO_PriceField::getTitle($this->_fid);
 274       $this->assign('fid', $this->_fid);
 275       $this->assign('fieldTitle', $fieldTitle);
 276       CRM_Utils_System::setTitle(ts('%1 - Price Options', array(1 => $fieldTitle)));
 277
 278       $htmlType = CRM_Core_DAO::getFieldValue('CRM_Price_BAO_PriceField', $this->_fid, 'html_type');
 279       $this->assign('addMoreFields', TRUE);
 280       //for text price field only single option present
 281       if ($htmlType == 'Text') {
 282         $this->assign('addMoreFields', FALSE);
 283       }
 284     }
 285
 286     // get the requested action
 287     $action = CRM_Utils_Request::retrieve('action', 'String',
 288       // default to 'browse'
 289       $this, FALSE, 'browse'
 290     );
 291
 292     // assign vars to templates
 293     $this->assign('action', $action);
 294
 295     $oid = CRM_Utils_Request::retrieve('oid', 'Positive',
 296       $this, FALSE, 0
 297     );
 298     // what action to take ?
 299     if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD |
 300         CRM_Core_Action::VIEW | CRM_Core_Action::DELETE
 301       ) && !$this->_isSetReserved) {
 302       // no browse for edit/update/view
 303       $this->edit($action);
 304     }
 305     else {
 306       $this->browse();
 307     }
 308     // Call the parents run method
 309     return parent::run();
 310   }
 311 }
 312