CRM/Utils/Hook/DrupalBase.php

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