Commit | Line | Data |
---|---|---|
2cc569f2 PJ |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
2cc569f2 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
2cc569f2 PJ |
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 | */ |
2cc569f2 PJ |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
2cc569f2 PJ |
32 | */ |
33 | ||
34 | /** | |
35 | * class to represent the actions that can be performed on a group of contacts | |
25606795 | 36 | * used by the search forms. |
2cc569f2 PJ |
37 | * |
38 | */ | |
12009fb4 | 39 | class CRM_Mailing_Task extends CRM_Core_Task { |
2cc569f2 | 40 | |
7e8c8317 | 41 | public static $objectType = 'mailing'; |
2cc569f2 PJ |
42 | |
43 | /** | |
44 | * These tasks are the core set of tasks that the user can perform | |
25606795 | 45 | * on a contact / group of contacts. |
2cc569f2 | 46 | * |
a6c01b45 | 47 | * @return array |
25606795 | 48 | * the set of tasks for a group of contacts. |
2cc569f2 | 49 | */ |
12009fb4 | 50 | public static function tasks() { |
2cc569f2 | 51 | if (!(self::$_tasks)) { |
be2fb01f CW |
52 | self::$_tasks = [ |
53 | self::TASK_PRINT => [ | |
23546577 | 54 | 'title' => ts('Print Mailing Recipients'), |
2cc569f2 PJ |
55 | 'class' => 'CRM_Mailing_Form_Task_Print', |
56 | 'result' => FALSE, | |
be2fb01f CW |
57 | ], |
58 | ]; | |
2cc569f2 | 59 | |
12009fb4 | 60 | parent::tasks(); |
2cc569f2 PJ |
61 | } |
62 | ||
63 | return self::$_tasks; | |
64 | } | |
65 | ||
2cc569f2 | 66 | /** |
100fef9d | 67 | * Show tasks selectively based on the permission level |
25606795 | 68 | * of the user. |
2cc569f2 PJ |
69 | * |
70 | * @param int $permission | |
12009fb4 | 71 | * @param array $params |
2cc569f2 | 72 | * |
a6c01b45 CW |
73 | * @return array |
74 | * set of tasks that are valid for the user | |
2cc569f2 | 75 | */ |
be2fb01f CW |
76 | public static function permissionedTaskTitles($permission, $params = []) { |
77 | $tasks = []; | |
12009fb4 MW |
78 | |
79 | $tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params); | |
80 | return $tasks; | |
2cc569f2 PJ |
81 | } |
82 | ||
83 | /** | |
fe482240 | 84 | * These tasks are the core set of tasks that the user can perform. |
25606795 | 85 | * on mailing recipients. |
2cc569f2 PJ |
86 | * |
87 | * @param int $value | |
88 | * | |
a6c01b45 CW |
89 | * @return array |
90 | * the set of tasks for a group of mailing recipients | |
2cc569f2 | 91 | */ |
00be9182 | 92 | public static function getTask($value) { |
2cc569f2 PJ |
93 | self::tasks(); |
94 | if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) { | |
95 | // make the print task by default | |
12009fb4 | 96 | $value = self::TASK_PRINT; |
2cc569f2 | 97 | } |
12009fb4 | 98 | |
be2fb01f | 99 | return [ |
2cc569f2 PJ |
100 | self::$_tasks[$value]['class'], |
101 | self::$_tasks[$value]['result'], | |
be2fb01f | 102 | ]; |
2cc569f2 | 103 | } |
96025800 | 104 | |
bf765334 | 105 | } |