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