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    */
  49   static $_tasks = NULL;
  50
  51   /**
  52    * The optional task array
  53    *
  54    * @var array
  55    */
  56   static $_optionalTasks = NULL;
  57
  58   /**
  59    * These tasks are the core set of tasks that the user can perform
  60    * on a contact / group of contacts
  61    *
  62    * @return array
  63    *   the set of tasks for a group of contacts
  64    */
  65   public static function &tasks() {
  66     if (!self::$_tasks) {
  67       self::$_tasks = array(
  68         1 => array(
  69           'title' => ts('Delete Cases'),
  70           'class' => 'CRM_Case_Form_Task_Delete',
  71           'result' => FALSE,
  72         ),
  73         2 => array(
  74           'title' => ts('Print Selected Rows'),
  75           'class' => 'CRM_Case_Form_Task_Print',
  76           'result' => FALSE,
  77         ),
  78         3 => array(
  79           '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(
  87           'title' => ts('Restore Cases'),
  88           'class' => 'CRM_Case_Form_Task_Restore',
  89           'result' => FALSE,
  90         ),
  91       );
  92       //CRM-4418, check for delete
  93       if (!CRM_Core_Permission::check('delete in CiviCase')) {
  94         unset(self::$_tasks[1]);
  95       }
  96     }
  97
  98     CRM_Utils_Hook::searchTasks('case', self::$_tasks);
  99     asort(self::$_tasks);
 100     return self::$_tasks;
 101   }
 102
 103   /**
 104    * These tasks are the core set of task titles
 105    *
 106    * @return array
 107    *   the set of task titles
 108    */
 109   public static function &taskTitles() {
 110     self::tasks();
 111     $titles = array();
 112     foreach (self::$_tasks as $id => $value) {
 113       $titles[$id] = $value['title'];
 114     }
 115     return $titles;
 116   }
 117
 118   /**
 119    * These tasks get added based on the context the user is in
 120    *
 121    * @return array
 122    *   the set of optional tasks for a group of contacts
 123    */
 124   public static function &optionalTaskTitle() {
 125     $tasks = array();
 126     return $tasks;
 127   }
 128
 129   /**
 130    * Show tasks selectively based on the permission level
 131    * of the user
 132    *
 133    * @param int $permission
 134    *
 135    * @return array
 136    *   set of tasks that are valid for the user
 137    */
 138   public static function &permissionedTaskTitles($permission) {
 139     $tasks = array();
 140     if (($permission == CRM_Core_Permission::EDIT)
 141       || CRM_Core_Permission::check('access all cases and activities')
 142       || CRM_Core_Permission::check('access my cases and activities')
 143     ) {
 144       $tasks = self::taskTitles();
 145     }
 146     else {
 147       $tasks = array(
 148         3 => self::$_tasks[3]['title'],
 149       );
 150       //CRM-4418,
 151       if (CRM_Core_Permission::check('delete in CiviCase')) {
 152         $tasks[1] = self::$_tasks[1]['title'];
 153       }
 154     }
 155     return $tasks;
 156   }
 157
 158   /**
 159    * These tasks are the core set of tasks
 160    *
 161    * @param int $value
 162    *
 163    * @return array
 164    *   the set of tasks for a group of contacts
 165    */
 166   public 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
 173     return array(
 174       self::$_tasks[$value]['class'],
 175       self::$_tasks[$value]['result'],
 176     );
 177   }
 178 }