CRM/Core/Component.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  * Component stores all the static and dynamic information of the various
  30  * CiviCRM components
  31  *
  32  * @package CRM
  33  * @copyright CiviCRM LLC (c) 2004-2014
  34  * $Id$
  35  *
  36  */
  37 class CRM_Core_Component {
  38
  39   /**
  40    * End part (filename) of the component information class'es name
  41    * that needs to be present in components main directory.
  42    */
  43   const COMPONENT_INFO_CLASS = 'Info';
  44
  45   private static $_info = NULL;
  46
  47   static $_contactSubTypes = NULL;
  48
  49   /**
  50    * @param bool $force
  51    *
  52    * @return array|null
  53    */
  54   private static function &_info($force = FALSE) {
  55     if (self::$_info == NULL || $force) {
  56       self::$_info = array();
  57       $c = array();
  58
  59       $config = CRM_Core_Config::singleton();
  60       $c = self::getComponents();
  61
  62       foreach ($c as $name => $comp) {
  63         if (in_array($name, $config->enableComponents)) {
  64           self::$_info[$name] = $comp;
  65         }
  66       }
  67     }
  68
  69     return self::$_info;
  70   }
  71
  72   /**
  73    * @param string $name
  74    * @param null $attribute
  75    *
  76    * @return mixed
  77    */
  78   public static function get($name, $attribute = NULL) {
  79     $comp = CRM_Utils_Array::value($name, self::_info());
  80     if ($attribute) {
  81       return CRM_Utils_Array::value($attribute, $comp->info);
  82     }
  83     return $comp;
  84   }
  85
  86   /**
  87    * @param bool $force
  88    *
  89    * @return array
  90    * @throws Exception
  91    */
  92   public static function &getComponents($force = FALSE) {
  93     static $_cache = NULL;
  94
  95     if (!$_cache || $force) {
  96       $_cache = array();
  97
  98       $cr = new CRM_Core_DAO_Component();
  99       $cr->find(FALSE);
 100       while ($cr->fetch()) {
 101         $infoClass = $cr->namespace . '_' . self::COMPONENT_INFO_CLASS;
 102         require_once str_replace('_', DIRECTORY_SEPARATOR, $infoClass) . '.php';
 103         $infoObject = new $infoClass($cr->name, $cr->namespace, $cr->id);
 104         if ($infoObject->info['name'] !== $cr->name) {
 105           CRM_Core_Error::fatal("There is a discrepancy between name in component registry and in info file ({$cr->name}).");
 106         }
 107         $_cache[$cr->name] = $infoObject;
 108         unset($infoObject);
 109       }
 110     }
 111
 112     return $_cache;
 113   }
 114
 115   /**
 116    * @param bool $force
 117    *
 118    * @return array|null
 119    */
 120   static public function &getEnabledComponents($force = FALSE) {
 121     return self::_info($force);
 122   }
 123
 124   static public function flushEnabledComponents() {
 125     self::getEnabledComponents(TRUE);
 126   }
 127
 128   /**
 129    * @param bool $translated
 130    *
 131    * @return array
 132    */
 133   public static function &getNames($translated = FALSE) {
 134     $allComponents = self::getComponents();
 135
 136     $names = array();
 137     foreach ($allComponents as $name => $comp) {
 138       if ($translated) {
 139         $names[$comp->componentID] = $comp->info['translatedName'];
 140       }
 141       else {
 142         $names[$comp->componentID] = $name;
 143       }
 144     }
 145     return $names;
 146   }
 147
 148   /**
 149    * @param $args
 150    * @param $type
 151    *
 152    * @return bool
 153    */
 154   public static function invoke(&$args, $type) {
 155     $info = self::_info();
 156     $config = CRM_Core_Config::singleton();
 157
 158     $firstArg = CRM_Utils_Array::value(1, $args, '');
 159     $secondArg = CRM_Utils_Array::value(2, $args, '');
 160     foreach ($info as $name => $comp) {
 161       if (in_array($name, $config->enableComponents) &&
 162         (($comp->info['url'] === $firstArg && $type == 'main') ||
 163           ($comp->info['url'] === $secondArg && $type == 'admin')
 164         )
 165       ) {
 166         if ($type == 'main') {
 167           // also set the smarty variables to the current component
 168           $template = CRM_Core_Smarty::singleton();
 169           $template->assign('activeComponent', $name);
 170           if (!empty($comp->info[$name]['formTpl'])) {
 171             $template->assign('formTpl', $comp->info[$name]['formTpl']);
 172           }
 173           if (!empty($comp->info[$name]['css'])) {
 174             $styleSheets = '<style type="text/css">@import url(' . "{$config->resourceBase}css/{$comp->info[$name]['css']});</style>";
 175             CRM_Utils_System::addHTMLHead($styleSheet);
 176           }
 177         }
 178         $inv = $comp->getInvokeObject();
 179         $inv->$type($args);
 180         return TRUE;
 181       }
 182     }
 183     return FALSE;
 184   }
 185
 186   /**
 187    * @return array
 188    */
 189   public static function xmlMenu() {
 190
 191     // lets build the menu for all components
 192     $info = self::getComponents(TRUE);
 193
 194     $files = array();
 195     foreach ($info as $name => $comp) {
 196       $files = array_merge($files,
 197         $comp->menuFiles()
 198       );
 199     }
 200
 201     return $files;
 202   }
 203
 204   /**
 205    * @return array
 206    */
 207   public static function &menu() {
 208     $info = self::_info();
 209     $items = array();
 210     foreach ($info as $name => $comp) {
 211       $mnu = $comp->getMenuObject();
 212
 213       $ret = $mnu->permissioned();
 214       $items = array_merge($items, $ret);
 215
 216       $ret = $mnu->main($task);
 217       $items = array_merge($items, $ret);
 218     }
 219     return $items;
 220   }
 221
 222   /**
 223    * @param $config
 224    * @param bool $oldMode
 225    *
 226    * @return null
 227    */
 228   public static function addConfig(&$config, $oldMode = FALSE) {
 229     $info = self::_info();
 230
 231     foreach ($info as $name => $comp) {
 232       $cfg = $comp->getConfigObject();
 233       $cfg->add($config, $oldMode);
 234     }
 235     return NULL;
 236   }
 237
 238   /**
 239    * @param string $componentName
 240    *
 241    * @return mixed
 242    */
 243   public static function getComponentID($componentName) {
 244     $info = self::_info();
 245     if (!empty($info[$componentName])) {
 246       return $info[$componentName]->componentID;
 247     }
 248     else {
 249       return;
 250     }
 251   }
 252
 253   /**
 254    * @param int $componentID
 255    *
 256    * @return int|null|string
 257    */
 258   public static function getComponentName($componentID) {
 259     $info = self::_info();
 260
 261     $componentName = NULL;
 262     foreach ($info as $compName => $component) {
 263       if ($component->componentID == $componentID) {
 264         $componentName = $compName;
 265         break;
 266       }
 267     }
 268
 269     return $componentName;
 270   }
 271
 272   /**
 273    * @return array
 274    */
 275   public static function &getQueryFields() {
 276     $info = self::_info();
 277     $fields = array();
 278     foreach ($info as $name => $comp) {
 279       if ($comp->usesSearch()) {
 280         $bqr = $comp->getBAOQueryObject();
 281         $flds = $bqr->getFields();
 282         $fields = array_merge($fields, $flds);
 283       }
 284     }
 285     return $fields;
 286   }
 287
 288   /**
 289    * @param $query
 290    * @param string $fnName
 291    */
 292   public static function alterQuery(&$query, $fnName) {
 293     $info = self::_info();
 294
 295     foreach ($info as $name => $comp) {
 296       if ($comp->usesSearch()) {
 297         $bqr = $comp->getBAOQueryObject();
 298         $bqr->$fnName($query);
 299       }
 300     }
 301   }
 302
 303   /**
 304    * @param string $fieldName
 305    * @param $mode
 306    * @param $side
 307    *
 308    * @return null
 309    */
 310   public static function from($fieldName, $mode, $side) {
 311     $info = self::_info();
 312
 313     $from = NULL;
 314     foreach ($info as $name => $comp) {
 315       if ($comp->usesSearch()) {
 316         $bqr = $comp->getBAOQueryObject();
 317         $from = $bqr->from($fieldName, $mode, $side);
 318         if ($from) {
 319           return $from;
 320         }
 321       }
 322     }
 323     return $from;
 324   }
 325
 326   /**
 327    * @param $mode
 328    * @param bool $includeCustomFields
 329    *
 330    * @return null
 331    */
 332   public static function &defaultReturnProperties(
 333     $mode,
 334     $includeCustomFields = TRUE
 335   ) {
 336     $info = self::_info();
 337
 338     $properties = NULL;
 339     foreach ($info as $name => $comp) {
 340       if ($comp->usesSearch()) {
 341         $bqr = $comp->getBAOQueryObject();
 342         $properties = $bqr->defaultReturnProperties($mode, $includeCustomFields);
 343         if ($properties) {
 344           return $properties;
 345         }
 346       }
 347     }
 348     return $properties;
 349   }
 350
 351   /**
 352    * @param CRM_Core_Form $form
 353    */
 354   public static function &buildSearchForm(&$form) {
 355     $info = self::_info();
 356
 357     foreach ($info as $name => $comp) {
 358       if ($comp->usesSearch()) {
 359         $bqr = $comp->getBAOQueryObject();
 360         $bqr->buildSearchForm($form);
 361       }
 362     }
 363   }
 364
 365   /**
 366    * @param $row
 367    * @param int $id
 368    */
 369   public static function searchAction(&$row, $id) {
 370     $info = self::_info();
 371
 372     foreach ($info as $name => $comp) {
 373       if ($comp->usesSearch()) {
 374         $bqr = $comp->getBAOQueryObject();
 375         $bqr->searchAction($row, $id);
 376       }
 377     }
 378   }
 379
 380   /**
 381    * @return array|null
 382    */
 383   public static function &contactSubTypes() {
 384     if (self::$_contactSubTypes == NULL) {
 385       self::$_contactSubTypes = array();
 386     }
 387     return self::$_contactSubTypes;
 388   }
 389
 390
 391   /**
 392    * @param $subType
 393    * @param $op
 394    *
 395    * @return null
 396    */
 397   public static function &contactSubTypeProperties($subType, $op) {
 398     $properties = self::contactSubTypes();
 399     if (array_key_exists($subType, $properties) &&
 400       array_key_exists($op, $properties[$subType])
 401     ) {
 402       return $properties[$subType][$op];
 403     }
 404     return CRM_Core_DAO::$_nullObject;
 405   }
 406
 407   /**
 408    * FIXME: This function does not appear to do anything. The is_array() check runs on a bunch of objects and (always?) returns false
 409    */
 410   public static function &taskList() {
 411     $info = self::_info();
 412
 413     $tasks = array();
 414     foreach ($info as $name => $value) {
 415       if (is_array($info[$name]) && isset($info[$name]['task'])) {
 416         $tasks += $info[$name]['task'];
 417       }
 418     }
 419     return $tasks;
 420   }
 421
 422   /**
 423    * Handle table dependencies of components.
 424    *
 425    * @param array $tables
 426    *   Array of tables.
 427    *
 428    */
 429   public static function tableNames(&$tables) {
 430     $info = self::_info();
 431
 432     foreach ($info as $name => $comp) {
 433       if ($comp->usesSearch()) {
 434         $bqr = $comp->getBAOQueryObject();
 435         $bqr->tableNames($tables);
 436       }
 437     }
 438   }
 439
 440   /**
 441    * Get components info from info file.
 442    */
 443   public static function getComponentsFromFile($crmFolderDir) {
 444     $components = array();
 445     //traverse CRM folder and check for Info file
 446     if (is_dir($crmFolderDir) && $dir = opendir($crmFolderDir)) {
 447       while ($subDir = readdir($dir)) {
 448         // skip the extensions diretory since it has an Info.php file also
 449         if ($subDir == 'Extension') {
 450           continue;
 451         }
 452
 453         $infoFile = $crmFolderDir . "/{$subDir}/" . self::COMPONENT_INFO_CLASS . '.php';
 454         if (file_exists($infoFile)) {
 455           $infoClass = 'CRM_' . $subDir . '_' . self::COMPONENT_INFO_CLASS;
 456           require_once str_replace('_', DIRECTORY_SEPARATOR, $infoClass) . '.php';
 457           $infoObject = new $infoClass(NULL, NULL, NULL);
 458           $components[$infoObject->info['name']] = $infoObject;
 459           unset($infoObject);
 460         }
 461       }
 462     }
 463
 464     return $components;
 465   }
 466
 467 }