3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This interface defines methods that need to be implemented
30 * for a component to introduce itself to the system.
33 * @copyright CiviCRM LLC (c) 2004-2018
37 abstract class CRM_Core_Component_Info
{
40 * Name of the class (minus component namespace path)
41 * of the component invocation class'es name.
43 const COMPONENT_INVOKE_CLASS
= 'Invoke';
46 * Name of the class (minus component namespace path)
47 * of the component BAO Query class'es name.
49 const COMPONENT_BAO_QUERY_CLASS
= 'BAO_Query';
52 * Name of the class (minus component namespace path)
53 * of the component user dashboard plugin.
55 const COMPONENT_USERDASHBOARD_CLASS
= 'Page_UserDashboard';
58 * Name of the class (minus component namespace path)
59 * of the component tab offered to contact record view.
61 const COMPONENT_TAB_CLASS
= 'Page_Tab';
64 * Name of the class (minus component namespace path)
65 * of the component tab offered to contact record view.
67 const COMPONENT_ADVSEARCHPANE_CLASS
= 'Form_Search_AdvancedSearchPane';
70 * Name of the directory (assumed in component directory)
71 * where xml resources used by this component live.
73 const COMPONENT_XML_RESOURCES
= 'xml';
76 * Name of the directory (assumed in xml resources path)
77 * containing component menu definition XML file names.
79 const COMPONENT_MENU_XML
= 'Menu';
82 * Stores component information.
83 * @var array component settings as key/value pairs
88 * Stores component keyword.
89 * @var string name of component keyword
95 * Name of the component.
96 * @param string $namespace
97 * Namespace prefix for component's files.
98 * @param int $componentID
100 public function __construct($name, $namespace, $componentID) {
102 $this->namespace = $namespace;
103 $this->componentID
= $componentID;
104 $this->info
= $this->getInfo();
105 $this->info
['url'] = $this->getKeyword();
109 * EXPERIMENTAL: Get a list of AngularJS modules
112 * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
113 * @see CRM_Utils_Hook::angularModules
115 public function getAngularModules() {
120 * Provides base information about the component.
121 * Needs to be implemented in component's information
125 * collection of required component settings
127 abstract public function getInfo();
130 * Get a list of entities to register via API.
133 * list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities)
134 * @see CRM_Utils_Hook::managedEntities
136 public function getManagedEntities() {
141 * Provides permissions that are unwise for Anonymous Roles to have.
144 * list of permissions
145 * @see CRM_Component_Info::getPermissions
147 public function getAnonymousPermissionWarnings() {
152 * Provides permissions that are used by component.
153 * Needs to be implemented in component's information
156 * NOTE: if using conditionally permission return,
157 * implementation of $getAllUnconditionally is required.
159 * @param bool $getAllUnconditionally
162 * collection of permissions, null if none
164 abstract public function getPermissions($getAllUnconditionally = FALSE);
167 * Determine how many other records refer to a given record.
169 * @param CRM_Core_DAO $dao
170 * The item for which we want a reference count.
172 * each item in the array is an array with keys:
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
177 public function getReferenceCounts($dao) {
182 * Provides information about user dashboard element.
183 * offered by this component.
186 * collection of required dashboard settings,
187 * null if no element offered
189 abstract public function getUserDashboardElement();
192 * Provides information about user dashboard element.
193 * offered by this component.
196 * collection of required dashboard settings,
197 * null if no element offered
199 abstract public function registerTab();
202 * Provides information about advanced search pane
203 * offered by this component.
206 * collection of required pane settings,
207 * null if no element offered
209 abstract public function registerAdvancedSearchPane();
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
218 * collection of activity types
220 abstract public function getActivityTypes();
223 * Provides information whether given component is currently
224 * marked as enabled in configuration.
227 * true if component is enabled, false if not
229 public function isEnabled() {
230 $config = CRM_Core_Config
::singleton();
231 if (in_array($this->info
['name'], $config->enableComponents
)) {
238 * Provides component's menu definition object.
241 * component's menu definition object
243 public function getMenuObject() {
244 return $this->_instantiate(self
::COMPONENT_MENU_CLASS
);
248 * Provides component's invocation object.
251 * component's invocation object
253 public function getInvokeObject() {
254 return $this->_instantiate(self
::COMPONENT_INVOKE_CLASS
);
258 * Provides component's BAO Query object.
261 * component's BAO Query object
263 public function getBAOQueryObject() {
264 return $this->_instantiate(self
::COMPONENT_BAO_QUERY_CLASS
);
268 * Builds advanced search form's component specific pane.
270 * @param CRM_Core_Form $form
272 public function buildAdvancedSearchPaneForm(&$form) {
273 $bao = $this->getBAOQueryObject();
274 $bao->buildSearchForm($form);
278 * Provides component's user dashboard page object.
281 * component's User Dashboard applet object
283 public function getUserDashboardObject() {
284 return $this->_instantiate(self
::COMPONENT_USERDASHBOARD_CLASS
);
288 * Provides component's contact record tab object.
291 * component's contact record tab object
293 public function getTabObject() {
294 return $this->_instantiate(self
::COMPONENT_TAB_CLASS
);
298 * Provides component's advanced search pane's template path.
301 * component's advanced search pane's template path
303 public function getAdvancedSearchPaneTemplatePath() {
304 $fullpath = $this->namespace . '_' . self
::COMPONENT_ADVSEARCHPANE_CLASS
;
305 return str_replace('_', DIRECTORY_SEPARATOR
, $fullpath . '.tpl');
309 * Provides information whether given component uses system wide search.
312 * true if component needs search integration
314 public function usesSearch() {
315 return $this->info
['search'] ?
TRUE : FALSE;
319 * Provides the xml menu files.
322 * array of menu files
324 public function menuFiles() {
325 return CRM_Utils_File
::getFilesByExtension($this->_getMenuXMLPath(), 'xml');
329 * Simple "keyword" getter.
330 * FIXME: It should be protected so the keyword is not
331 * FIXME: accessed from beyond component infrastructure.
336 public function getKeyword() {
337 return $this->keyword
;
341 * Helper for figuring out menu XML file location.
344 * component's element as class instance
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));
353 * Helper for instantiating component's elements.
358 * component's element as class instance
360 private function _instantiate($cl) {
361 $className = $this->namespace . '_' . $cl;
362 require_once str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
363 return new $className();