CRM/Price/Page/Field.php

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