CRM/Core/Module.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * A module is any software package that participates in the hook
  30  * system, such as CiviCRM Module-Extension, a Drupal Module, or
  31  * a Joomla Plugin.
  32  *
  33  * @package CRM
  34  * @copyright CiviCRM LLC (c) 2004-2019
  35  * $Id$
  36  *
  37  */
  38 class CRM_Core_Module {
  39
  40   /**
  41    * @var string
  42    */
  43   public $name;
  44
  45   /**
  46    * @var bool, TRUE if fully enabled; FALSE if module exists but is disabled
  47    */
  48   public $is_active;
  49
  50   /**
  51    * @param string $name
  52    * @param $is_active
  53    */
  54   public function __construct($name, $is_active) {
  55     $this->name = $name;
  56     $this->is_active = $is_active;
  57   }
  58
  59   /**
  60    * Get a list of all known modules.
  61    *
  62    * @param bool $fresh
  63    *   Force new results?
  64    *
  65    * @return array
  66    */
  67   public static function getAll($fresh = FALSE) {
  68     static $result;
  69     if ($fresh || !is_array($result)) {
  70       $result = CRM_Extension_System::singleton()->getMapper()->getModules();
  71       // pseudo-module for core
  72       $result[] = new CRM_Core_Module('civicrm', TRUE);
  73
  74       $config = CRM_Core_Config::singleton();
  75       $result = array_merge($result, $config->userSystem->getModules());
  76     }
  77     return $result;
  78   }
  79
  80   /**
  81    * Get the status for each module.
  82    *
  83    * @param array $modules
  84    *   Array(CRM_Core_Module).
  85    * @return array
  86    *   Array(string $moduleName => string $statusCode).
  87    * @see CRM_Extension_Manager::STATUS_INSTALLED
  88    * @see CRM_Extension_Manager::STATUS_DISABLED
  89    */
  90   public static function collectStatuses($modules) {
  91     $statuses = [];
  92     foreach ($modules as $module) {
  93       $statuses[$module->name] = $module->is_active ? CRM_Extension_Manager::STATUS_INSTALLED : CRM_Extension_Manager::STATUS_DISABLED;
  94
  95     }
  96     return $statuses;
  97   }
  98
  99 }