CRM add remaining missing comment blocks (autogenerated)
[civicrm-core.git] / CRM / PCP / Page / PCP.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 financial types
38 */
39 class CRM_PCP_Page_PCP 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_PCP_BAO_PCP';
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 delete this Campaign Page ?');
67
68 self::$_links = array(
69 CRM_Core_Action::UPDATE => array(
70 'name' => ts('Edit'),
71 'url' => 'civicrm/pcp/info',
72 'qs' => 'action=update&reset=1&id=%%id%%&context=dashboard',
73 'title' => ts('Edit Personal Campaign Page'),
74 ),
75 CRM_Core_Action::RENEW => array(
76 'name' => ts('Approve'),
77 'url' => 'civicrm/admin/pcp',
78 'qs' => 'action=renew&id=%%id%%',
79 'title' => ts('Approve Personal Campaign Page'),
80 ),
81 CRM_Core_Action::REVERT => array(
82 'name' => ts('Reject'),
83 'url' => 'civicrm/admin/pcp',
84 'qs' => 'action=revert&id=%%id%%',
85 'title' => ts('Reject Personal Campaign Page'),
86 ),
87 CRM_Core_Action::DELETE => array(
88 'name' => ts('Delete'),
89 'url' => 'civicrm/admin/pcp',
90 'qs' => 'action=delete&id=%%id%%',
91 'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
92 'title' => ts('Delete Personal Campaign Page'),
93 ),
94 CRM_Core_Action::ENABLE => array('name' => ts('Enable'),
95 'url' => 'civicrm/admin/pcp',
96 'qs' => 'action=enable&id=%%id%%',
97 'title' => ts('Enable'),
98 ),
99 CRM_Core_Action::DISABLE => array('name' => ts('Disable'),
100 'url' => 'civicrm/admin/pcp',
101 'qs' => 'action=disable&id=%%id%%',
102 'title' => ts('Disable'),
103 ),
104 );
105 }
106 return self::$_links;
107 }
108
109 /**
110 * Run the page.
111 *
112 * This method is called after the page is created. It checks for the
113 * type of action and executes that action.
114 * Finally it calls the parent's run method.
115 *
116 * @param
117 *
118 * @return void
119 * @access public
120 */
121 function run() {
122 // get the requested action
123 $action = CRM_Utils_Request::retrieve('action', 'String',
124 $this, FALSE,
125 'browse'
126 );
127 if ($action & CRM_Core_Action::REVERT) {
128 $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
129 CRM_PCP_BAO_PCP::setIsActive($id, 0);
130 $session = CRM_Core_Session::singleton();
131 $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1'));
132 }
133 elseif ($action & CRM_Core_Action::RENEW) {
134 $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
135 CRM_PCP_BAO_PCP::setIsActive($id, 1);
136 $session = CRM_Core_Session::singleton();
137 $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1'));
138 }
139 elseif ($action & CRM_Core_Action::DELETE) {
140 $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
141 $session = CRM_Core_Session::singleton();
142 $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1&action=browse'));
143 $controller = new CRM_Core_Controller_Simple('CRM_PCP_Form_PCP',
144 'Personal Campaign Page',
145 CRM_Core_Action::DELETE
146 );
147 //$this->setContext( $id, $action );
148 $controller->set('id', $id);
149 $controller->process();
150 return $controller->run();
151 }
152
153 // finally browse
154 $this->browse();
155
156 // parent run
157 parent::run();
158 }
159
160 /**
161 * Browse all custom data groups.
162 *
163 *
164 * @param null $action
165 *
166 * @return void
167 * @access public
168 * @static
169 */
170 function browse($action = NULL) {
171 $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter',
172 'String',
173 $this
174 );
175 if ($this->_sortByCharacter == 1 ||
176 !empty($_POST)
177 ) {
178 $this->_sortByCharacter = '';
179 }
180
181
182 $status = CRM_PCP_BAO_PCP::buildOptions('status_id', 'create');
183
184 $pcpSummary = $params = array();
185 $whereClause = NULL;
186
187 if (!empty($_POST) || !empty($_GET['page_type'])) {
188 if (!empty($_POST['status_id'])) {
189 $whereClause = ' AND cp.status_id = %1';
190 $params['1'] = array($_POST['status_id'], 'Integer');
191 }
192
193 if (!empty($_POST['page_type'])) {
194 $whereClause .= ' AND cp.page_type = %2';
195 $params['2'] = array($_POST['page_type'], 'String');
196 }
197 elseif (!empty($_GET['page_type'])) {
198 $whereClause .= ' AND cp.page_type = %2';
199 $params['2'] = array($_GET['page_type'], 'String');
200 }
201
202 if (!empty($_POST['page_id'])) {
203 $whereClause .= ' AND cp.page_id = %4 AND cp.page_type = "contribute"';
204 $params['4'] = array($_POST['page_id'], 'Integer');
205 }
206
207 if (!empty($_POST['event_id'])) {
208 $whereClause .= ' AND cp.page_id = %5 AND cp.page_type = "event"';
209 $params['5'] = array($_POST['event_id'], 'Integer');
210 }
211
212 if ($whereClause) {
213 $this->set('whereClause', $whereClause);
214 $this->set('params', $params);
215 }
216 else {
217 $this->set('whereClause', NULL);
218 $this->set('params', NULL);
219 }
220 }
221
222 $approvedId = CRM_Core_OptionGroup::getValue('pcp_status', 'Approved', 'name');
223
224 //check for delete CRM-4418
225 $allowToDelete = CRM_Core_Permission::check('delete in CiviContribute');
226
227 // get all contribution pages
228 $query = "SELECT id, title, start_date, end_date FROM civicrm_contribution_page WHERE (1)";
229 $cpages = CRM_Core_DAO::executeQuery($query);
230 while ($cpages->fetch()) {
231 $pages['contribute'][$cpages->id]['id'] = $cpages->id;
232 $pages['contribute'][$cpages->id]['title'] = $cpages->title;
233 $pages['contribute'][$cpages->id]['start_date'] = $cpages->start_date;
234 $pages['contribute'][$cpages->id]['end_date'] = $cpages->end_date;
235 }
236
237 // get all event pages. pcp campaign start and end dates for event related pcp's use the online registration start and end dates,
238 // altho if target is contribution page this might not be correct. fixme? dgg
239 $query = "SELECT id, title, start_date, end_date, registration_start_date, registration_end_date
240 FROM civicrm_event
241 WHERE is_template IS NULL OR is_template != 1";
242 $epages = CRM_Core_DAO::executeQuery($query);
243 while ($epages->fetch()) {
244 $pages['event'][$epages->id]['id'] = $epages->id;
245 $pages['event'][$epages->id]['title'] = $epages->title;
246 $pages['event'][$epages->id]['start_date'] = $epages->registration_start_date;
247 $pages['event'][$epages->id]['end_date'] = $epages->registration_end_date;
248 }
249
250 $params = $this->get('params') ? $this->get('params') : array();
251
252 $title = '1';
253 if ($this->_sortByCharacter !== NULL) {
254 $clauses[] = "cp.title LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($this->_sortByCharacter)) . "%'";
255 }
256
257 $query = "
258 SELECT cp.id, cp.contact_id , cp.status_id, cp.title, cp.is_active, cp.page_type, cp.page_id
259 FROM civicrm_pcp cp
260 WHERE $title" . $this->get('whereClause') . " ORDER BY cp.status_id";
261
262 $pcp = CRM_Core_DAO::executeQuery($query, $params);
263 while ($pcp->fetch()) {
264 $action = array_sum(array_keys($this->links()));
265 $contact = CRM_Contact_BAO_Contact::getDisplayAndImage($pcp->contact_id);
266
267 $class = '';
268
269 if ($pcp->status_id != $approvedId || $pcp->is_active != 1) {
270 $class = 'disabled';
271 }
272
273 switch ($pcp->status_id) {
274 case 2:
275 $action -= CRM_Core_Action::RENEW;
276 break;
277
278 case 3:
279 $action -= CRM_Core_Action::REVERT;
280 break;
281 }
282
283 switch ($pcp->is_active) {
284 case 1:
285 $action -= CRM_Core_Action::ENABLE;
286 break;
287
288 case 0:
289 $action -= CRM_Core_Action::DISABLE;
290 break;
291 }
292
293 if (!$allowToDelete) {
294 $action -= CRM_Core_Action::DELETE;
295 }
296
297 $page_type = $pcp->page_type;
298 $page_id = (int) $pcp->page_id;
299 if ($pages[$page_type][$page_id]['title'] == '' || $pages[$page_type][$page_id]['title'] == NULL) {
300 $title = '(no title found for ' . $page_type . ' id ' . $page_id . ')';
301 }
302 else {
303 $title = $pages[$page_type][$page_id]['title'];
304 }
305
306 if ($pcp->page_type == 'contribute') {
307 $pageUrl = CRM_Utils_System::url('civicrm/' . $page_type . '/transact', 'reset=1&id=' . $pcp->page_id);
308 }
309 else {
310 $pageUrl = CRM_Utils_System::url('civicrm/' . $page_type . '/register', 'reset=1&id=' . $pcp->page_id);
311 }
312
313 $pcpSummary[$pcp->id] = array(
314 'id' => $pcp->id,
315 'start_date' => $pages[$page_type][$page_id]['start_date'],
316 'end_date' => $pages[$page_type][$page_id]['end_date'],
317 'supporter' => $contact['0'],
318 'supporter_id' => $pcp->contact_id,
319 'status_id' => $status[$pcp->status_id],
320 'page_id' => $page_id,
321 'page_title' => $title,
322 'page_url' => $pageUrl,
323 'page_type' => $page_type,
324 'action' => CRM_Core_Action::formLink(self::links(), $action,
325 array('id' => $pcp->id), ts('more'), FALSE, 'contributionpage.pcp.list', 'PCP', $pcp->id
326 ),
327 'title' => $pcp->title,
328 'class' => $class,
329 );
330 }
331
332 $this->search();
333 $this->pagerAToZ($this->get('whereClause'), $params);
334
335 $this->assign('rows', $pcpSummary);
336
337 // Let template know if user has run a search or not
338 if ($this->get('whereClause')) {
339 $this->assign('isSearch', 1);
340 }
341 else {
342 $this->assign('isSearch', 0);
343 }
344 }
345
346 function search() {
347
348 if ($this->_action & CRM_Core_Action::DELETE) {
349 return;
350 }
351
352 $form = new CRM_Core_Controller_Simple('CRM_PCP_Form_PCP', ts('Search Campaign Pages'), CRM_Core_Action::ADD);
353 $form->setEmbedded(TRUE);
354 $form->setParent($this);
355 $form->process();
356 $form->run();
357 }
358
359 /**
360 * Get name of edit form
361 *
362 * @return string Classname of edit form.
363 */
364 function editForm() {
365 return 'CRM_PCP_Form_PCP';
366 }
367
368 /**
369 * Get edit form name
370 *
371 * @return string name of this page.
372 */
373 function editName() {
374 return ts('Personal Campaign Page');
375 }
376
377 /**
378 * Get user context.
379 *
380 * @param null $mode
381 *
382 * @return string user context.
383 */
384 function userContext($mode = NULL) {
385 return 'civicrm/admin/pcp';
386 }
387
388 //@TODO this function changed, debug this at runtime
389 /**
390 * @param $whereClause
391 * @param $whereParams
392 */
393 function pagerAtoZ($whereClause, $whereParams) {
394 $where = '';
395 if ($whereClause) {
396 if (strpos($whereClause, ' AND') == 0) {
397 $whereClause = substr($whereClause, 4);
398 }
399 $where = 'WHERE ' . $whereClause;
400 }
401
402 $query = "
403 SELECT UPPER(LEFT(cp.title, 1)) as sort_name
404 FROM civicrm_pcp cp
405 " . $where . "
406 ORDER BY LEFT(cp.title, 1);
407 ";
408
409 $dao = CRM_Core_DAO::executeQuery($query, $whereParams);
410
411 $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE);
412 $this->assign('aToZ', $aToZBar);
413 }
414 }
415