CRM/Contribute/Page/Premium.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  * Page for displaying list of Premiums
  38  */
  39 class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic {
  40
  41   /**
  42    * The action links that we need to display for the browse screen
  43    *
  44    * @var array
  45    * @static
  46    */
  47   static $_links = NULL;
  48
  49   /**
  50    * Get BAO Name
  51    *
  52    * @return string Classname of BAO.
  53    */
  54   function getBAOName() {
  55     return 'CRM_Contribute_BAO_Premium';
  56   }
  57
  58   /**
  59    * Get action Links
  60    *
  61    * @return array (reference) of action links
  62    */
  63   function &links() {
  64     if (!(self::$_links)) {
  65       // helper variable for nicer formatting
  66       $deleteExtra = ts('Are you sure you want to remove this product form this page?');
  67
  68       self::$_links = array(
  69         CRM_Core_Action::UPDATE => array(
  70           'name' => ts('Edit'),
  71           'url' => 'civicrm/admin/contribute/addProductToPage',
  72           'qs' => 'action=update&id=%%id%%&pid=%%pid%%&reset=1',
  73           'title' => ts('Edit Premium'),
  74         ),
  75         CRM_Core_Action::PREVIEW => array(
  76           'name' => ts('Preview'),
  77           'url' => 'civicrm/admin/contribute/addProductToPage',
  78           'qs' => 'action=preview&id=%%id%%&pid=%%pid%%',
  79           'title' => ts('Preview Premium'),
  80         ),
  81         CRM_Core_Action::DELETE => array(
  82           'name' => ts('Remove'),
  83           'url' => 'civicrm/admin/contribute/addProductToPage',
  84           'qs' => 'action=delete&id=%%id%%&pid=%%pid%%',
  85           'extra' => 'onclick = "if (confirm(\'' . $deleteExtra . '\') ) this.href+=\'&amp;confirmed=1\'; else return false;"',
  86           'title' => ts('Disable Premium'),
  87         ),
  88       );
  89     }
  90     return self::$_links;
  91   }
  92
  93   /**
  94    * Run the page.
  95    *
  96    * This method is called after the page is created. It checks for the
  97    * type of action and executes that action.
  98    * Finally it calls the parent's run method.
  99    *
 100    * @return void
 101    * @access public
 102    *
 103    */
 104   function run() {
 105     // get the requested action
 106     $action = CRM_Utils_Request::retrieve('action', 'String',
 107       // default to 'browse'
 108       $this, FALSE, 'browse'
 109     );
 110
 111     // assign vars to templates
 112     $this->assign('action', $action);
 113     $id = CRM_Utils_Request::retrieve('id', 'Positive',
 114       $this, FALSE, 0
 115     );
 116     $this->assign('id', $id);
 117
 118     $this->edit($action, $id, FALSE, FALSE);
 119
 120     // this is special case where we need to call browse to list premium
 121     if ($action == CRM_Core_Action::UPDATE) {
 122       $this->browse();
 123     }
 124
 125     // parent run
 126     return parent::run();
 127   }
 128
 129   /**
 130    * @return void
 131    * @access public
 132    * @static
 133    */
 134   function browse() {
 135     // get all custom groups sorted by weight
 136     $premiums = array();
 137     $pageID = CRM_Utils_Request::retrieve('id', 'Positive',
 138       $this, FALSE, 0
 139     );
 140     $dao               = new CRM_Contribute_DAO_Premium();
 141     $dao->entity_table = 'civicrm_contribution_page';
 142     $dao->entity_id    = $pageID;
 143     $dao->find(TRUE);
 144     $premiumID = $dao->id;
 145     $this->assign('products', FALSE);
 146     $this->assign('id', $pageID);
 147     if (!$premiumID) {
 148       return;
 149     }
 150
 151     $dao = new CRM_Contribute_DAO_PremiumsProduct();
 152     $dao->premiums_id = $premiumID;
 153     $dao->orderBy('weight');
 154     $dao->find();
 155
 156     while ($dao->fetch()) {
 157       $productDAO = new CRM_Contribute_DAO_Product();
 158       $productDAO->id = $dao->product_id;
 159       $productDAO->is_active = 1;
 160
 161       if ($productDAO->find(TRUE)) {
 162         $premiums[$productDAO->id] = array();
 163         $premiums[$productDAO->id]['weight'] = $dao->weight;
 164         CRM_Core_DAO::storeValues($productDAO, $premiums[$productDAO->id]);
 165
 166         $action = array_sum(array_keys($this->links()));
 167
 168         $premiums[$dao->product_id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 169           array('id' => $pageID, 'pid' => $dao->id),
 170           ts('more'),
 171           FALSE,
 172           'premium.contributionpage.row',
 173           'Premium',
 174           $dao->id
 175         );
 176         //Financial Type
 177         if (!empty($dao->financial_type_id)) {
 178           $premiums[$productDAO->id]['financial_type_id'] = CRM_Core_DAO::getFieldValue( 'CRM_Financial_DAO_FinancialType', $dao->financial_type_id, 'name' );
 179         }
 180       }
 181     }
 182
 183     if (count(CRM_Contribute_PseudoConstant::products($pageID)) == 0) {
 184       $this->assign('products', FALSE);
 185     }
 186     else {
 187       $this->assign('products', TRUE);
 188     }
 189
 190     // Add order changing widget to selector
 191     $returnURL = CRM_Utils_System::url('civicrm/admin/contribute/premium', "reset=1&action=update&id={$pageID}");
 192     $filter = "premiums_id = {$premiumID}";
 193     CRM_Utils_Weight::addOrder($premiums, 'CRM_Contribute_DAO_PremiumsProduct',
 194       'id', $returnURL, $filter
 195     );
 196     $this->assign('rows', $premiums);
 197   }
 198
 199   /**
 200    * Get name of edit form
 201    *
 202    * @return string Classname of edit form.
 203    */
 204   function editForm() {
 205     return 'CRM_Contribute_Form_ContributionPage_Premium';
 206   }
 207
 208   /**
 209    * Get edit form name
 210    *
 211    * @return string name of this page.
 212    */
 213   function editName() {
 214     return 'Configure Premiums';
 215   }
 216
 217   /**
 218    * Get user context.
 219    *
 220    * @param null $mode
 221    *
 222    * @return string user context.
 223    */
 224   function userContext($mode = NULL) {
 225     return CRM_Utils_System::currentPath();
 226   }
 227 }
 228