CRM/Case/Task.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  * 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_Case_Task {
  42   CONST DELETE_CASES = 1, PRINT_CASES = 2, EXPORT_CASES = 3, RESTORE_CASES = 4;
  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(
  71         1 => array('title' => ts('Delete Cases'),
  72           'class' => 'CRM_Case_Form_Task_Delete',
  73           'result' => FALSE,
  74         ),
  75         2 => array('title' => ts('Print Cases'),
  76           'class' => 'CRM_Case_Form_Task_Print',
  77           'result' => FALSE,
  78         ),
  79         3 => array('title' => ts('Export Cases'),
  80           'class' => array(
  81             'CRM_Export_Form_Select',
  82             'CRM_Export_Form_Map',
  83           ),
  84           'result' => FALSE,
  85         ),
  86         4 => array('title' => ts('Restore Cases'),
  87           'class' => 'CRM_Case_Form_Task_Restore',
  88           'result' => FALSE,
  89         ),
  90       );
  91       //CRM-4418, check for delete
  92       if (!CRM_Core_Permission::check('delete in CiviCase')) {
  93         unset(self::$_tasks[1]);
  94       }
  95     }
  96
  97     CRM_Utils_Hook::searchTasks('case', self::$_tasks);
  98     asort(self::$_tasks);
  99     return self::$_tasks;
 100   }
 101
 102   /**
 103    * These tasks are the core set of task titles
 104    *
 105    * @return array the set of task titles
 106    * @static
 107    * @access public
 108    */
 109   static function &taskTitles() {
 110     self::tasks();
 111     $titles = array();
 112     foreach (self::$_tasks as $id => $value) {
 113       // skip Print Cases task
 114       if ($id != 2) {
 115         $titles[$id] = $value['title'];
 116       }
 117     }
 118     return $titles;
 119   }
 120
 121   /**
 122    * These tasks get added based on the context the user is in
 123    *
 124    * @return array the set of optional tasks for a group of contacts
 125    * @static
 126    * @access public
 127    */
 128   static function &optionalTaskTitle() {
 129     $tasks = array();
 130     return $tasks;
 131   }
 132
 133   /**
 134    * show tasks selectively based on the permission level
 135    * of the user
 136    *
 137    * @param int $permission
 138    *
 139    * @return array set of tasks that are valid for the user
 140    * @access public
 141    */
 142   static function &permissionedTaskTitles($permission) {
 143     $tasks = array();
 144     if (($permission == CRM_Core_Permission::EDIT)
 145       || CRM_Core_Permission::check('access all cases and activities')
 146       || CRM_Core_Permission::check('access my cases and activities')
 147     ) {
 148       $tasks = self::taskTitles();
 149     }
 150     else {
 151       $tasks = array(
 152         3 => self::$_tasks[3]['title'],
 153       );
 154       //CRM-4418,
 155       if (CRM_Core_Permission::check('delete in CiviCase')) {
 156         $tasks[1] = self::$_tasks[1]['title'];
 157       }
 158     }
 159     return $tasks;
 160   }
 161
 162   /**
 163    * These tasks are the core set of tasks
 164    *
 165    * @param int $value
 166    *
 167    * @return array the set of tasks for a group of contacts
 168    * @static
 169    * @access public
 170    */
 171   static function getTask($value) {
 172     self::tasks();
 173     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 174       // make the print task by default
 175       $value = 2;
 176     }
 177
 178     return array(
 179       self::$_tasks[$value]['class'],
 180       self::$_tasks[$value]['result'],
 181     );
 182   }
 183 }
 184