CRM/Case/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 /**
  35  * Class to represent the actions that can be performed on a group of contacts.
  36  *
  37  * Used by the search forms
  38  */
  39 class CRM_Case_Task {
  40   const DELETE_CASES = 1, PRINT_CASES = 2, EXPORT_CASES = 3, RESTORE_CASES = 4;
  41
  42   /**
  43    * The task array
  44    *
  45    * @var array
  46    */
  47   static $_tasks = NULL;
  48
  49   /**
  50    * The optional task array
  51    *
  52    * @var array
  53    */
  54   static $_optionalTasks = NULL;
  55
  56   /**
  57    * These tasks are the core set of tasks that the user can perform
  58    * on a contact / group of contacts
  59    *
  60    * @return array
  61    *   the set of tasks for a group of contacts
  62    */
  63   public static function &tasks() {
  64     if (!self::$_tasks) {
  65       self::$_tasks = array(
  66         1 => array(
  67           'title' => ts('Delete cases'),
  68           'class' => 'CRM_Case_Form_Task_Delete',
  69           'result' => FALSE,
  70         ),
  71         2 => array(
  72           'title' => ts('Print selected rows'),
  73           'class' => 'CRM_Case_Form_Task_Print',
  74           'result' => FALSE,
  75         ),
  76         3 => array(
  77           'title' => ts('Export cases'),
  78           'class' => array(
  79             'CRM_Export_Form_Select',
  80             'CRM_Export_Form_Map',
  81           ),
  82           'result' => FALSE,
  83         ),
  84         4 => array(
  85           'title' => ts('Restore cases'),
  86           'class' => 'CRM_Case_Form_Task_Restore',
  87           'result' => FALSE,
  88         ),
  89         5 => array(
  90           'title' => ts('Print/merge Document'),
  91           'class' => 'CRM_Case_Form_Task_PDF',
  92           'result' => FALSE,
  93         ),
  94       );
  95
  96       //CRM-4418, check for delete
  97       if (!CRM_Core_Permission::check('delete in CiviCase')) {
  98         unset(self::$_tasks[1]);
  99       }
 100
 101       CRM_Utils_Hook::searchTasks('case', self::$_tasks);
 102       asort(self::$_tasks);
 103     }
 104
 105     return self::$_tasks;
 106   }
 107
 108   /**
 109    * These tasks are the core set of task titles.
 110    *
 111    * @return array
 112    *   the set of task titles
 113    */
 114   public static function &taskTitles() {
 115     self::tasks();
 116     $titles = array();
 117     foreach (self::$_tasks as $id => $value) {
 118       $titles[$id] = $value['title'];
 119     }
 120     return $titles;
 121   }
 122
 123   /**
 124    * These tasks get added based on the context the user is in.
 125    *
 126    * @return array
 127    *   the set of optional tasks for a group of contacts
 128    */
 129   public 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
 141    *   set of tasks that are valid for the user
 142    */
 143   public 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
 169    *   the set of tasks for a group of contacts
 170    */
 171   public 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 }