CRM/Case/Task.php

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