3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Utils_Hook_DrupalBase
extends CRM_Utils_Hook
{
40 private $isBuilt = FALSE;
45 private $allModules = NULL;
50 private $civiModules = NULL;
55 private $drupalModules = NULL;
59 * @see CRM_Utils_Hook::invoke()
61 * @param integer $numParams Number of parameters to pass to the hook
62 * @param unknown $arg1 parameter to be passed to the hook
63 * @param unknown $arg2 parameter to be passed to the hook
64 * @param unknown $arg3 parameter to be passed to the hook
65 * @param unknown $arg4 parameter to be passed to the hook
66 * @param unknown $arg5 parameter to be passed to the hook
68 * @param string $fnSuffix function suffix, this is effectively the hook name
70 * @return Ambigous <boolean, multitype:>
72 function invoke($numParams,
73 &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6,
76 $this->buildModuleList();
78 return $this->runHooks($this->allModules
, $fnSuffix,
79 $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6
84 * Build the list of modules to be processed for hooks.
86 function buildModuleList() {
87 if ($this->isBuilt
=== FALSE) {
88 if ($this->drupalModules
=== NULL) {
89 if (function_exists('module_list')) {
90 // copied from user_module_invoke
91 $this->drupalModules
= module_list();
95 if ($this->civiModules
=== NULL) {
96 $this->civiModules
= array();
97 $this->requireCiviModules($this->civiModules
);
101 // we should add civicrm's module's just after main civicrm drupal module
102 // Note: Assume that drupalModules and civiModules may each be array() or NULL
103 if ($this->drupalModules
!== NULL) {
104 foreach ($this->drupalModules
as $moduleName) {
105 $this->allModules
[$moduleName] = $moduleName;
106 if ($moduleName == 'civicrm') {
107 if (!empty($this->civiModules
)) {
108 foreach ($this->civiModules
as $civiModuleName) {
109 $this->allModules
[$civiModuleName] = $civiModuleName;
116 $this->allModules
= (array) $this->civiModules
;
119 if ($this->drupalModules
!== NULL && $this->civiModules
!== NULL) {
120 // both CRM and CMS have bootstrapped, so this is the final list
121 $this->isBuilt
= TRUE;