Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
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 | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
df371444 | 35 | * class to represent the actions that can be performed on a group of voters. |
6a488035 | 36 | * |
df371444 | 37 | * Used by the search forms. |
6a488035 | 38 | */ |
5da76dbe | 39 | class CRM_Campaign_Task extends CRM_Core_Task { |
6a488035 | 40 | |
f157740d SL |
41 | /** |
42 | * Campaign tasks | |
43 | */ | |
5da76dbe | 44 | const |
5da76dbe MW |
45 | INTERVIEW = 601, |
46 | RESERVE = 602, | |
47 | RELEASE = 603; | |
6a488035 | 48 | |
f157740d SL |
49 | /** |
50 | * @var string | |
51 | */ | |
52 | public static $objectType = 'campaign'; | |
6a488035 TO |
53 | |
54 | /** | |
55 | * These tasks are the core set of tasks that the user can perform | |
56 | * on a voter / group of voters | |
57 | * | |
a6c01b45 CW |
58 | * @return array |
59 | * the set of tasks for a group of voters. | |
6a488035 | 60 | */ |
5da76dbe | 61 | public static function tasks() { |
6a488035 | 62 | if (!(self::$_tasks)) { |
be2fb01f CW |
63 | self::$_tasks = [ |
64 | self::INTERVIEW => [ | |
353ffa53 | 65 | 'title' => ts('Record Respondents Interview'), |
be2fb01f | 66 | 'class' => [ |
6a488035 TO |
67 | 'CRM_Campaign_Form_Task_Interview', |
68 | 'CRM_Campaign_Form_Task_Release', | |
be2fb01f | 69 | ], |
6a488035 | 70 | 'result' => FALSE, |
be2fb01f CW |
71 | ], |
72 | self::RESERVE => [ | |
23546577 | 73 | 'title' => ts('Reserve Respondents'), |
be2fb01f | 74 | 'class' => [ |
6a488035 TO |
75 | 'CRM_Campaign_Form_Task_Reserve', |
76 | 'CRM_Campaign_Form_Task_Interview', | |
77 | 'CRM_Campaign_Form_Task_Release', | |
be2fb01f | 78 | ], |
6a488035 | 79 | 'result' => FALSE, |
be2fb01f CW |
80 | ], |
81 | self::RELEASE => [ | |
23546577 | 82 | 'title' => ts('Release Respondents'), |
6a488035 TO |
83 | 'class' => 'CRM_Campaign_Form_Task_Release', |
84 | 'result' => FALSE, | |
be2fb01f CW |
85 | ], |
86 | self::TASK_PRINT => [ | |
23546577 | 87 | 'title' => ts('Print Respondents'), |
6a488035 TO |
88 | 'class' => 'CRM_Campaign_Form_Task_Print', |
89 | 'result' => FALSE, | |
be2fb01f CW |
90 | ], |
91 | ]; | |
6a488035 | 92 | |
5da76dbe | 93 | parent::tasks(); |
4d73a5a7 | 94 | } |
6a488035 TO |
95 | |
96 | return self::$_tasks; | |
97 | } | |
98 | ||
6a488035 | 99 | /** |
100fef9d | 100 | * Show tasks selectively based on the permission level |
6a488035 TO |
101 | * of the user |
102 | * | |
103 | * @param int $permission | |
5da76dbe | 104 | * @param array $params |
6a488035 | 105 | * |
a6c01b45 CW |
106 | * @return array |
107 | * set of tasks that are valid for the user | |
6a488035 | 108 | */ |
be2fb01f | 109 | public static function permissionedTaskTitles($permission, $params = []) { |
6a488035 TO |
110 | $tasks = self::taskTitles(); |
111 | ||
5da76dbe | 112 | $tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params); |
6a488035 TO |
113 | return $tasks; |
114 | } | |
115 | ||
116 | /** | |
117 | * These tasks are the core set of tasks that the user can perform | |
118 | * on voters. | |
119 | * | |
120 | * @param int $value | |
121 | * | |
a6c01b45 CW |
122 | * @return array |
123 | * the set of tasks for a group of voters. | |
6a488035 | 124 | */ |
00be9182 | 125 | public static function getTask($value) { |
6a488035 TO |
126 | self::tasks(); |
127 | if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) { | |
5da76dbe MW |
128 | // Set the interview task as default |
129 | $value = self::INTERVIEW; | |
6a488035 TO |
130 | } |
131 | ||
be2fb01f | 132 | return [ |
6a488035 TO |
133 | self::$_tasks[$value]['class'], |
134 | self::$_tasks[$value]['result'], | |
be2fb01f | 135 | ]; |
6a488035 | 136 | } |
96025800 | 137 | |
6a488035 | 138 | } |