-
Notifications
You must be signed in to change notification settings - Fork 21
/
Config.php
202 lines (178 loc) · 5.04 KB
/
Config.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<?php
/**
* LICENSE
*
* Copyright 2010 Albert Lombarte
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
namespace Sifo;
/**
* Configuration file parser.
*/
class Config
{
/**
* Defines what profile do you want to use to load libraries. This must be a key in domains.config.php
* @var string
*/
static public $libraries_profile = 'default';
/**
* Singleton instance.
*
* @var Config
*/
static protected $instance;
/**
* File used as base to load the paths to configuration files.
*
* @var string
*/
protected $configuration_files = 'configuration_files.config.php';
/**
* Variables taken from the config are stored here in the class context.
*
* @var array
*/
protected $config_values;
/**
* Content inside the $configuration_files file specififying in which instance is found every config.
*
* @var unknown_type
*/
protected $paths_to_configs = array();
protected function __construct( $instance_name )
{
$this->instance_name = $instance_name;
if ( $instance_name === 'tests' )
{
$this->config_path = ROOT_PATH . '/' . $instance_name ."/config/";
}
else
{
$this->config_path = ROOT_PATH . "/instances/" . $instance_name ."/config/";
}
include( $this->config_path . $this->configuration_files );
$this->paths_to_configs = $config;
}
/**
* Singleton of config class.
*
* @param string $instance_name Instance Name, needed to determine correct paths.
* @return Config
*/
public static function getInstance( $instance_name = null )
{
// Load instance from bootsrap
if ( !isset( $instance_name ) )
{
$instance_name = Bootstrap::$instance;
}
if ( !isset ( self::$instance[$instance_name] ) )
{
self::$instance[$instance_name] = new self( $instance_name );
}
return self::$instance[$instance_name];
}
/**
* Loads the desired config file for a given valid 'profile'.
*
* @param string $profile The requested profile.
* @throws Exception_Configuration When isn't set the self::PROFILE_NAME_FOR_CONFIG_FILES section or the desired profile.
* @return boolean
*/
protected function loadConfig( $profile )
{
if( !isset( $this->paths_to_configs[$profile] ) )
{
throw new Exception_Configuration( "The profile '$profile' was not found" );
}
else
{
if ( !include( ROOT_PATH . '/' . $this->paths_to_configs[$profile] ) )
{
throw new Exception_Configuration( "Failed to include file " . ROOT_PATH . '/' . $this->paths_to_configs[$profile] , E_USER_ERROR );
}
else
{
// The file was correctly included. We include the variable $config found.
if ( !isset( $config ) )
{
throw new Exception_Configuration( 'The configuration files must have a variable named $config' );
}
return $config;
}
}
}
/**
* Gets the profile config variables for the desired profile.
*
* @param string $profile The requested profile.
* @param string $group The requested group inside the profile.
* @throws Exception_Configuration When the selected group or profile doesn't exist.
* @return mixed $config_values The config values in the config file of the current profile.
*/
public function getConfig( $profile, $group = null )
{
if ( !isset( $this->config_values[$profile] ) )
{
$this->config_values[$profile] = $this->loadConfig( $profile );
}
if ( is_null( $group ) )
{
return $this->config_values[$profile];
}
if ( isset( $this->config_values[$profile][$group] ) )
{
return $this->config_values[$profile][$group];
}
throw new Exception_Configuration( "The group '$group' for profile '$profile' was never set.", E_USER_ERROR );
}
/**
* Instance name.
*
* @return string
*/
public function getInstanceName()
{
return $this->instance_name;
}
/**
* Returns the library assigned to the given alias.
*
* @param string $alias Alias of the library, e.g: 'smarty'
* @return string Effective name of the folder with the library
*/
public function getLibrary( $alias )
{
$libraries = $this->getConfig( 'libraries', 'default' );
// User requested a different profile, combine with default for missing attributes.
if ( self::$libraries_profile != 'default' )
{
$libraries = array_merge( $libraries, $this->getConfig( 'libraries', self::$libraries_profile ) );
}
if ( !isset( $libraries[$alias] ) )
{
throw new Exception_Configuration( "The library '$alias' you are loading is not set in profile " . self::$libraries_profile );
}
return $libraries[$alias];
}
}
/**
* Exception for the process.
*/
class Exception_Configuration extends \Exception
{
}
?>