Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
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 { | |
7da04cde | 42 | const DELETE_CASES = 1, PRINT_CASES = 2, EXPORT_CASES = 3, RESTORE_CASES = 4; |
6a488035 TO |
43 | |
44 | /** | |
100fef9d | 45 | * The task array |
6a488035 TO |
46 | * |
47 | * @var array | |
6a488035 TO |
48 | */ |
49 | static $_tasks = NULL; | |
50 | ||
51 | /** | |
100fef9d | 52 | * The optional task array |
6a488035 TO |
53 | * |
54 | * @var array | |
6a488035 TO |
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 | * | |
a6c01b45 CW |
62 | * @return array |
63 | * the set of tasks for a group of contacts | |
6a488035 | 64 | */ |
00be9182 | 65 | public static function &tasks() { |
6a488035 TO |
66 | if (!self::$_tasks) { |
67 | self::$_tasks = array( | |
23546577 | 68 | 1 => array( |
7f82e636 | 69 | 'title' => ts('Delete cases'), |
6a488035 TO |
70 | 'class' => 'CRM_Case_Form_Task_Delete', |
71 | 'result' => FALSE, | |
72 | ), | |
23546577 | 73 | 2 => array( |
7f82e636 | 74 | 'title' => ts('Print selected rows'), |
6a488035 TO |
75 | 'class' => 'CRM_Case_Form_Task_Print', |
76 | 'result' => FALSE, | |
77 | ), | |
23546577 | 78 | 3 => array( |
7f82e636 | 79 | 'title' => ts('Export cases'), |
6a488035 TO |
80 | 'class' => array( |
81 | 'CRM_Export_Form_Select', | |
82 | 'CRM_Export_Form_Map', | |
83 | ), | |
84 | 'result' => FALSE, | |
85 | ), | |
23546577 | 86 | 4 => array( |
7f82e636 | 87 | 'title' => ts('Restore cases'), |
6a488035 TO |
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 | /** | |
fe482240 | 104 | * These tasks are the core set of task titles. |
6a488035 | 105 | * |
a6c01b45 CW |
106 | * @return array |
107 | * the set of task titles | |
6a488035 | 108 | */ |
00be9182 | 109 | public static function &taskTitles() { |
6a488035 TO |
110 | self::tasks(); |
111 | $titles = array(); | |
112 | foreach (self::$_tasks as $id => $value) { | |
e341bbee | 113 | $titles[$id] = $value['title']; |
6a488035 TO |
114 | } |
115 | return $titles; | |
116 | } | |
117 | ||
118 | /** | |
fe482240 | 119 | * These tasks get added based on the context the user is in. |
6a488035 | 120 | * |
a6c01b45 CW |
121 | * @return array |
122 | * the set of optional tasks for a group of contacts | |
6a488035 | 123 | */ |
00be9182 | 124 | public static function &optionalTaskTitle() { |
6a488035 TO |
125 | $tasks = array(); |
126 | return $tasks; | |
127 | } | |
128 | ||
129 | /** | |
fe482240 | 130 | * Show tasks selectively based on the permission level. |
6a488035 TO |
131 | * of the user |
132 | * | |
133 | * @param int $permission | |
134 | * | |
a6c01b45 CW |
135 | * @return array |
136 | * set of tasks that are valid for the user | |
6a488035 | 137 | */ |
00be9182 | 138 | public static function &permissionedTaskTitles($permission) { |
6a488035 TO |
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 | /** | |
fe482240 | 159 | * These tasks are the core set of tasks. |
6a488035 TO |
160 | * |
161 | * @param int $value | |
162 | * | |
a6c01b45 CW |
163 | * @return array |
164 | * the set of tasks for a group of contacts | |
6a488035 | 165 | */ |
00be9182 | 166 | public static function getTask($value) { |
6a488035 TO |
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 | } | |
96025800 | 178 | |
6a488035 | 179 | } |