Commit | Line | Data |
---|---|---|
f0a7a0c9 EM |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
f0a7a0c9 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
f0a7a0c9 EM |
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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
f0a7a0c9 EM |
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 | /** | |
77b97be7 | 58 | * @see CRM_Utils_Hook::invoke() |
f0a7a0c9 | 59 | * |
77b97be7 EM |
60 | * @param integer $numParams Number of parameters to pass to the hook |
61 | * @param unknown $arg1 parameter to be passed to the hook | |
62 | * @param unknown $arg2 parameter to be passed to the hook | |
63 | * @param unknown $arg3 parameter to be passed to the hook | |
64 | * @param unknown $arg4 parameter to be passed to the hook | |
65 | * @param unknown $arg5 parameter to be passed to the hook | |
66 | * @param mixed $arg6 | |
67 | * @param string $fnSuffix function suffix, this is effectively the hook name | |
68 | * | |
4a2db77c | 69 | * @return array|bool |
f0a7a0c9 EM |
70 | */ |
71 | function invoke($numParams, | |
72 | &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6, | |
73 | $fnSuffix) { | |
74 | ||
75 | $this->buildModuleList(); | |
76 | ||
77 | return $this->runHooks($this->allModules, $fnSuffix, | |
78 | $numParams, $arg1, $arg2, $arg3, $arg4, $arg5, $arg6 | |
79 | ); | |
80 | } | |
81 | ||
82 | /** | |
83 | * Build the list of modules to be processed for hooks. | |
84 | */ | |
00be9182 | 85 | public function buildModuleList() { |
f0a7a0c9 EM |
86 | if ($this->isBuilt === FALSE) { |
87 | if ($this->drupalModules === NULL) { | |
88 | if (function_exists('module_list')) { | |
89 | // copied from user_module_invoke | |
90 | $this->drupalModules = module_list(); | |
91 | } | |
92 | } | |
93 | ||
94 | if ($this->civiModules === NULL) { | |
95 | $this->civiModules = array(); | |
96 | $this->requireCiviModules($this->civiModules); | |
97 | } | |
98 | ||
1a058091 KM |
99 | // CRM-12370 |
100 | // we should add civicrm's module's just after main civicrm drupal module | |
101 | // Note: Assume that drupalModules and civiModules may each be array() or NULL | |
102 | if ($this->drupalModules !== NULL) { | |
103 | foreach ($this->drupalModules as $moduleName) { | |
104 | $this->allModules[$moduleName] = $moduleName; | |
105 | if ($moduleName == 'civicrm') { | |
106 | if (!empty($this->civiModules)) { | |
107 | foreach ($this->civiModules as $civiModuleName) { | |
108 | $this->allModules[$civiModuleName] = $civiModuleName; | |
109 | } | |
110 | } | |
111 | } | |
112 | } | |
113 | } | |
114 | else { | |
115 | $this->allModules = (array) $this->civiModules; | |
116 | } | |
117 | ||
f0a7a0c9 EM |
118 | if ($this->drupalModules !== NULL && $this->civiModules !== NULL) { |
119 | // both CRM and CMS have bootstrapped, so this is the final list | |
120 | $this->isBuilt = TRUE; | |
121 | } | |
122 | } | |
123 | } | |
77b97be7 | 124 | } |