CRM/Price/Page/Field.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 Price Fields.
  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_Field extends CRM_Core_Page {
  45
  46   public $useLivePageJS = TRUE;
  47
  48   /**
  49    * The price set group id of the field
  50    *
  51    * @var int
  52    * @access protected
  53    */
  54   protected $_sid;
  55
  56   /**
  57    * The action links that we need to display for the browse screen
  58    *
  59    * @var array
  60    * @access private
  61    */
  62   private static $_actionLinks;
  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    * Get the action links for this page.
  74    *
  75    * @param null
  76    *
  77    * @return array  array of action links that we need to display for the browse screen
  78    * @access public
  79    */ function &actionLinks() {
  80     if (!isset(self::$_actionLinks)) {
  81       self::$_actionLinks = array(
  82         CRM_Core_Action::UPDATE => array(
  83           'name' => ts('Edit Price Field'),
  84           'url' => 'civicrm/admin/price/field',
  85           'qs' => 'action=update&reset=1&sid=%%sid%%&fid=%%fid%%',
  86           'title' => ts('Edit Price'),
  87         ),
  88         CRM_Core_Action::PREVIEW => array(
  89           'name' => ts('Preview Field'),
  90           'url' => 'civicrm/admin/price/field',
  91           'qs' => 'action=preview&reset=1&sid=%%sid%%&fid=%%fid%%',
  92           'title' => ts('Preview Price'),
  93         ),
  94         CRM_Core_Action::DISABLE => array(
  95           'name' => ts('Disable'),
  96           'ref' => 'crm-enable-disable',
  97           'title' => ts('Disable Price'),
  98         ),
  99         CRM_Core_Action::ENABLE => array(
 100           'name' => ts('Enable'),
 101           'ref' => 'crm-enable-disable',
 102           'title' => ts('Enable Price'),
 103         ),
 104         CRM_Core_Action::DELETE => array(
 105           'name' => ts('Delete'),
 106           'url' => 'civicrm/admin/price/field',
 107           'qs' => 'action=delete&reset=1&sid=%%sid%%&fid=%%fid%%',
 108           'title' => ts('Delete Price'),
 109         ),
 110       );
 111     }
 112     return self::$_actionLinks;
 113   }
 114
 115   /**
 116    * Browse all price set fields.
 117    *
 118    * @param null
 119    *
 120    * @return void
 121    * @access public
 122    */
 123   function browse() {
 124     $priceField    = array();
 125     $priceFieldBAO = new CRM_Price_BAO_PriceField();
 126
 127     // fkey is sid
 128     $priceFieldBAO->price_set_id = $this->_sid;
 129     $priceFieldBAO->orderBy('weight, label');
 130     $priceFieldBAO->find();
 131
 132     while ($priceFieldBAO->fetch()) {
 133       $priceField[$priceFieldBAO->id] = array();
 134       CRM_Core_DAO::storeValues($priceFieldBAO, $priceField[$priceFieldBAO->id]);
 135
 136       // get price if it's a text field
 137       if ($priceFieldBAO->html_type == 'Text') {
 138         $optionValues = array();
 139         $params = array('price_field_id' => $priceFieldBAO->id);
 140
 141         CRM_Price_BAO_PriceFieldValue::retrieve($params, $optionValues);
 142
 143         $priceField[$priceFieldBAO->id]['price'] = CRM_Utils_Array::value('amount', $optionValues);
 144       }
 145
 146       $action = array_sum(array_keys($this->actionLinks()));
 147
 148       if ($this->_isSetReserved) {
 149         $action -= CRM_Core_Action::UPDATE + CRM_Core_Action::DELETE + CRM_Core_Action::ENABLE + CRM_Core_Action::DISABLE;
 150       }
 151       else {
 152         if ($priceFieldBAO->is_active) {
 153           $action -= CRM_Core_Action::ENABLE;
 154         }
 155         else {
 156           $action -= CRM_Core_Action::DISABLE;
 157         }
 158       }
 159
 160       if ($priceFieldBAO->active_on == '0000-00-00 00:00:00') {
 161         $priceField[$priceFieldBAO->id]['active_on'] = '';
 162       }
 163
 164       if ($priceFieldBAO->expire_on == '0000-00-00 00:00:00') {
 165         $priceField[$priceFieldBAO->id]['expire_on'] = '';
 166       }
 167
 168       // need to translate html types from the db
 169       $htmlTypes = CRM_Price_BAO_PriceField::htmlTypes();
 170       $priceField[$priceFieldBAO->id]['html_type'] = $htmlTypes[$priceField[$priceFieldBAO->id]['html_type']];
 171       $priceField[$priceFieldBAO->id]['order'] = $priceField[$priceFieldBAO->id]['weight'];
 172       $priceField[$priceFieldBAO->id]['action'] = CRM_Core_Action::formLink(
 173         self::actionLinks(),
 174         $action,
 175         array(
 176           'fid' => $priceFieldBAO->id,
 177           'sid' => $this->_sid,
 178         ),
 179         ts('more'),
 180         FALSE,
 181         'priceField.row.actions',
 182         'PriceField',
 183         $priceFieldBAO->id
 184       );
 185     }
 186
 187     $returnURL = CRM_Utils_System::url('civicrm/admin/price/field', "reset=1&action=browse&sid={$this->_sid}");
 188     $filter = "price_set_id = {$this->_sid}";
 189     CRM_Utils_Weight::addOrder($priceField, 'CRM_Price_DAO_PriceField',
 190       'id', $returnURL, $filter
 191     );
 192     $this->assign('priceField', $priceField);
 193   }
 194
 195   /**
 196    * edit price data.
 197    *
 198    * editing would involved modifying existing fields + adding data to new fields.
 199    *
 200    * @param string  $action    the action to be invoked
 201
 202    *
 203    * @return void
 204    * @access public
 205    */
 206   function edit($action) {
 207     // create a simple controller for editing price data
 208     $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Field', ts('Price Field'), $action);
 209
 210     // set the userContext stack
 211     $session = CRM_Core_Session::singleton();
 212     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid));
 213
 214     $controller->set('sid', $this->_sid);
 215     $controller->setEmbedded(TRUE);
 216     $controller->process();
 217     $controller->run();
 218   }
 219
 220   /**
 221    * Run the page.
 222    *
 223    * This method is called after the page is created. It checks for the
 224    * type of action and executes that action.
 225    *
 226    * @param null
 227    *
 228    * @return void
 229    * @access public
 230    */
 231   function run() {
 232
 233     // get the group id
 234     $this->_sid = CRM_Utils_Request::retrieve('sid', 'Positive',
 235       $this
 236     );
 237     $fid = CRM_Utils_Request::retrieve('fid', 'Positive',
 238       $this, FALSE, 0
 239     );
 240     $action = CRM_Utils_Request::retrieve('action', 'String',
 241       // default to 'browse'
 242       $this, FALSE, 'browse'
 243     );
 244
 245     if ($this->_sid) {
 246       $usedBy = CRM_Price_BAO_PriceSet::getUsedBy($this->_sid);
 247       $this->assign('usedBy', $usedBy);
 248       $this->_isSetReserved= CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_sid, 'is_reserved');
 249       $this->assign('isReserved', $this->_isSetReserved);
 250
 251       CRM_Price_BAO_PriceSet::checkPermission($this->_sid);
 252       $comps = array(
 253         'Event' => 'civicrm_event',
 254         'Contribution' => 'civicrm_contribution_page',
 255         'EventTemplate' => 'civicrm_event_template'
 256       );
 257       $priceSetContexts = array();
 258       foreach ($comps as $name => $table) {
 259         if (array_key_exists($table, $usedBy)) {
 260           $priceSetContexts[] = $name;
 261         }
 262       }
 263       $this->assign('contexts', $priceSetContexts);
 264     }
 265
 266     if ($action & (CRM_Core_Action::DELETE) && !$this->_isSetReserved) {
 267       if (empty($usedBy)) {
 268         // prompt to delete
 269         $session = CRM_Core_Session::singleton();
 270         $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid));
 271         $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_DeleteField', 'Delete Price Field', '');
 272         $controller->set('fid', $fid);
 273         $controller->setEmbedded(TRUE);
 274         $controller->process();
 275         $controller->run();
 276       }
 277       else {
 278         // add breadcrumb
 279         $url = CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1');
 280         CRM_Utils_System::appendBreadCrumb(ts('Price'),
 281           $url
 282         );
 283         $this->assign('usedPriceSetTitle', CRM_Price_BAO_PriceField::getTitle($fid));
 284       }
 285     }
 286
 287     if ($this->_sid) {
 288       $groupTitle = CRM_Price_BAO_PriceSet::getTitle($this->_sid);
 289       $this->assign('sid', $this->_sid);
 290       $this->assign('groupTitle', $groupTitle);
 291       CRM_Utils_System::setTitle(ts('%1 - Price Fields', array(1 => $groupTitle)));
 292     }
 293
 294     // assign vars to templates
 295     $this->assign('action', $action);
 296
 297     // what action to take ?
 298     if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD) && !$this->_isSetReserved) {
 299       // no browse for edit/update/view
 300       $this->edit($action);
 301     }
 302     elseif ($action & CRM_Core_Action::PREVIEW) {
 303       $this->preview($fid);
 304     }
 305     else {
 306       $this->browse();
 307     }
 308
 309     // Call the parents run method
 310     return parent::run();
 311   }
 312
 313   /**
 314    * Preview price field
 315    *
 316    * @param $fid
 317    *
 318    * @internal param int $id price field id
 319    *
 320    * @return void
 321    * @access public
 322    */
 323   function preview($fid) {
 324     $controller = new CRM_Core_Controller_Simple('CRM_Price_Form_Preview', ts('Preview Form Field'), CRM_Core_Action::PREVIEW);
 325     $session = CRM_Core_Session::singleton();
 326     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/price/field', 'reset=1&action=browse&sid=' . $this->_sid));
 327     $controller->set('fieldId', $fid);
 328     $controller->set('groupId', $this->_sid);
 329     $controller->setEmbedded(TRUE);
 330     $controller->process();
 331     $controller->run();
 332   }
 333 }
 334