Commit | Line | Data |
---|---|---|
2cc569f2 PJ |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
2cc569f2 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
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 | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
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 | */ | |
39 | class CRM_Mailing_Task { | |
40 | /** | |
25606795 | 41 | * The task array. |
2cc569f2 PJ |
42 | * |
43 | * @var array | |
2cc569f2 PJ |
44 | */ |
45 | static $_tasks = NULL; | |
46 | ||
47 | /** | |
25606795 | 48 | * The optional task array. |
2cc569f2 PJ |
49 | * |
50 | * @var array | |
2cc569f2 PJ |
51 | */ |
52 | static $_optionalTasks = NULL; | |
53 | ||
54 | /** | |
55 | * These tasks are the core set of tasks that the user can perform | |
25606795 | 56 | * on a contact / group of contacts. |
2cc569f2 | 57 | * |
a6c01b45 | 58 | * @return array |
25606795 | 59 | * the set of tasks for a group of contacts. |
2cc569f2 | 60 | */ |
00be9182 | 61 | public static function &tasks() { |
2cc569f2 PJ |
62 | if (!(self::$_tasks)) { |
63 | self::$_tasks = array( | |
23546577 CW |
64 | 1 => array( |
65 | 'title' => ts('Print Mailing Recipients'), | |
2cc569f2 PJ |
66 | 'class' => 'CRM_Mailing_Form_Task_Print', |
67 | 'result' => FALSE, | |
68 | ), | |
69 | ); | |
70 | ||
71 | CRM_Utils_Hook::searchTasks('mailing', self::$_tasks); | |
72 | asort(self::$_tasks); | |
73 | } | |
74 | ||
75 | return self::$_tasks; | |
76 | } | |
77 | ||
78 | /** | |
79 | * These tasks are the core set of task titles | |
25606795 | 80 | * on mailing recipients. |
2cc569f2 | 81 | * |
a6c01b45 | 82 | * @return array |
25606795 | 83 | * the set of task titles. |
2cc569f2 | 84 | */ |
00be9182 | 85 | public static function &taskTitles() { |
2cc569f2 PJ |
86 | return array(); |
87 | } | |
88 | ||
89 | /** | |
100fef9d | 90 | * Show tasks selectively based on the permission level |
25606795 | 91 | * of the user. |
2cc569f2 PJ |
92 | * |
93 | * @param int $permission | |
94 | * | |
a6c01b45 CW |
95 | * @return array |
96 | * set of tasks that are valid for the user | |
2cc569f2 | 97 | */ |
00be9182 | 98 | public static function &permissionedTaskTitles($permission) { |
2cc569f2 PJ |
99 | $task = array(); |
100 | return $task; | |
101 | } | |
102 | ||
103 | /** | |
fe482240 | 104 | * These tasks are the core set of tasks that the user can perform. |
25606795 | 105 | * on mailing recipients. |
2cc569f2 PJ |
106 | * |
107 | * @param int $value | |
108 | * | |
a6c01b45 CW |
109 | * @return array |
110 | * the set of tasks for a group of mailing recipients | |
2cc569f2 | 111 | */ |
00be9182 | 112 | public static function getTask($value) { |
2cc569f2 PJ |
113 | self::tasks(); |
114 | if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) { | |
115 | // make the print task by default | |
116 | $value = 1; | |
117 | } | |
118 | return array( | |
119 | self::$_tasks[$value]['class'], | |
120 | self::$_tasks[$value]['result'], | |
121 | ); | |
122 | } | |
96025800 | 123 | |
bf765334 | 124 | } |