crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Utils/Hook/DrupalBase.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id$
  33  *
  34  */
  35 class CRM_Utils_Hook_DrupalBase extends CRM_Utils_Hook {
  36
  37   /**
  38    * @var bool
  39    */
  40   private $isBuilt = FALSE;
  41
  42   /**
  43    * @var array(string)
  44    */
  45   private $allModules = NULL;
  46
  47   /**
  48    * @var array(string)
  49    */
  50   private $civiModules = NULL;
  51
  52   /**
  53    * @var array(string)
  54    */
  55   private $drupalModules = NULL;
  56
  57   /**
  58    * @see CRM_Utils_Hook::invoke()
  59    *
  60    * @param int $numParams
  61    *   Number of parameters to pass to the hook.
  62    * @param unknown $arg1
  63    *   Parameter to be passed to the hook.
  64    * @param unknown $arg2
  65    *   Parameter to be passed to the hook.
  66    * @param unknown $arg3
  67    *   Parameter to be passed to the hook.
  68    * @param unknown $arg4
  69    *   Parameter to be passed to the hook.
  70    * @param unknown $arg5
  71    *   Parameter to be passed to the hook.
  72    * @param mixed $arg6
  73    * @param string $fnSuffix
  74    *   Function suffix, this is effectively the hook name.
  75    *
  76    * @return array|bool
  77    */
  78   public function invoke(
  79     $numParams,
  80     &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
  81     $fnSuffix) {
  82
  83     $this->buildModuleList();
  84
  85     return $this->runHooks($this->allModules, $fnSuffix,
  86       $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
  87     );
  88   }
  89
  90   /**
  91    * Build the list of modules to be processed for hooks.
  92    */
  93   public function buildModuleList() {
  94     if ($this->isBuilt === FALSE) {
  95       if ($this->drupalModules === NULL) {
  96         if (function_exists('module_list')) {
  97           // copied from user_module_invoke
  98           $this->drupalModules = module_list();
  99         }
 100       }
 101
 102       if ($this->civiModules === NULL) {
 103         $this->civiModules = array();
 104         $this->requireCiviModules($this->civiModules);
 105       }
 106
 107       // CRM-12370
 108       // we should add civicrm's module's just after main civicrm drupal module
 109       // Note: Assume that drupalModules and civiModules may each be array() or NULL
 110       if ($this->drupalModules !== NULL) {
 111         foreach ($this->drupalModules as $moduleName) {
 112           $this->allModules[$moduleName] = $moduleName;
 113           if ($moduleName == 'civicrm') {
 114             if (!empty($this->civiModules)) {
 115               foreach ($this->civiModules as $civiModuleName) {
 116                 $this->allModules[$civiModuleName] = $civiModuleName;
 117               }
 118             }
 119           }
 120         }
 121       }
 122       else {
 123         $this->allModules = (array) $this->civiModules;
 124       }
 125
 126       if ($this->drupalModules !== NULL && $this->civiModules !== NULL) {
 127         // both CRM and CMS have bootstrapped, so this is the final list
 128         $this->isBuilt = TRUE;
 129       }
 130     }
 131   }
 132
 133 }