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    * @return array|null collection of permissions, null if none
 157    * @access public
 158    *
 159    */
 160   abstract public function getPermissions($getAllUnconditionally = FALSE);
 161
 162   /**
 163    * Provides information about user dashboard element
 164    * offered by this component.
 165    *
 166    * @return array|null collection of required dashboard settings,
 167    *                    null if no element offered
 168    * @access public
 169    *
 170    */
 171   abstract public function getUserDashboardElement();
 172
 173   /**
 174    * Provides information about user dashboard element
 175    * offered by this component.
 176    *
 177    * @return array|null collection of required dashboard settings,
 178    *                    null if no element offered
 179    * @access public
 180    *
 181    */
 182   abstract public function registerTab();
 183
 184   /**
 185    * Provides information about advanced search pane
 186    * offered by this component.
 187    *
 188    * @return array|null collection of required pane settings,
 189    *                    null if no element offered
 190    * @access public
 191    *
 192    */
 193   abstract public function registerAdvancedSearchPane();
 194
 195   /**
 196    * Provides potential activity types that this
 197    * component might want to register in activity history.
 198    * Needs to be implemented in component's information
 199    * class.
 200    *
 201    * @return array|null collection of activity types
 202    * @access public
 203    *
 204    */
 205   abstract public function getActivityTypes();
 206
 207   /**
 208    * Provides information whether given component is currently
 209    * marked as enabled in configuration.
 210    *
 211    * @return boolean true if component is enabled, false if not
 212    * @access public
 213    *
 214    */
 215   public function isEnabled() {
 216     $config = CRM_Core_Config::singleton();
 217     if (in_array($this->info['name'], $config->enableComponents)) {
 218       return TRUE;
 219     }
 220     return FALSE;
 221   }
 222
 223   /**
 224    * Provides component's configuration object.
 225    *
 226    * @return mixed component's configuration object
 227    * @access public
 228    *
 229    */
 230   public function getConfigObject() {
 231     return $this->_instantiate(self::COMPONENT_CONFIG_CLASS);
 232   }
 233
 234   /**
 235    * Provides component's menu definition object.
 236    *
 237    * @return mixed component's menu definition object
 238    * @access public
 239    *
 240    */
 241   public function getMenuObject() {
 242     return $this->_instantiate(self::COMPONENT_MENU_CLASS);
 243   }
 244
 245   /**
 246    * Provides component's invocation object.
 247    *
 248    * @return mixed component's invocation object
 249    * @access public
 250    *
 251    */
 252   public function getInvokeObject() {
 253     return $this->_instantiate(self::COMPONENT_INVOKE_CLASS);
 254   }
 255
 256   /**
 257    * Provides component's BAO Query object.
 258    *
 259    * @return mixed component's BAO Query object
 260    * @access public
 261    *
 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.
 269    *
 270    * @access public
 271    *
 272    */
 273   public function buildAdvancedSearchPaneForm(&$form) {
 274     $bao = $this->getBAOQueryObject();
 275     $bao->buildSearchForm($form);
 276   }
 277
 278   /**
 279    * Provides component's user dashboard page object.
 280    *
 281    * @return mixed component's User Dashboard applet object
 282    * @access public
 283    *
 284    */
 285   public function getUserDashboardObject() {
 286     return $this->_instantiate(self::COMPONENT_USERDASHBOARD_CLASS);
 287   }
 288
 289   /**
 290    * Provides component's contact record tab object.
 291    *
 292    * @return mixed component's contact record tab object
 293    * @access public
 294    *
 295    */
 296   public function getTabObject() {
 297     return $this->_instantiate(self::COMPONENT_TAB_CLASS);
 298   }
 299
 300   /**
 301    * Provides component's advanced search pane's template path.
 302    *
 303    * @return string component's advanced search pane's template path
 304    * @access public
 305    *
 306    */
 307   public function getAdvancedSearchPaneTemplatePath() {
 308     $fullpath = $this->namespace . '_' . self::COMPONENT_ADVSEARCHPANE_CLASS;
 309     return str_replace('_', DIRECTORY_SEPARATOR, $fullpath . '.tpl');
 310   }
 311
 312   /**
 313    * Provides information whether given component uses system wide search.
 314    *
 315    * @return boolean true if component needs search integration
 316    * @access public
 317    *
 318    */
 319   public function usesSearch() {
 320     return $this->info['search'] ? TRUE : FALSE;
 321   }
 322
 323   /**
 324    * Provides the xml menu files
 325    *
 326    * @return array array of menu files
 327    * @access public
 328    *
 329    */
 330   public function menuFiles() {
 331     return CRM_Utils_File::getFilesByExtension($this->_getMenuXMLPath(), 'xml');
 332   }
 333
 334   /**
 335    * Simple "keyword" getter.
 336    * FIXME: It should be protected so the keyword is not
 337    * FIXME: accessed from beyond component infrastructure.
 338    *
 339    * @return string component keyword
 340    * @access public
 341    *
 342    */
 343   public function getKeyword() {
 344     return $this->keyword;
 345   }
 346
 347   /**
 348    * Helper for figuring out menu XML file location.
 349    *
 350    * @return mixed component's element as class instance
 351    * @access private
 352    *
 353    */
 354   private function _getMenuXMLPath() {
 355     global $civicrm_root;
 356     $fullpath = $this->namespace . '_' . self::COMPONENT_XML_RESOURCES . '_' . self::COMPONENT_MENU_XML;
 357     return CRM_Utils_File::addTrailingSlash($civicrm_root . DIRECTORY_SEPARATOR . str_replace('_', DIRECTORY_SEPARATOR, $fullpath));
 358   }
 359
 360   /**
 361    * Helper for instantiating component's elements.
 362    *
 363    * @return mixed component's element as class instance
 364    * @access private
 365    *
 366    */
 367   private function _instantiate($cl) {
 368     $className = $this->namespace . '_' . $cl;
 369     require_once (str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php');
 370     return new $className();
 371   }
 372 }
 373