CRM/Pledge/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   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  * class to represent the actions that can be performed on a group of contacts
  38  * used by the search forms
  39  *
  40  */
  41 class CRM_Pledge_Task {
  42   CONST DELETE_PLEDGES = 1, PRINT_PLEDGES = 2, EXPORT_PLEDGES = 3;
  43
  44   /**
  45    * the task array
  46    *
  47    * @var array
  48    * @static
  49    */
  50   static $_tasks = NULL;
  51
  52   /**
  53    * the optional task array
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_optionalTasks = NULL;
  59
  60   /**
  61    * These tasks are the core set of tasks that the user can perform
  62    * on a contact / group of contacts
  63    *
  64    * @return array the set of tasks for a group of contacts
  65    * @static
  66    * @access public
  67    */
  68   static function &tasks() {
  69     if (!self::$_tasks) {
  70       self::$_tasks = array(1 => array('title' => ts('Delete Pledges'),
  71           'class' => 'CRM_Pledge_Form_Task_Delete',
  72           'result' => FALSE,
  73         ),
  74         2 => array('title' => ts('Print Pledges'),
  75           'class' => 'CRM_Pledge_Form_Task_Print',
  76           'result' => FALSE,
  77         ),
  78         3 => array('title' => ts('Export Pledges'),
  79           'class' => array(
  80             'CRM_Export_Form_Select',
  81             'CRM_Export_Form_Map',
  82           ),
  83           'result' => FALSE,
  84         ),
  85       );
  86
  87       //CRM-4418, check for delete
  88       if (!CRM_Core_Permission::check('delete in CiviPledge')) {
  89         unset(self::$_tasks[1]);
  90       }
  91     }
  92     CRM_Utils_Hook::searchTasks('pledge', self::$_tasks);
  93     asort(self::$_tasks);
  94     return self::$_tasks;
  95   }
  96
  97   /**
  98    * These tasks are the core set of task titles
  99    *
 100    * @return array the set of task titles
 101    * @static
 102    * @access public
 103    */
 104   static function &taskTitles() {
 105     self::tasks();
 106     $titles = array();
 107     foreach (self::$_tasks as $id => $value) {
 108       // skip Print Pledges task
 109       if ($id != 2) {
 110         $titles[$id] = $value['title'];
 111       }
 112     }
 113     return $titles;
 114   }
 115
 116   /**
 117    * These tasks get added based on the context the user is in
 118    *
 119    * @return array the set of optional tasks for a group of contacts
 120    * @static
 121    * @access public
 122    */
 123   static function &optionalTaskTitle() {
 124     $tasks = array();
 125     return $tasks;
 126   }
 127
 128   /**
 129    * show tasks selectively based on the permission level
 130    * of the user
 131    *
 132    * @param int $permission
 133    *
 134    * @return array set of tasks that are valid for the user
 135    * @access public
 136    */
 137   static function &permissionedTaskTitles($permission) {
 138     $tasks = array();
 139     if (($permission == CRM_Core_Permission::EDIT)
 140       || CRM_Core_Permission::check('edit pledges')
 141     ) {
 142       $tasks = self::taskTitles();
 143     }
 144     else {
 145       $tasks = array(
 146         3 => self::$_tasks[3]['title'],
 147       );
 148       //CRM-4418,
 149       if (CRM_Core_Permission::check('delete in CiviPledge')) {
 150         $tasks[1] = self::$_tasks[1]['title'];
 151       }
 152     }
 153     return $tasks;
 154   }
 155
 156   /**
 157    * These tasks are the core set of tasks that the user can perform
 158    * on pledges
 159    *
 160    * @param int $value
 161    *
 162    * @return array the set of tasks for a group of pledge holders
 163    * @static
 164    * @access public
 165    */
 166   static function getTask($value) {
 167     self::tasks();
 168     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 169       // make the print task by default
 170       $value = 2;
 171     }
 172     return array(
 173       self::$_tasks[$value]['class'],
 174       self::$_tasks[$value]['result'],
 175     );
 176   }
 177 }
 178