Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
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 | |
0f03f337 | 34 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 TO |
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 | ||
a0ee3941 | 50 | /** |
100fef9d | 51 | * @param string $name |
a0ee3941 EM |
52 | * @param $is_active |
53 | */ | |
6a488035 TO |
54 | public function __construct($name, $is_active) { |
55 | $this->name = $name; | |
56 | $this->is_active = $is_active; | |
57 | } | |
58 | ||
59 | /** | |
d09edf64 | 60 | * Get a list of all known modules. |
3bdf1f3a | 61 | * |
62 | * @param bool $fresh | |
63 | * Force new results? | |
64 | * | |
65 | * @return array | |
6a488035 TO |
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(); | |
2583af5b | 71 | $result[] = new CRM_Core_Module('civicrm', TRUE); // pseudo-module for core |
6a488035 TO |
72 | |
73 | $config = CRM_Core_Config::singleton(); | |
66e42142 | 74 | $result = array_merge($result, $config->userSystem->getModules()); |
6a488035 TO |
75 | } |
76 | return $result; | |
77 | } | |
96025800 | 78 | |
5bbcc823 TO |
79 | /** |
80 | * Get the status for each module. | |
81 | * | |
82 | * @param array $modules | |
83 | * Array(CRM_Core_Module). | |
84 | * @return array | |
85 | * Array(string $moduleName => string $statusCode). | |
86 | * @see CRM_Extension_Manager::STATUS_INSTALLED | |
87 | * @see CRM_Extension_Manager::STATUS_DISABLED | |
88 | */ | |
89 | public static function collectStatuses($modules) { | |
90 | $statuses = array(); | |
91 | foreach ($modules as $module) { | |
92 | $statuses[$module->name] = $module->is_active ? CRM_Extension_Manager::STATUS_INSTALLED : CRM_Extension_Manager::STATUS_DISABLED; | |
93 | ||
94 | } | |
95 | return $statuses; | |
96 | } | |
97 | ||
6a488035 | 98 | } |