Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
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 | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * class to represent the actions that can be performed on a group of | |
38 | * contacts (CiviMember) | |
39 | * used by the search forms | |
40 | * | |
41 | */ | |
e335ab3b MW |
42 | class CRM_Member_Task extends CRM_Core_Task { |
43 | const | |
44 | // Member tasks | |
45 | LABEL_MEMBERS = 201; | |
6a488035 | 46 | |
e335ab3b | 47 | static $objectType = 'membership'; |
6a488035 TO |
48 | |
49 | /** | |
50 | * These tasks are the core set of tasks that the user can perform | |
51 | * on a contact / group of contacts | |
52 | * | |
a6c01b45 CW |
53 | * @return array |
54 | * the set of tasks for a group of contacts | |
6a488035 | 55 | */ |
e335ab3b MW |
56 | public static function tasks() { |
57 | if (!self::$_tasks) { | |
6a488035 | 58 | self::$_tasks = array( |
e335ab3b | 59 | self::TASK_DELETE => array( |
7f82e636 | 60 | 'title' => ts('Delete memberships'), |
6a488035 TO |
61 | 'class' => 'CRM_Member_Form_Task_Delete', |
62 | 'result' => FALSE, | |
63 | ), | |
e335ab3b | 64 | self::TASK_PRINT => array( |
7f82e636 | 65 | 'title' => ts('Print selected rows'), |
6a488035 TO |
66 | 'class' => 'CRM_Member_Form_Task_Print', |
67 | 'result' => FALSE, | |
68 | ), | |
e335ab3b | 69 | self::TASK_EXPORT => array( |
7f82e636 | 70 | 'title' => ts('Export members'), |
6a488035 TO |
71 | 'class' => array( |
72 | 'CRM_Export_Form_Select', | |
73 | 'CRM_Export_Form_Map', | |
74 | ), | |
75 | 'result' => FALSE, | |
76 | ), | |
e335ab3b | 77 | self::TASK_EMAIL => array( |
21d01648 MW |
78 | 'title' => ts('Email - send now (to %1 or less)', array( |
79 | 1 => Civi::settings() | |
80 | ->get('simple_mail_limit'), | |
81 | )), | |
6a488035 TO |
82 | 'class' => 'CRM_Member_Form_Task_Email', |
83 | 'result' => TRUE, | |
84 | ), | |
e335ab3b | 85 | self::BATCH_UPDATE => array( |
b581842f | 86 | 'title' => ts('Update multiple memberships'), |
6a488035 TO |
87 | 'class' => array( |
88 | 'CRM_Member_Form_Task_PickProfile', | |
89 | 'CRM_Member_Form_Task_Batch', | |
90 | ), | |
91 | 'result' => TRUE, | |
92 | ), | |
e335ab3b | 93 | self::LABEL_MEMBERS => array( |
7f82e636 | 94 | 'title' => ts('Mailing labels - print'), |
2d3e3c7b | 95 | 'class' => array( |
96 | 'CRM_Member_Form_Task_Label', | |
97 | ), | |
98 | 'result' => TRUE, | |
99 | ), | |
e335ab3b | 100 | self::PDF_LETTER => array( |
cd095eae | 101 | 'title' => ts('Print/merge document for memberships'), |
2d3e3c7b | 102 | 'class' => 'CRM_Member_Form_Task_PDFLetter', |
103 | 'result' => FALSE, | |
104 | ), | |
fecb40f5 MW |
105 | self::SAVE_SEARCH => array( |
106 | 'title' => ts('Group - create smart group'), | |
107 | 'class' => 'CRM_Contact_Form_Task_SaveSearch', | |
108 | 'result' => TRUE, | |
109 | ), | |
110 | self::SAVE_SEARCH_UPDATE => array( | |
111 | 'title' => ts('Group - update smart group'), | |
112 | 'class' => 'CRM_Contact_Form_Task_SaveSearch_Update', | |
113 | 'result' => TRUE, | |
114 | ), | |
6a488035 TO |
115 | ); |
116 | ||
117 | //CRM-4418, check for delete | |
118 | if (!CRM_Core_Permission::check('delete in CiviMember')) { | |
e335ab3b | 119 | unset(self::$_tasks[self::TASK_DELETE]); |
6a488035 | 120 | } |
447c72b5 | 121 | //CRM-12920 - check for edit permission |
481a74f4 | 122 | if (!CRM_Core_Permission::check('edit memberships')) { |
e335ab3b | 123 | unset(self::$_tasks[self::BATCH_UPDATE]); |
447c72b5 | 124 | } |
4d73a5a7 | 125 | |
e335ab3b | 126 | parent::tasks(); |
6a488035 | 127 | } |
4d73a5a7 | 128 | |
6a488035 TO |
129 | return self::$_tasks; |
130 | } | |
131 | ||
132 | /** | |
133 | * These tasks are the core set of task titles | |
134 | * on members | |
135 | * | |
a6c01b45 CW |
136 | * @return array |
137 | * the set of task titles | |
6a488035 | 138 | */ |
e335ab3b MW |
139 | public static function taskTitles() { |
140 | return parent::taskTitles(); | |
6a488035 TO |
141 | } |
142 | ||
143 | /** | |
100fef9d | 144 | * Show tasks selectively based on the permission level |
6a488035 TO |
145 | * of the user |
146 | * | |
147 | * @param int $permission | |
e335ab3b | 148 | * @param array $params |
6a488035 | 149 | * |
a6c01b45 CW |
150 | * @return array |
151 | * set of tasks that are valid for the user | |
6a488035 | 152 | */ |
e335ab3b | 153 | public static function permissionedTaskTitles($permission, $params = array()) { |
6a488035 TO |
154 | if (($permission == CRM_Core_Permission::EDIT) |
155 | || CRM_Core_Permission::check('edit memberships') | |
156 | ) { | |
157 | $tasks = self::taskTitles(); | |
158 | } | |
159 | else { | |
160 | $tasks = array( | |
e335ab3b MW |
161 | self::TASK_EXPORT => self::$_tasks[self::TASK_EXPORT]['title'], |
162 | self::TASK_EMAIL => self::$_tasks[self::TASK_EMAIL]['title'], | |
6a488035 TO |
163 | ); |
164 | //CRM-4418, | |
165 | if (CRM_Core_Permission::check('delete in CiviMember')) { | |
e335ab3b | 166 | $tasks[self::TASK_DELETE] = self::$_tasks[self::TASK_DELETE]['title']; |
6a488035 TO |
167 | } |
168 | } | |
e335ab3b MW |
169 | |
170 | $tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params); | |
6a488035 TO |
171 | return $tasks; |
172 | } | |
173 | ||
174 | /** | |
175 | * These tasks are the core set of tasks that the user can perform | |
176 | * on members | |
177 | * | |
178 | * @param int $value | |
179 | * | |
a6c01b45 CW |
180 | * @return array |
181 | * the set of tasks for a group of members | |
6a488035 | 182 | */ |
00be9182 | 183 | public static function getTask($value) { |
6a488035 TO |
184 | self::tasks(); |
185 | if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) { | |
e335ab3b MW |
186 | // Make the print task the default |
187 | $value = self::TASK_PRINT; | |
6a488035 | 188 | } |
e335ab3b | 189 | return parent::getTask($value); |
6a488035 | 190 | } |
96025800 | 191 | |
6a488035 | 192 | } |