Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
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 | |
6b83d5bd | 34 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
35 | */ |
36 | class CRM_Core_Module { | |
37 | ||
38 | /** | |
39 | * @var string | |
40 | */ | |
41 | public $name; | |
42 | ||
43 | /** | |
e97c66ff | 44 | * Is the module enabled. |
45 | * | |
46 | * @var bool | |
6a488035 TO |
47 | */ |
48 | public $is_active; | |
49 | ||
a0ee3941 | 50 | /** |
e97c66ff | 51 | * Class constructor. |
52 | * | |
100fef9d | 53 | * @param string $name |
e97c66ff | 54 | * @param bool $is_active |
a0ee3941 | 55 | */ |
6a488035 TO |
56 | public function __construct($name, $is_active) { |
57 | $this->name = $name; | |
58 | $this->is_active = $is_active; | |
59 | } | |
60 | ||
61 | /** | |
d09edf64 | 62 | * Get a list of all known modules. |
3bdf1f3a | 63 | * |
64 | * @param bool $fresh | |
65 | * Force new results? | |
66 | * | |
67 | * @return array | |
6a488035 TO |
68 | */ |
69 | public static function getAll($fresh = FALSE) { | |
70 | static $result; | |
71 | if ($fresh || !is_array($result)) { | |
72 | $result = CRM_Extension_System::singleton()->getMapper()->getModules(); | |
518fa0ee SL |
73 | // pseudo-module for core |
74 | $result[] = new CRM_Core_Module('civicrm', TRUE); | |
6a488035 TO |
75 | |
76 | $config = CRM_Core_Config::singleton(); | |
66e42142 | 77 | $result = array_merge($result, $config->userSystem->getModules()); |
6a488035 TO |
78 | } |
79 | return $result; | |
80 | } | |
96025800 | 81 | |
5bbcc823 TO |
82 | /** |
83 | * Get the status for each module. | |
84 | * | |
85 | * @param array $modules | |
86 | * Array(CRM_Core_Module). | |
87 | * @return array | |
88 | * Array(string $moduleName => string $statusCode). | |
89 | * @see CRM_Extension_Manager::STATUS_INSTALLED | |
90 | * @see CRM_Extension_Manager::STATUS_DISABLED | |
91 | */ | |
92 | public static function collectStatuses($modules) { | |
be2fb01f | 93 | $statuses = []; |
5bbcc823 TO |
94 | foreach ($modules as $module) { |
95 | $statuses[$module->name] = $module->is_active ? CRM_Extension_Manager::STATUS_INSTALLED : CRM_Extension_Manager::STATUS_DISABLED; | |
96 | ||
97 | } | |
98 | return $statuses; | |
99 | } | |
100 | ||
6a488035 | 101 | } |