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