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