Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
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 | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
67d19299 | 35 | * Class to represent the actions that can be performed on a group of contacts. |
6a488035 | 36 | * |
67d19299 | 37 | * Used by the search forms |
6a488035 TO |
38 | */ |
39 | class CRM_Case_Task { | |
7da04cde | 40 | const DELETE_CASES = 1, PRINT_CASES = 2, EXPORT_CASES = 3, RESTORE_CASES = 4; |
6a488035 TO |
41 | |
42 | /** | |
100fef9d | 43 | * The task array |
6a488035 TO |
44 | * |
45 | * @var array | |
6a488035 TO |
46 | */ |
47 | static $_tasks = NULL; | |
48 | ||
49 | /** | |
100fef9d | 50 | * The optional task array |
6a488035 TO |
51 | * |
52 | * @var array | |
6a488035 TO |
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 | * | |
a6c01b45 CW |
60 | * @return array |
61 | * the set of tasks for a group of contacts | |
6a488035 | 62 | */ |
00be9182 | 63 | public static function &tasks() { |
6a488035 TO |
64 | if (!self::$_tasks) { |
65 | self::$_tasks = array( | |
23546577 | 66 | 1 => array( |
7f82e636 | 67 | 'title' => ts('Delete cases'), |
6a488035 TO |
68 | 'class' => 'CRM_Case_Form_Task_Delete', |
69 | 'result' => FALSE, | |
70 | ), | |
23546577 | 71 | 2 => array( |
7f82e636 | 72 | 'title' => ts('Print selected rows'), |
6a488035 TO |
73 | 'class' => 'CRM_Case_Form_Task_Print', |
74 | 'result' => FALSE, | |
75 | ), | |
23546577 | 76 | 3 => array( |
7f82e636 | 77 | 'title' => ts('Export cases'), |
6a488035 TO |
78 | 'class' => array( |
79 | 'CRM_Export_Form_Select', | |
80 | 'CRM_Export_Form_Map', | |
81 | ), | |
82 | 'result' => FALSE, | |
83 | ), | |
23546577 | 84 | 4 => array( |
7f82e636 | 85 | 'title' => ts('Restore cases'), |
6a488035 TO |
86 | 'class' => 'CRM_Case_Form_Task_Restore', |
87 | 'result' => FALSE, | |
88 | ), | |
89 | ); | |
90 | //CRM-4418, check for delete | |
91 | if (!CRM_Core_Permission::check('delete in CiviCase')) { | |
92 | unset(self::$_tasks[1]); | |
93 | } | |
94 | } | |
95 | ||
96 | CRM_Utils_Hook::searchTasks('case', self::$_tasks); | |
97 | asort(self::$_tasks); | |
98 | return self::$_tasks; | |
99 | } | |
100 | ||
101 | /** | |
fe482240 | 102 | * These tasks are the core set of task titles. |
6a488035 | 103 | * |
a6c01b45 CW |
104 | * @return array |
105 | * the set of task titles | |
6a488035 | 106 | */ |
00be9182 | 107 | public static function &taskTitles() { |
6a488035 TO |
108 | self::tasks(); |
109 | $titles = array(); | |
110 | foreach (self::$_tasks as $id => $value) { | |
e341bbee | 111 | $titles[$id] = $value['title']; |
6a488035 TO |
112 | } |
113 | return $titles; | |
114 | } | |
115 | ||
116 | /** | |
fe482240 | 117 | * These tasks get added based on the context the user is in. |
6a488035 | 118 | * |
a6c01b45 CW |
119 | * @return array |
120 | * the set of optional tasks for a group of contacts | |
6a488035 | 121 | */ |
00be9182 | 122 | public static function &optionalTaskTitle() { |
6a488035 TO |
123 | $tasks = array(); |
124 | return $tasks; | |
125 | } | |
126 | ||
127 | /** | |
fe482240 | 128 | * Show tasks selectively based on the permission level. |
6a488035 TO |
129 | * of the user |
130 | * | |
131 | * @param int $permission | |
132 | * | |
a6c01b45 CW |
133 | * @return array |
134 | * set of tasks that are valid for the user | |
6a488035 | 135 | */ |
00be9182 | 136 | public static function &permissionedTaskTitles($permission) { |
6a488035 TO |
137 | $tasks = array(); |
138 | if (($permission == CRM_Core_Permission::EDIT) | |
139 | || CRM_Core_Permission::check('access all cases and activities') | |
140 | || CRM_Core_Permission::check('access my cases and activities') | |
141 | ) { | |
142 | $tasks = self::taskTitles(); | |
143 | } | |
144 | else { | |
145 | $tasks = array( | |
146 | 3 => self::$_tasks[3]['title'], | |
147 | ); | |
148 | //CRM-4418, | |
149 | if (CRM_Core_Permission::check('delete in CiviCase')) { | |
150 | $tasks[1] = self::$_tasks[1]['title']; | |
151 | } | |
152 | } | |
153 | return $tasks; | |
154 | } | |
155 | ||
156 | /** | |
fe482240 | 157 | * These tasks are the core set of tasks. |
6a488035 TO |
158 | * |
159 | * @param int $value | |
160 | * | |
a6c01b45 CW |
161 | * @return array |
162 | * the set of tasks for a group of contacts | |
6a488035 | 163 | */ |
00be9182 | 164 | public static function getTask($value) { |
6a488035 TO |
165 | self::tasks(); |
166 | if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) { | |
167 | // make the print task by default | |
168 | $value = 2; | |
169 | } | |
170 | ||
171 | return array( | |
172 | self::$_tasks[$value]['class'], | |
173 | self::$_tasks[$value]['result'], | |
174 | ); | |
175 | } | |
96025800 | 176 | |
6a488035 | 177 | } |