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_Pledge_Task { | |
7da04cde | 42 | const DELETE_PLEDGES = 1, PRINT_PLEDGES = 2, EXPORT_PLEDGES = 3; |
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 | 66 | if (!self::$_tasks) { |
098201d8 | 67 | self::$_tasks = array( |
353ffa53 TO |
68 | 1 => array( |
69 | 'title' => ts('Delete Pledges'), | |
6a488035 TO |
70 | 'class' => 'CRM_Pledge_Form_Task_Delete', |
71 | 'result' => FALSE, | |
72 | ), | |
23546577 CW |
73 | 2 => array( |
74 | 'title' => ts('Print Selected Rows'), | |
6a488035 TO |
75 | 'class' => 'CRM_Pledge_Form_Task_Print', |
76 | 'result' => FALSE, | |
77 | ), | |
23546577 CW |
78 | 3 => array( |
79 | 'title' => ts('Export Pledges'), | |
6a488035 TO |
80 | 'class' => array( |
81 | 'CRM_Export_Form_Select', | |
82 | 'CRM_Export_Form_Map', | |
83 | ), | |
84 | 'result' => FALSE, | |
85 | ), | |
86 | ); | |
87 | ||
88 | //CRM-4418, check for delete | |
89 | if (!CRM_Core_Permission::check('delete in CiviPledge')) { | |
90 | unset(self::$_tasks[1]); | |
91 | } | |
92 | } | |
93 | CRM_Utils_Hook::searchTasks('pledge', self::$_tasks); | |
94 | asort(self::$_tasks); | |
95 | return self::$_tasks; | |
96 | } | |
97 | ||
98 | /** | |
99 | * These tasks are the core set of task titles | |
100 | * | |
a6c01b45 CW |
101 | * @return array |
102 | * the set of task titles | |
6a488035 | 103 | */ |
00be9182 | 104 | public static function &taskTitles() { |
6a488035 TO |
105 | self::tasks(); |
106 | $titles = array(); | |
107 | foreach (self::$_tasks as $id => $value) { | |
e341bbee | 108 | $titles[$id] = $value['title']; |
6a488035 TO |
109 | } |
110 | return $titles; | |
111 | } | |
112 | ||
113 | /** | |
114 | * These tasks get added based on the context the user is in | |
115 | * | |
a6c01b45 CW |
116 | * @return array |
117 | * the set of optional tasks for a group of contacts | |
6a488035 | 118 | */ |
00be9182 | 119 | public static function &optionalTaskTitle() { |
6a488035 TO |
120 | $tasks = array(); |
121 | return $tasks; | |
122 | } | |
123 | ||
124 | /** | |
100fef9d | 125 | * Show tasks selectively based on the permission level |
6a488035 TO |
126 | * of the user |
127 | * | |
128 | * @param int $permission | |
129 | * | |
a6c01b45 CW |
130 | * @return array |
131 | * set of tasks that are valid for the user | |
6a488035 | 132 | */ |
00be9182 | 133 | public static function &permissionedTaskTitles($permission) { |
6a488035 TO |
134 | $tasks = array(); |
135 | if (($permission == CRM_Core_Permission::EDIT) | |
136 | || CRM_Core_Permission::check('edit pledges') | |
137 | ) { | |
138 | $tasks = self::taskTitles(); | |
139 | } | |
140 | else { | |
141 | $tasks = array( | |
142 | 3 => self::$_tasks[3]['title'], | |
143 | ); | |
144 | //CRM-4418, | |
145 | if (CRM_Core_Permission::check('delete in CiviPledge')) { | |
146 | $tasks[1] = self::$_tasks[1]['title']; | |
147 | } | |
148 | } | |
149 | return $tasks; | |
150 | } | |
151 | ||
152 | /** | |
153 | * These tasks are the core set of tasks that the user can perform | |
154 | * on pledges | |
155 | * | |
156 | * @param int $value | |
157 | * | |
a6c01b45 CW |
158 | * @return array |
159 | * the set of tasks for a group of pledge holders | |
6a488035 | 160 | */ |
00be9182 | 161 | public static function getTask($value) { |
6a488035 TO |
162 | self::tasks(); |
163 | if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) { | |
164 | // make the print task by default | |
165 | $value = 2; | |
166 | } | |
167 | return array( | |
168 | self::$_tasks[$value]['class'], | |
169 | self::$_tasks[$value]['result'], | |
170 | ); | |
171 | } | |
96025800 | 172 | |
6a488035 | 173 | } |