Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
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_Grant_Task { | |
7da04cde | 42 | const DELETE_GRANTS = 1, PRINT_GRANTS = 2, EXPORT_GRANTS = 3, UPDATE_GRANTS = 4; |
6a488035 TO |
43 | |
44 | /** | |
100fef9d | 45 | * The task array |
6a488035 TO |
46 | * |
47 | * @var array | |
48 | * @static | |
49 | */ | |
50 | static $_tasks = NULL; | |
51 | ||
52 | /** | |
100fef9d | 53 | * The optional task array |
6a488035 TO |
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 | |
6a488035 | 66 | */ |
00be9182 | 67 | public static function &tasks() { |
6a488035 | 68 | if (!(self::$_tasks)) { |
1afc557a TO |
69 | self::$_tasks = array( |
70 | 1 => array( | |
23546577 | 71 | 'title' => ts('Delete Grants'), |
6a488035 TO |
72 | 'class' => 'CRM_Grant_Form_Task_Delete', |
73 | 'result' => FALSE, | |
74 | ), | |
23546577 CW |
75 | 2 => array( |
76 | 'title' => ts('Print Selected Rows'), | |
6a488035 TO |
77 | 'class' => 'CRM_Grant_Form_Task_Print', |
78 | 'result' => FALSE, | |
79 | ), | |
23546577 CW |
80 | 3 => array( |
81 | 'title' => ts('Export Grants'), | |
6a488035 TO |
82 | 'class' => array( |
83 | 'CRM_Export_Form_Select', | |
84 | 'CRM_Export_Form_Map', | |
85 | ), | |
86 | 'result' => FALSE, | |
87 | ), | |
23546577 CW |
88 | 4 => array( |
89 | 'title' => ts('Update Grants'), | |
6a488035 TO |
90 | 'class' => 'CRM_Grant_Form_Task_Update', |
91 | 'result' => FALSE, | |
92 | ), | |
93 | ); | |
94 | } | |
95 | if (!CRM_Core_Permission::check('delete in CiviGrant')) { | |
96 | unset(self::$_tasks[1]); | |
97 | } | |
98 | CRM_Utils_Hook::searchTasks('grant', 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 the set of task titles | |
107 | * @static | |
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 | /** | |
100fef9d | 119 | * Show tasks selectively based on the permission level |
6a488035 TO |
120 | * of the user |
121 | * | |
122 | * @param int $permission | |
123 | * | |
124 | * @return array set of tasks that are valid for the user | |
6a488035 | 125 | */ |
00be9182 | 126 | public static function &permissionedTaskTitles($permission) { |
6a488035 TO |
127 | $tasks = array(); |
128 | if (($permission == CRM_Core_Permission::EDIT) | |
129 | || CRM_Core_Permission::check('edit grants') | |
130 | ) { | |
131 | $tasks = self::taskTitles(); | |
132 | } | |
133 | else { | |
134 | $tasks = array( | |
135 | 3 => self::$_tasks[3]['title'], | |
136 | ); | |
137 | //CRM-4418, | |
138 | if (CRM_Core_Permission::check('delete in CiviGrant')) { | |
139 | $tasks[1] = self::$_tasks[1]['title']; | |
140 | } | |
141 | } | |
142 | return $tasks; | |
143 | } | |
144 | ||
145 | /** | |
146 | * These tasks are the core set of tasks that the user can perform | |
147 | * | |
148 | * @param int $value | |
149 | * | |
150 | * @return array the set of tasks for a group of contacts | |
151 | * @static | |
6a488035 | 152 | */ |
00be9182 | 153 | public static function getTask($value) { |
6a488035 TO |
154 | self::tasks(); |
155 | if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) { | |
156 | // make the print task by default | |
157 | $value = 2; | |
158 | } | |
159 | return array( | |
160 | self::$_tasks[$value]['class'], | |
161 | self::$_tasks[$value]['result'], | |
162 | ); | |
163 | } | |
164 | } |