File Source for Config.php

<?php
// vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 fdm=marker encoding=utf8 :
/**
* Pxxo - build self-supported and interoperable Web graphical components
*
* Copyright (c) 2008, Nicolas Thouvenin
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the author nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* @package Pxxo
* @copyright Copyright (c) 2008 Nicolas Thouvenin
* @license http://opensource.org/licenses/bsd-license.php
* @version $Id$
*/
if (!defined('PXXO_ZEND_PATH')) {
define('PXXO_ZEND_PATH', realpath(rtrim(dirname(__FILE__),DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.'..'.DIRECTORY_SEPARATOR.'..'.DIRECTORY_SEPARATOR.'ZendFramework'));
$include_path = ini_get('include_path');
if ((PXXO_ZEND_PATH !== false) && (strpos($include_path, PXXO_ZEND_PATH) === false))
ini_set('include_path', $include_path.PATH_SEPARATOR.PXXO_ZEND_PATH);
}
require_once 'Zend/Registry.php';
require_once 'Zend/Locale.php';
/**
* Classe de configuration
*
* Permet de stocker des parametres de maniere unique.
* tout en les rendant disponnible partout
*
* @package Pxxo
* @copyright Copyright (c) 2008 Nicolas Thouvenin
* @license http://opensource.org/licenses/bsd-license.php
*/
class Pxxo_Config
{
/**
* Chemin physique de la racine de l'application
* @var string
*/
public $path = '';
/**
* Nom physique (UNIX) de l'application
* @var string
*/
public $name;
/**
* Courriel de l'application
* @var string
*/
public $mail;
/**
* Version de l'application
* @var string
*/
public $version;
/**
* Charset de l'application
* @var string
*/
public $charset = 'UTF-8';
/**
* Langue par defaut de l'application
* @var mixed
*/
public $language;
/**
* l'URL du serveur de l'application sans le chemin et l'éventuel script terminal
* exemple: http://localhost
* @var string
*/
public $url_host;
/**
* Chemin dans l'URL vers la racine de l'application
* exemple: /monapplication
* @var string
*/
public $url_root;
/**
* URL complete vers la racine de l'application (concaténation de url_host et url_root)
* exemple: http://localhost/monapplication
* @var string
*/
public $url_base;
/**
* Nom du script pointant vers le point d'entré de l'application
* exemple : article3.php
* @var string
*/
public $url_script;
/**
* Paramètre GET du point d'entré de l'application
* exemple : action=monaction&param=bidon
* @var string
*/
public $url_query;
/**
* Filtre appliqué sur url_query permettant de ne conserver que les paramètres du point d'entrée de l'application
* exemple : si les paramètres de l'url sont action=home&article=1&monparam=bidon
* et que url_query_filter vaut /^(action|article)/ (c'est une expression régulière)
* les paramètres conservés dans url_query seront action=home&article=1
* Par défaut on ne laisse passer aucun paramètres dans l'url.
* @var string
*/
public $url_query_filter;
/**
* URL complète du point d'entré de l'application (concaténation de url_base et url_script)
* exemple : http://localhost/monapplication/article3.php?action=monaction&param=bidon
* @var string
*/
public $url;
/**
* Repertoire temporaire
* @var string
*/
public $temp_path = '';
/**
* Nom de la première classe Pxxo mère de toute les autres
* @var string
*/
public $class_core;
/**
* Tableau contenant les arguments Ã donner au constructeur de la classe "class_core"
* @var array
*/
public $class_args;
/**
* Préfix communn Ã toutes les classes Pxxo
* @var mixed
*/
public $class_prefix = '';
/**
* Liste des chemins (genre include_path) pour trouver les classes Pxxo
* @var string
*/
public $class_path = '';
/**
* Active ou non le cache
* @var integer
*/
public $cache_flag = null;
/**
* Chemin Physique vers le réperoire de cache
* @var string
*/
public $cache_path = '';
/**
* Niveau cf P_C_*
* @var integer
*/
public $cache_level = null;
/**
* Niveau de debug 0 désactivé, 1 : code HTML non "compressé et report de toutes les erreurs PHP, 2 : active la trace pxxo, 3 : active le profiler
* @var integer
*/
public $debug_level = 0;
/**
* Le mode Session est-il activé
* @var string
*/
public $session_flag = false;
/**
* Les sessions sont-elle activé automatiquement
* @var string
*/
public $session_auto = false;
/**
* Utilisation ou non du controller
* @var mixed
*/
public $controller_used = false;
/**
* Nom du theme par defaut pour les objects Pxxo_Pago_Action
* @var string
*/
public $theme_name = '';
/**
* Liste des chemins d'accès aux thèmes
* @var string
*/
public $theme_path = '';
/**
* chemin vers un répertoire physique ou seront généré les resources
* @var mixed
*/
public $resources_path = '';
/**
* url correspondant à au répertoire physique
* @var mixed
*/
public $resources_url = '';
/**
* @var string active la modification de Pxxo_Config via des requetes GET ou POST
*/
public $request_flag = false;
/**
* @var array liste des variables potentiellement modifiable via des requetes GET ou POST
*/
public $request_auth = array('language');
/**
* @var int Spécifie où les messages d'erreur doivent aller. (cf. http://fr.php.net/error_log)
*/
public $error_log_type = null;
/**
* @var string La destination dépend du type (cf. http://fr.php.net/error_log)
*/
public $error_log_destination = null;
/**
* @var string Les en-têtes supplémentaires (cf. http://fr.php.net/error_log)
*/
public $error_log_extras = null;
/**
* @var Zend_Locale
*/
public $locale;
/**
* Vérification de la cohérence des valeurs de la configuration
*
*/
public function check()
{
// Controle des niveaux
settype($this->debug_level, 'integer');
if ($this->debug_level < 0)
$this->debug_level = 0;
if ($this->debug_level > 4)
$this->debug_level = 4;
// Réglage du mode Debug
if ($this->debug_level > 0) error_reporting(E_ALL);
if ($this->request_flag === true) {
foreach($this->request_auth as $p)
if (isset($_REQUEST[$p])) $this->$p = $_REQUEST[$p];
}
// Détéction des chemins par défaut
if (empty($this->path) && isset($_SERVER['SCRIPT_FILENAME']))
$this->path = dirname($_SERVER['SCRIPT_FILENAME']);
if (empty($this->path) && isset($_SERVER['PHP_SELF']))
$this->path = dirname($_SERVER['PHP_SELF']);
if (empty($this->path))
$this->path = '.';
if (empty($this->temp_path)) {
if (isset($_ENV['TMP'])) $this->temp_path = $_ENV['TMP'];
elseif (isset($_ENV['TMPDIR'])) $this->temp_path = $_ENV['TMPDIR'];
elseif (isset($_ENV['TEMP'])) $this->temp_path = $_ENV['TEMP'];
elseif (is_dir('/tmp')) $this->temp_path = '/tmp';
else $this->temp_path = '.';
}
if (empty($this->resources_path)) {
$this->resources_path = $this->temp_path;
}
if (empty($this->cache_path)) {
$this->cache_path = $this->temp_path;
}
if (!empty($this->class_path)) {
$include_path = ini_get('include_path');
if (
(strpos($include_path, $this->class_path.PATH_SEPARATOR) === false) &&
(strpos($include_path, PATH_SEPARATOR.$this->class_path) === false)
)
ini_set('include_path',$this->class_path.PATH_SEPARATOR.$include_path);
}
// Les chemins déduits sont-ils des répertoires ? Et pour certain peut-on écrire dedans ?
if (!is_dir($this->path))
trigger_error(sprintf('invalid Pxxo_Config parameter : `path` (%s) is not a directory',
$this->path),
E_USER_NOTICE);
if (!is_dir($this->temp_path))
trigger_error(sprintf('invalid Pxxo_Config parameter : `temp_path` (%s) is not a directory',
$this->temp_path),
E_USER_NOTICE);
if (!is_writable($this->temp_path))
trigger_error(sprintf('invalid Pxxo_Config parameter : `temp_path`(%s) is not writable by the web server',
$this->temp_path),
E_USER_ERROR);
if (!is_dir($this->cache_path))
trigger_error(sprintf('invalid Pxxo_Config parameter : `cache_path` (%s) is not a directory',
$this->cache_path),
E_USER_ERROR);
if (!is_writable($this->cache_path))
trigger_error(sprintf('invalid Pxxo_Config parameter : `cache_path` (%s) is not writable by the web server',
$this->cache_path),
E_USER_ERROR);
if (!is_dir($this->resources_path))
trigger_error(sprintf('invalid Pxxo_Config parameter : `resources_path` (%s) is not a directory',
$this->resources_path),
E_USER_ERROR);
if (!is_writable($this->resources_path))
trigger_error(sprintf('invalid Pxxo_Config parameter : `resources_path` (%s) is not writable by the web server',
$this->resources_path),
E_USER_ERROR);
// Detection et decomposition des elements de l'URI
if (!isset($this->url_root))
$this->url_root = dirname($_SERVER['PHP_SELF']);
if (strpos($this->url_root, '/') === false)
$this->url_root = '/'.$this->url_root;
$this->url_root = preg_replace(',(\/$),', '', $this->url_root);
if (!isset($this->url_host) && isset($_SERVER['HTTP_HOST']))
$this->url_host = 'http'.(!isset($_SERVER['HTTPS'])||strtolower($_SERVER['HTTPS'])!= 'on'?'':'s').'://'.(isset($_SERVER["HTTP_X_FORWARDED_HOST"]) ? $_SERVER['HTTP_X_FORWARDED_HOST'] : $_SERVER['HTTP_HOST']);
$this->url_host = preg_replace('/\/$/', '', $this->url_host);
if (!isset($this->url_base))
$this->url_base = $this->url_host.$this->url_root;
$this->url_base = preg_replace('/\/$/', '', $this->url_base);
if (!isset($this->url_script))
$this->url_script = basename($_SERVER['PHP_SELF']);
$this->url_script = preg_replace('/\//', '', $this->url_script);
if (!isset($this->url_query))
$this->url_query = isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : '';
// Filtrage des paramètres de l'url
if (isset($this->url_query_filter))
{
$url_query_tmp = array();
parse_str($this->url_query, $url_query_tmp);
foreach(array_keys($url_query_tmp) as $key)
if (!preg_match($this->url_query_filter,$key))
unset($url_query_tmp[$key]);
require_once 'PHP/Compat/Function/http_build_query.php'; // for php4 compatibility
// rebuild the modified url
$this->url_query = http_build_query($url_query_tmp);
$this->url_query = preg_replace('/&/', '&', $this->url_query);
}
else
$this->url_query = ''; // when no url_query_filter is defined, do not forward any GET parameters
if (!isset($this->url))
$this->url = $this->url_base .'/'. $this->url_script . ($this->url_query != '' ? '?'.$this->url_query : '');
if ($this->resources_url === '')
$this->resources_url = $this->url_root;
// Session
if ($this->session_flag === true) {
if (!empty($this->session_path)) {
if (!file_exists($this->session_path))
mkdir($this->session_path);
if (is_dir($this->session_path))
session_save_path($this->session_path);
}
if ($this->session_auto === false) {
session_start();
}
//session_cache_limiter('must-revalidate'); // trop dur d'imposer cela Ã tout le monde
}
// Locale
$this->locale = new Zend_Locale(Zend_Locale::BROWSER);
if (is_null($this->language) or empty($this->language)) {
$this->language = $this->locale->getLanguage();
}
}
/**
* Enregistre la classe courante comme classe de référence
*/
public function register()
{
$this->check();
$o = new ReflectionClass('Pxxo_Config');
$vars = $o->getProperties();
foreach($vars as $var) {
Zend_Registry::set($var->getName(), $this->{$var->getName()});
}
}
/**
* Renvoit un paramètre de la configuration de référence
*
* @static
* @param string
* @return mixed
*/
public static function get($name)
{
if (Zend_Registry::isRegistered($name)) {
return Zend_Registry::get($name);
}
}
/**
* Renvoit un paramètre (non standard) de la configuration de référence
*
* @param string
* @return mixed
*/
public function __get($name)
{
return Zend_Registry::get($name);
}
/**
* Fixe un paramètre de la configuration de référence
*
* @param string
* @return mixed
*/
public static function set($name, &$value)
{
return Zend_Registry::set($name, $value);
}
/**
* Fixe un paramètre (non standard) de la configuration de référence
*
* @param string
* @return mixed
*/
public function __set($name, $value)
{
return Zend_Registry::set($name, $value);
}
}

Documentation generated on Thu, 13 Mar 2008 22:03:13 +0100 by phpDocumentor 1.4.1

Source for file Config.php