CRM/Core/Component/Info.php

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