Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
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 | * This interface defines methods that need to be implemented | |
30 | * for a component to introduce itself to the system. | |
31 | * | |
32 | * @package CRM | |
0f03f337 | 33 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
34 | * $Id$ |
35 | * | |
36 | */ | |
6a488035 TO |
37 | abstract class CRM_Core_Component_Info { |
38 | ||
c490a46a CW |
39 | /** |
40 | * Name of the class (minus component namespace path) | |
41 | * of the component invocation class'es name. | |
42 | */ | |
7da04cde | 43 | const COMPONENT_INVOKE_CLASS = 'Invoke'; |
6a488035 | 44 | |
c490a46a CW |
45 | /** |
46 | * Name of the class (minus component namespace path) | |
47 | * of the component BAO Query class'es name. | |
48 | */ | |
7da04cde | 49 | const COMPONENT_BAO_QUERY_CLASS = 'BAO_Query'; |
6a488035 | 50 | |
c490a46a CW |
51 | /** |
52 | * Name of the class (minus component namespace path) | |
53 | * of the component user dashboard plugin. | |
54 | */ | |
7da04cde | 55 | const COMPONENT_USERDASHBOARD_CLASS = 'Page_UserDashboard'; |
6a488035 | 56 | |
c490a46a CW |
57 | /** |
58 | * Name of the class (minus component namespace path) | |
59 | * of the component tab offered to contact record view. | |
60 | */ | |
7da04cde | 61 | const COMPONENT_TAB_CLASS = 'Page_Tab'; |
6a488035 | 62 | |
c490a46a CW |
63 | /** |
64 | * Name of the class (minus component namespace path) | |
65 | * of the component tab offered to contact record view. | |
66 | */ | |
7da04cde | 67 | const COMPONENT_ADVSEARCHPANE_CLASS = 'Form_Search_AdvancedSearchPane'; |
6a488035 | 68 | |
c490a46a CW |
69 | /** |
70 | * Name of the directory (assumed in component directory) | |
71 | * where xml resources used by this component live. | |
72 | */ | |
7da04cde | 73 | const COMPONENT_XML_RESOURCES = 'xml'; |
6a488035 | 74 | |
c490a46a CW |
75 | /** |
76 | * Name of the directory (assumed in xml resources path) | |
77 | * containing component menu definition XML file names. | |
78 | */ | |
7da04cde | 79 | const COMPONENT_MENU_XML = 'Menu'; |
6a488035 | 80 | |
c490a46a | 81 | /** |
6a488035 TO |
82 | * Stores component information. |
83 | * @var array component settings as key/value pairs | |
84 | */ | |
85 | public $info; | |
86 | ||
d424ffde | 87 | /** |
fe482240 | 88 | * Stores component keyword. |
6a488035 TO |
89 | * @var string name of component keyword |
90 | */ | |
91 | protected $keyword; | |
92 | ||
c490a46a | 93 | /** |
6a0b768e TO |
94 | * @param string $name |
95 | * Name of the component. | |
96 | * @param string $namespace | |
97 | * Namespace prefix for component's files. | |
c490a46a | 98 | * @param int $componentID |
a0ee3941 | 99 | */ |
6a488035 | 100 | public function __construct($name, $namespace, $componentID) { |
353ffa53 TO |
101 | $this->name = $name; |
102 | $this->namespace = $namespace; | |
6a488035 | 103 | $this->componentID = $componentID; |
353ffa53 | 104 | $this->info = $this->getInfo(); |
6a488035 TO |
105 | $this->info['url'] = $this->getKeyword(); |
106 | } | |
107 | ||
e7ff7042 TO |
108 | /** |
109 | * EXPERIMENTAL: Get a list of AngularJS modules | |
110 | * | |
a6c01b45 CW |
111 | * @return array |
112 | * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules) | |
e7ff7042 TO |
113 | * @see CRM_Utils_Hook::angularModules |
114 | */ | |
115 | public function getAngularModules() { | |
116 | return array(); | |
117 | } | |
118 | ||
6a488035 TO |
119 | /** |
120 | * Provides base information about the component. | |
121 | * Needs to be implemented in component's information | |
122 | * class. | |
123 | * | |
a6c01b45 CW |
124 | * @return array |
125 | * collection of required component settings | |
6a488035 TO |
126 | */ |
127 | abstract public function getInfo(); | |
128 | ||
3bd831aa | 129 | /** |
fe482240 | 130 | * Get a list of entities to register via API. |
3bd831aa | 131 | * |
a6c01b45 CW |
132 | * @return array |
133 | * list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities) | |
3bd831aa TO |
134 | * @see CRM_Utils_Hook::managedEntities |
135 | */ | |
136 | public function getManagedEntities() { | |
137 | return array(); | |
138 | } | |
139 | ||
81bb85ea | 140 | /** |
fe482240 | 141 | * Provides permissions that are unwise for Anonymous Roles to have. |
81bb85ea | 142 | * |
a6c01b45 CW |
143 | * @return array |
144 | * list of permissions | |
81bb85ea AC |
145 | * @see CRM_Component_Info::getPermissions |
146 | */ | |
147 | public function getAnonymousPermissionWarnings() { | |
148 | return array(); | |
149 | } | |
150 | ||
6a488035 TO |
151 | /** |
152 | * Provides permissions that are used by component. | |
153 | * Needs to be implemented in component's information | |
154 | * class. | |
155 | * | |
33777e4a PJ |
156 | * NOTE: if using conditionally permission return, |
157 | * implementation of $getAllUnconditionally is required. | |
dd244018 EM |
158 | * |
159 | * @param bool $getAllUnconditionally | |
160 | * | |
72b3a70c CW |
161 | * @return array|null |
162 | * collection of permissions, null if none | |
6a488035 | 163 | */ |
33777e4a | 164 | abstract public function getPermissions($getAllUnconditionally = FALSE); |
6a488035 | 165 | |
91dee34b | 166 | /** |
fe482240 | 167 | * Determine how many other records refer to a given record. |
91dee34b | 168 | * |
6a0b768e TO |
169 | * @param CRM_Core_DAO $dao |
170 | * The item for which we want a reference count. | |
a6c01b45 CW |
171 | * @return array |
172 | * each item in the array is an array with keys: | |
91dee34b TO |
173 | * - name: string, eg "sql:civicrm_email:contact_id" |
174 | * - type: string, eg "sql" | |
175 | * - count: int, eg "5" if there are 5 email addresses that refer to $dao | |
176 | */ | |
177 | public function getReferenceCounts($dao) { | |
178 | return array(); | |
179 | } | |
180 | ||
6a488035 | 181 | /** |
0880a9d0 | 182 | * Provides information about user dashboard element. |
6a488035 TO |
183 | * offered by this component. |
184 | * | |
72b3a70c CW |
185 | * @return array|null |
186 | * collection of required dashboard settings, | |
6a488035 | 187 | * null if no element offered |
6a488035 TO |
188 | */ |
189 | abstract public function getUserDashboardElement(); | |
190 | ||
191 | /** | |
0880a9d0 | 192 | * Provides information about user dashboard element. |
6a488035 TO |
193 | * offered by this component. |
194 | * | |
72b3a70c CW |
195 | * @return array|null |
196 | * collection of required dashboard settings, | |
6a488035 | 197 | * null if no element offered |
6a488035 TO |
198 | */ |
199 | abstract public function registerTab(); | |
200 | ||
201 | /** | |
202 | * Provides information about advanced search pane | |
203 | * offered by this component. | |
204 | * | |
72b3a70c CW |
205 | * @return array|null |
206 | * collection of required pane settings, | |
6a488035 | 207 | * null if no element offered |
6a488035 TO |
208 | */ |
209 | abstract public function registerAdvancedSearchPane(); | |
210 | ||
211 | /** | |
212 | * Provides potential activity types that this | |
213 | * component might want to register in activity history. | |
214 | * Needs to be implemented in component's information | |
215 | * class. | |
216 | * | |
72b3a70c CW |
217 | * @return array|null |
218 | * collection of activity types | |
6a488035 TO |
219 | */ |
220 | abstract public function getActivityTypes(); | |
221 | ||
222 | /** | |
223 | * Provides information whether given component is currently | |
224 | * marked as enabled in configuration. | |
225 | * | |
389bcebf | 226 | * @return bool |
a6c01b45 | 227 | * true if component is enabled, false if not |
6a488035 TO |
228 | */ |
229 | public function isEnabled() { | |
230 | $config = CRM_Core_Config::singleton(); | |
231 | if (in_array($this->info['name'], $config->enableComponents)) { | |
232 | return TRUE; | |
233 | } | |
234 | return FALSE; | |
235 | } | |
236 | ||
6a488035 TO |
237 | /** |
238 | * Provides component's menu definition object. | |
239 | * | |
72b3a70c CW |
240 | * @return mixed |
241 | * component's menu definition object | |
6a488035 TO |
242 | */ |
243 | public function getMenuObject() { | |
244 | return $this->_instantiate(self::COMPONENT_MENU_CLASS); | |
245 | } | |
246 | ||
247 | /** | |
248 | * Provides component's invocation object. | |
249 | * | |
72b3a70c CW |
250 | * @return mixed |
251 | * component's invocation object | |
6a488035 TO |
252 | */ |
253 | public function getInvokeObject() { | |
254 | return $this->_instantiate(self::COMPONENT_INVOKE_CLASS); | |
255 | } | |
256 | ||
257 | /** | |
258 | * Provides component's BAO Query object. | |
259 | * | |
72b3a70c CW |
260 | * @return mixed |
261 | * component's BAO Query object | |
6a488035 TO |
262 | */ |
263 | public function getBAOQueryObject() { | |
264 | return $this->_instantiate(self::COMPONENT_BAO_QUERY_CLASS); | |
265 | } | |
266 | ||
267 | /** | |
268 | * Builds advanced search form's component specific pane. | |
ea3ddccf | 269 | * |
270 | * @param CRM_Core_Form $form | |
6a488035 TO |
271 | */ |
272 | public function buildAdvancedSearchPaneForm(&$form) { | |
273 | $bao = $this->getBAOQueryObject(); | |
274 | $bao->buildSearchForm($form); | |
275 | } | |
276 | ||
277 | /** | |
278 | * Provides component's user dashboard page object. | |
279 | * | |
72b3a70c CW |
280 | * @return mixed |
281 | * component's User Dashboard applet object | |
6a488035 TO |
282 | */ |
283 | public function getUserDashboardObject() { | |
284 | return $this->_instantiate(self::COMPONENT_USERDASHBOARD_CLASS); | |
285 | } | |
286 | ||
287 | /** | |
288 | * Provides component's contact record tab object. | |
289 | * | |
72b3a70c CW |
290 | * @return mixed |
291 | * component's contact record tab object | |
6a488035 TO |
292 | */ |
293 | public function getTabObject() { | |
294 | return $this->_instantiate(self::COMPONENT_TAB_CLASS); | |
295 | } | |
296 | ||
297 | /** | |
298 | * Provides component's advanced search pane's template path. | |
299 | * | |
a6c01b45 CW |
300 | * @return string |
301 | * component's advanced search pane's template path | |
6a488035 TO |
302 | */ |
303 | public function getAdvancedSearchPaneTemplatePath() { | |
304 | $fullpath = $this->namespace . '_' . self::COMPONENT_ADVSEARCHPANE_CLASS; | |
305 | return str_replace('_', DIRECTORY_SEPARATOR, $fullpath . '.tpl'); | |
306 | } | |
307 | ||
308 | /** | |
309 | * Provides information whether given component uses system wide search. | |
310 | * | |
389bcebf | 311 | * @return bool |
a6c01b45 | 312 | * true if component needs search integration |
6a488035 TO |
313 | */ |
314 | public function usesSearch() { | |
315 | return $this->info['search'] ? TRUE : FALSE; | |
316 | } | |
317 | ||
318 | /** | |
fe482240 | 319 | * Provides the xml menu files. |
6a488035 | 320 | * |
a6c01b45 CW |
321 | * @return array |
322 | * array of menu files | |
6a488035 TO |
323 | */ |
324 | public function menuFiles() { | |
325 | return CRM_Utils_File::getFilesByExtension($this->_getMenuXMLPath(), 'xml'); | |
326 | } | |
327 | ||
328 | /** | |
329 | * Simple "keyword" getter. | |
330 | * FIXME: It should be protected so the keyword is not | |
331 | * FIXME: accessed from beyond component infrastructure. | |
332 | * | |
a6c01b45 CW |
333 | * @return string |
334 | * component keyword | |
6a488035 TO |
335 | */ |
336 | public function getKeyword() { | |
337 | return $this->keyword; | |
338 | } | |
339 | ||
340 | /** | |
341 | * Helper for figuring out menu XML file location. | |
342 | * | |
72b3a70c CW |
343 | * @return mixed |
344 | * component's element as class instance | |
6a488035 TO |
345 | */ |
346 | private function _getMenuXMLPath() { | |
347 | global $civicrm_root; | |
348 | $fullpath = $this->namespace . '_' . self::COMPONENT_XML_RESOURCES . '_' . self::COMPONENT_MENU_XML; | |
349 | return CRM_Utils_File::addTrailingSlash($civicrm_root . DIRECTORY_SEPARATOR . str_replace('_', DIRECTORY_SEPARATOR, $fullpath)); | |
350 | } | |
351 | ||
352 | /** | |
353 | * Helper for instantiating component's elements. | |
354 | * | |
77b97be7 EM |
355 | * @param $cl |
356 | * | |
72b3a70c CW |
357 | * @return mixed |
358 | * component's element as class instance | |
6a488035 TO |
359 | */ |
360 | private function _instantiate($cl) { | |
361 | $className = $this->namespace . '_' . $cl; | |
2aa397bc | 362 | require_once str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php'; |
6a488035 TO |
363 | return new $className(); |
364 | } | |
96025800 | 365 | |
6a488035 | 366 | } |