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