Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * This class introduces component to the system and provides all the | |
30 | * information about it. It needs to extend CRM_Core_Component_Info | |
31 | * abstract class. | |
32 | * | |
33 | * @package CRM | |
06b69b18 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * $Id$ |
36 | * | |
37 | */ | |
38 | class CRM_Pledge_Info extends CRM_Core_Component_Info { | |
39 | ||
40 | // docs inherited from interface | |
41 | protected $keyword = 'pledge'; | |
42 | ||
ffd93213 EM |
43 | /** |
44 | * Provides base information about the component. | |
45 | * Needs to be implemented in component's information | |
46 | * class. | |
47 | * | |
48 | * @return array collection of required component settings | |
49 | * @access public | |
50 | */ | |
6a488035 TO |
51 | public function getInfo() { |
52 | return array( | |
53 | 'name' => 'CiviPledge', | |
54 | 'translatedName' => ts('CiviPledge'), | |
55 | 'title' => ts('CiviCRM Pledge Engine'), | |
56 | 'search' => 1, | |
57 | 'showActivitiesInCore' => 1, | |
58 | ); | |
59 | } | |
60 | ||
61 | ||
62 | // docs inherited from interface | |
ffd93213 EM |
63 | /** |
64 | * Provides permissions that are used by component. | |
65 | * Needs to be implemented in component's information | |
66 | * class. | |
67 | * | |
68 | * NOTE: if using conditionally permission return, | |
69 | * implementation of $getAllUnconditionally is required. | |
70 | * | |
71 | * @param bool $getAllUnconditionally | |
72 | * | |
73 | * @return array|null collection of permissions, null if none | |
74 | * @access public | |
75 | */ | |
76 | /** | |
77 | * @param bool $getAllUnconditionally | |
78 | * | |
79 | * @return array|null | |
80 | */ | |
33777e4a | 81 | public function getPermissions($getAllUnconditionally = FALSE) { |
6a488035 TO |
82 | return array( |
83 | 'access CiviPledge', | |
84 | 'edit pledges', | |
85 | 'delete in CiviPledge', | |
86 | ); | |
87 | } | |
88 | ||
89 | // docs inherited from interface | |
ffd93213 EM |
90 | /** |
91 | * Provides information about user dashboard element | |
92 | * offered by this component. | |
93 | * | |
94 | * @return array|null collection of required dashboard settings, | |
95 | * null if no element offered | |
96 | * @access public | |
97 | * | |
98 | */ | |
99 | /** | |
100 | * @return array|null | |
101 | */ | |
6a488035 TO |
102 | public function getUserDashboardElement() { |
103 | return array('name' => ts('Pledges'), | |
104 | 'title' => ts('Your Pledge(s)'), | |
105 | // we need to check this permission since you can click on contribution page link for making payment | |
106 | 'perm' => array('make online contributions'), | |
107 | 'weight' => 15, | |
108 | ); | |
109 | } | |
110 | ||
111 | // docs inherited from interface | |
ffd93213 EM |
112 | /** |
113 | * Provides information about user dashboard element | |
114 | * offered by this component. | |
115 | * | |
116 | * @return array|null collection of required dashboard settings, | |
117 | * null if no element offered | |
118 | * @access public | |
119 | * | |
120 | */ | |
121 | /** | |
122 | * @return array|null | |
123 | */ | |
6a488035 TO |
124 | public function registerTab() { |
125 | return array('title' => ts('Pledges'), | |
126 | 'url' => 'pledge', | |
127 | 'weight' => 25, | |
128 | ); | |
129 | } | |
130 | ||
131 | // docs inherited from interface | |
ffd93213 EM |
132 | /** |
133 | * Provides information about advanced search pane | |
134 | * offered by this component. | |
135 | * | |
136 | * @return array|null collection of required pane settings, | |
137 | * null if no element offered | |
138 | * @access public | |
139 | * | |
140 | */ | |
141 | /** | |
142 | * @return array|null | |
143 | */ | |
6a488035 TO |
144 | public function registerAdvancedSearchPane() { |
145 | return array('title' => ts('Pledges'), | |
146 | 'weight' => 25, | |
147 | ); | |
148 | } | |
149 | ||
150 | // docs inherited from interface | |
ffd93213 EM |
151 | /** |
152 | * Provides potential activity types that this | |
153 | * component might want to register in activity history. | |
154 | * Needs to be implemented in component's information | |
155 | * class. | |
156 | * | |
157 | * @return array|null collection of activity types | |
158 | * @access public | |
159 | * | |
160 | */ | |
161 | /** | |
162 | * @return array|null | |
163 | */ | |
6a488035 TO |
164 | public function getActivityTypes() { |
165 | return NULL; | |
166 | } | |
167 | ||
168 | // add shortcut to Create New | |
ffd93213 EM |
169 | /** |
170 | * @param $shortCuts | |
171 | */ | |
6a488035 TO |
172 | public function creatNewShortcut(&$shortCuts) { |
173 | if (CRM_Core_Permission::check('access CiviPledge') && | |
174 | CRM_Core_Permission::check('edit pledges') | |
175 | ) { | |
176 | $shortCuts = array_merge($shortCuts, array( | |
177 | array('path' => 'civicrm/pledge/add', | |
178 | 'query' => 'reset=1&action=add&context=standalone', | |
179 | 'ref' => 'new-pledge', | |
180 | 'title' => ts('Pledge'), | |
181 | ))); | |
182 | } | |
183 | } | |
184 | } | |
185 |