Source for file Environment.php

Documentation is available at Environment.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette
18: * @version $Id$
19: */
20:
21:
22:
23: /**
24: * Nette environment and configuration.
25: *
26: * @author David Grudl
27: * @copyright Copyright (c) 2004, 2009 David Grudl
28: * @package Nette
29: */
30: final class Environment
31: {
32: /**#@+ environment name */
33: const DEVELOPMENT = 'development';
34: const PRODUCTION = 'production';
35: const CONSOLE = 'console';
36: const LAB = 'lab';
37: /**#@-*/
38:
39: /**#@+ mode name */
40: const DEBUG = 'debug';
41: const PERFORMANCE = 'performance';
42: /**#@-*/
43:
44: /** @var Configurator */
45: private static $configurator;
46:
47: /** @var string the mode of current application */
48: private static $mode = array();
49:
50: /** @var ArrayObject */
51: private static $config;
52:
53: /** @var IServiceLocator */
54: private static $serviceLocator;
55:
56: /** @var array */
57: private static $vars = array(
58: 'encoding' => array('UTF-8', FALSE),
59: 'lang' => array('en', FALSE),
60: 'cacheBase' => array('%tempDir%/cache-', TRUE),
61: 'tempDir' => array('%appDir%/temp', TRUE),
62: 'logDir' => array('%appDir%/log', TRUE),
63: 'templatesDir' => array('%appDir%/templates', TRUE),
64: 'presentersDir' => array('%appDir%/presenters', TRUE),
65: 'componentsDir' => array('%appDir%/components', TRUE),
66: 'modelsDir' => array('%appDir%/models', TRUE),
67: );
68:
69:
70:
71: /**
72: * Static class - cannot be instantiated.
73: */
74: final public function __construct()
75: {
76: throw new LogicException("Cannot instantiate static class " . get_class($this));
77: }
78:
79:
80:
81: /**
82: * Sets "class behind Environment" configurator.
83: * @param Configurator
84: * @return void
85: */
86: public static function setConfigurator(Configurator $configurator)
87: {
88: self::$configurator = $configurator;
89: }
90:
91:
92:
93: /**
94: * Gets "class behind Environment" configurator.
95: * @return Configurator
96: */
97: public static function getConfigurator()
98: {
99: if (self::$configurator === NULL) {
100: self::$configurator = new Configurator;
101: }
102: return self::$configurator;
103: }
104:
105:
106:
107: /********************* environment name and modes ****************d*g**/
108:
109:
110:
111: /**
112: * Sets the current environment name.
113: * @param string
114: * @return void
115: * @throws InvalidStateException
116: */
117: public static function setName($name)
118: {
119: if (!isset(self::$vars['environment'])) {
120: self::setVariable('environment', $name, FALSE);
121:
122: } else {
123: throw new InvalidStateException('Environment name has been already set.');
124: }
125: }
126:
127:
128:
129: /**
130: * Returns the current environment name.
131: * @return string
132: */
133: public static function getName()
134: {
135: $name = self::getVariable('environment');
136: if ($name === NULL) {
137: $name = self::getConfigurator()->detect('environment');
138: self::setVariable('environment', $name, FALSE);
139: }
140: return $name;
141: }
142:
143:
144:
145: /**
146: * Sets the mode.
147: *
148: * @param string mode identifier
149: * @param bool set or unser
150: * @return void
151: */
152: public static function setMode($mode, $flag = TRUE)
153: {
154: if ($mode === 'live') $mode = 'production'; // back compatibility
155: self::$mode[$mode] = (bool) $flag;
156: }
157:
158:
159:
160: /**
161: * Returns the mode.
162: *
163: * @param string mode identifier
164: * @return bool
165: */
166: public static function getMode($mode)
167: {
168: if ($mode === 'live') $mode = 'production'; // back compatibility
169: if (isset(self::$mode[$mode])) {
170: return self::$mode[$mode];
171:
172: } else {
173: return self::$mode[$mode] = self::getConfigurator()->detect($mode);
174: }
175: }
176:
177:
178:
179: /**
180: * Detects console (non-HTTP) mode.
181: * @return bool
182: */
183: public static function isConsole()
184: {
185: return self::getMode('console');
186: }
187:
188:
189:
190: /**
191: * Determines whether a server is running in production mode.
192: * @return bool
193: */
194: public static function isProduction()
195: {
196: return self::getMode('production');
197: }
198:
199:
200:
201: /**
202: * @deprecated {@link Environment::isProduction()}
203: */
204: public static function isLive()
205: {
206: trigger_error('Environment::isLive() is deprecated; use Environment::isProduction() instead.', E_USER_WARNING);
207: return self::getMode('production');
208: }
209:
210:
211:
212: /**
213: * Determines whether the debugger is active.
214: * @return bool
215: */
216: public static function isDebugging()
217: {
218: return self::getMode('debug');
219: }
220:
221:
222:
223: /********************* environment variables ****************d*g**/
224:
225:
226:
227: /**
228: * Sets the environment variable.
229: * @param string
230: * @param mixed
231: * @param bool
232: * @return void
233: */
234: public static function setVariable($name, $value, $expand = TRUE)
235: {
236: if (!is_string($value)) {
237: $expand = FALSE;
238: }
239: self::$vars[$name] = array($value, (bool) $expand);
240: }
241:
242:
243:
244: /**
245: * Returns the value of an environment variable or $default if there is no element set.
246: * @param string
247: * @param mixed default value to use if key not found
248: * @return mixed
249: * @throws InvalidStateException
250: */
251: public static function getVariable($name, $default = NULL)
252: {
253: if (isset(self::$vars[$name])) {
254: list($var, $exp) = self::$vars[$name];
255: if ($exp) {
256: $var = self::expand($var);
257: self::$vars[$name] = array($var, FALSE);
258: }
259: return $var;
260:
261: } else {
262: // convert from camelCaps (or PascalCaps) to ALL_CAPS
263: $const = strtoupper(preg_replace('#(.)([A-Z]+)#', '$1_$2', $name));
264: $list = get_defined_constants(TRUE);
265: if (isset($list['user'][$const])) {
266: self::$vars[$name] = array($list['user'][$const], FALSE);
267: return $list['user'][$const];
268:
269: } else {
270: return $default;
271: }
272: }
273: }
274:
275:
276:
277: /**
278: * Define one or more variables as constants.
279: * @param string|array
280: * @return void
281: */
282: public static function exportConstant($names)
283: {
284: if (!is_array($names)) {
285: $names = func_get_args();
286: }
287:
288: foreach ($names as $name) {
289: $const = strtoupper(preg_replace('#(.)([A-Z]+)#', '$1_$2', $name));
290: define($const, self::getVariable($name));
291: }
292: }
293:
294:
295:
296: /**
297: * Returns expanded variable.
298: * @param string
299: * @return string
300: * @throws InvalidStateException
301: */
302: public static function expand($var)
303: {
304: if (is_string($var) && strpos($var, '%') !== FALSE) {
305: return @preg_replace_callback('#%([a-z0-9_-]*)%#i', array(__CLASS__, 'expandCb'), $var); // intentionally @ due PHP bug #39257
306: }
307: return $var;
308: }
309:
310:
311:
312: /**
313: * @see Environment::expand()
314: * @param array
315: * @return string
316: */
317: private static function expandCb($m)
318: {
319: list(, $var) = $m;
320: if ($var === '') return '%';
321:
322: static $livelock;
323: if (isset($livelock[$var])) {
324: throw new InvalidStateException("Circular reference detected for variables: "
325: . implode(', ', array_keys($livelock)) . ".");
326: }
327:
328: try {
329: $livelock[$var] = TRUE;
330: $val = self::getVariable($var);
331: unset($livelock[$var]);
332: } catch (Exception $e) {
333: $livelock = array();
334: throw $e;
335: }
336:
337: if ($val === NULL) {
338: throw new InvalidStateException("Unknown environment variable '$var'.");
339:
340: } elseif (!is_scalar($val)) {
341: throw new InvalidStateException("Environment variable '$var' is not scalar.");
342: }
343:
344: return $val;
345: }
346:
347:
348:
349: /********************* service locator ****************d*g**/
350:
351:
352:
353: /**
354: * Get initial instance of service locator.
355: * @return IServiceLocator
356: */
357: public static function getServiceLocator()
358: {
359: if (self::$serviceLocator === NULL) {
360: self::$serviceLocator = self::getConfigurator()->createServiceLocator();
361: }
362: return self::$serviceLocator;
363: }
364:
365:
366:
367: /**
368: * Gets the service object of the specified type.
369: * @param string service name
370: * @param bool throw exception if service doesn't exist?
371: * @return mixed
372: */
373: static public function getService($name, $need = TRUE)
374: {
375: return self::getServiceLocator()->getService($name, $need);
376: }
377:
378:
379:
380: /**
381: * @return IHttpRequest
382: */
383: public static function getHttpRequest()
384: {
385: return self::getServiceLocator()->getService('Nette\Web\IHttpRequest');
386: }
387:
388:
389:
390: /**
391: * @return IHttpResponse
392: */
393: public static function getHttpResponse()
394: {
395: return self::getServiceLocator()->getService('Nette\Web\IHttpResponse');
396: }
397:
398:
399:
400: /**
401: * @return Application
402: */
403: public static function getApplication()
404: {
405: return self::getServiceLocator()->getService('Nette\Application\Application');
406: }
407:
408:
409:
410: /**
411: * @return IUser
412: */
413: public static function getUser()
414: {
415: return self::getServiceLocator()->getService('Nette\Web\IUser');
416: }
417:
418:
419:
420: /********************* service factories ****************d*g**/
421:
422:
423:
424: /**
425: * @param string
426: * @return Cache
427: */
428: public static function getCache($namespace = '')
429: {
430: return new Cache(
431: self::getService('Nette\Caching\ICacheStorage'),
432: $namespace
433: );
434: }
435:
436:
437:
438: /**
439: * Returns instance of session or session namespace.
440: * @param string
441: * @return Session|Nette\Web\Session
442: */
443: public static function getSession($namespace = NULL)
444: {
445: $handler = self::getService('Nette\Web\Session');
446: return func_num_args() === 0 ? $handler : $handler->getNamespace($namespace);
447: }
448:
449:
450:
451: /********************* global configuration ****************d*g**/
452:
453:
454:
455: /**
456: * Loads global configuration from file and process it.
457: * @param string|Nette\Config\Config file name or Config object
458: * @return ArrayObject
459: */
460: public static function loadConfig($file = NULL)
461: {
462: return self::$config = self::getConfigurator()->loadConfig($file);
463: }
464:
465:
466:
467: /**
468: * Returns the global configuration.
469: * @param string key
470: * @param mixed default value
471: * @return mixed
472: */
473: public static function getConfig($key = NULL, $default = NULL)
474: {
475: if (func_num_args()) {
476: return isset(self::$config[$key]) ? self::$config[$key] : $default;
477:
478: } else {
479: return self::$config;
480: }
481: }
482:
483: }

Source for file Environment.php

Namespaces