CRM/Contribute/Page/ManagePremiums.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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_ManagePremiums extends CRM_Core_Page_Basic {
  40
  41   public $useLivePageJS = TRUE;
  42
  43   /**
  44    * The action links that we need to display for the browse screen
  45    *
  46    * @var array
  47    * @static
  48    */
  49   static $_links = NULL;
  50
  51   /**
  52    * Get BAO Name
  53    *
  54    * @return string Classname of BAO.
  55    */
  56   public function getBAOName() {
  57     return 'CRM_Contribute_BAO_ManagePremiums';
  58   }
  59
  60   /**
  61    * Get action Links
  62    *
  63    * @return array (reference) of action links
  64    */
  65   public function &links() {
  66     if (!(self::$_links)) {
  67       self::$_links = array(
  68         CRM_Core_Action::UPDATE => array(
  69           'name' => ts('Edit'),
  70           'url' => 'civicrm/admin/contribute/managePremiums',
  71           'qs' => 'action=update&id=%%id%%&reset=1',
  72           'title' => ts('Edit Premium'),
  73         ),
  74         CRM_Core_Action::PREVIEW => array(
  75           'name' => ts('Preview'),
  76           'url' => 'civicrm/admin/contribute/managePremiums',
  77           'qs' => 'action=preview&id=%%id%%',
  78           'title' => ts('Preview Premium'),
  79         ),
  80         CRM_Core_Action::DISABLE => array(
  81           'name' => ts('Disable'),
  82           'ref' => 'crm-enable-disable',
  83           'title' => ts('Disable Premium'),
  84         ),
  85         CRM_Core_Action::ENABLE => array(
  86           'name' => ts('Enable'),
  87           'ref' => 'crm-enable-disable',
  88           'title' => ts('Enable Premium'),
  89         ),
  90         CRM_Core_Action::DELETE => array(
  91           'name' => ts('Delete'),
  92           'url' => 'civicrm/admin/contribute/managePremiums',
  93           'qs' => 'action=delete&id=%%id%%',
  94           'title' => ts('Delete Premium'),
  95         ),
  96       );
  97     }
  98     return self::$_links;
  99   }
 100
 101   /**
 102    * Run the page.
 103    *
 104    * This method is called after the page is created. It checks for the
 105    * type of action and executes that action.
 106    * Finally it calls the parent's run method.
 107    *
 108    * @return void
 109    *
 110    */
 111   public function run() {
 112
 113     // get the requested action
 114     $action = CRM_Utils_Request::retrieve('action', 'String',
 115       // default to 'browse'
 116       $this, FALSE, 'browse'
 117     );
 118
 119     // assign vars to templates
 120     $this->assign('action', $action);
 121     $id = CRM_Utils_Request::retrieve('id', 'Positive',
 122       $this, FALSE, 0
 123     );
 124
 125     // what action to take ?
 126     if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD | CRM_Core_Action::PREVIEW)) {
 127       $this->edit($action, $id, TRUE);
 128     }
 129     // finally browse the custom groups
 130     $this->browse();
 131
 132     // parent run
 133     return parent::run();
 134   }
 135
 136   /**
 137    * Browse all custom data groups.
 138    *
 139    *
 140    * @return void
 141    * @static
 142    */
 143   public function browse() {
 144     // get all custom groups sorted by weight
 145     $premiums = array();
 146     $dao = new CRM_Contribute_DAO_Product();
 147     $dao->orderBy('name');
 148     $dao->find();
 149
 150     while ($dao->fetch()) {
 151       $premiums[$dao->id] = array();
 152       CRM_Core_DAO::storeValues($dao, $premiums[$dao->id]);
 153       // form all action links
 154       $action = array_sum(array_keys($this->links()));
 155
 156       if ($dao->is_active) {
 157         $action -= CRM_Core_Action::ENABLE;
 158       }
 159       else {
 160         $action -= CRM_Core_Action::DISABLE;
 161       }
 162
 163       $premiums[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(),
 164         $action,
 165         array('id' => $dao->id),
 166         ts('more'),
 167         FALSE,
 168         'premium.manage.row',
 169         'Premium',
 170         $dao->id
 171       );
 172       //Financial Type
 173       if( !empty( $dao->financial_type_id )  ){
 174         require_once 'CRM/Core/DAO.php';
 175         $premiums[$dao->id]['financial_type_id'] = CRM_Core_DAO::getFieldValue( 'CRM_Financial_DAO_FinancialType', $dao->financial_type_id, 'name' );
 176       }
 177     }
 178     $this->assign('rows', $premiums);
 179   }
 180
 181   /**
 182    * Get name of edit form
 183    *
 184    * @return string Classname of edit form.
 185    */
 186   public function editForm() {
 187     return 'CRM_Contribute_Form_ManagePremiums';
 188   }
 189
 190   /**
 191    * Get edit form name
 192    *
 193    * @return string name of this page.
 194    */
 195   public function editName() {
 196     return 'Manage Premiums';
 197   }
 198
 199   /**
 200    * Get user context.
 201    *
 202    * @param null $mode
 203    *
 204    * @return string user context.
 205    */
 206   public function userContext($mode = NULL) {
 207     return 'civicrm/admin/contribute/managePremiums';
 208   }
 209 }