Refactored Config class.
* Config is now a Singleton. * Getter methods were removed, use $config->value instead.
This commit is contained in:
Josh Sherman
parent
16cd366b13
commit
68ac2196a3
1 changed files with 41 additions and 197 deletions
|
|
@ -3,25 +3,17 @@
|
|||
/**
|
||||
* Configuration Class File for PICKLES
|
||||
*
|
||||
* PICKLES is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of
|
||||
* the License, or (at your option) any later version.
|
||||
* PHP version 5
|
||||
*
|
||||
* PICKLES is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
* Licensed under the GNU General Public License Version 3
|
||||
* Redistribution of these files must retain the above copyright notice.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with PICKLES. If not, see
|
||||
* <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @author Joshua John Sherman <josh@phpwithpickles.org>
|
||||
* @copyright Copyright 2007, 2008, 2009 Joshua John Sherman
|
||||
* @package pickles
|
||||
* @author Josh Sherman <josh@phpwithpickles.org>
|
||||
* @copyright Copyright 2007-2010, Gravity Boulevard, LLC
|
||||
* @license http://www.gnu.org/licenses/gpl.html GPL v3
|
||||
* @link http://phpwithpickles.org
|
||||
* @license http://www.gnu.org/copyleft/lesser.html
|
||||
* @package PICKLES
|
||||
* @todo Add support for .php and .ini config files (auto scan directory?)
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
@ -32,12 +24,16 @@
|
|||
*
|
||||
* @usage <code>$config = new Config($filename); // $filename is optional, default = ../config.xml</code>
|
||||
*/
|
||||
class Config extends Object {
|
||||
|
||||
class Config extends Object
|
||||
{
|
||||
/**
|
||||
* Private collection of public config data
|
||||
* Instance of the Config object
|
||||
*
|
||||
* @static
|
||||
* @access private
|
||||
* @var object
|
||||
*/
|
||||
private $_public;
|
||||
private static $instance;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
|
|
@ -46,7 +42,8 @@ class Config extends Object {
|
|||
*
|
||||
* @param string $file Filename of the config file (optional)
|
||||
*/
|
||||
public function __construct($file = '../config.xml') {
|
||||
public function __construct($file = '../config.xml')
|
||||
{
|
||||
parent::__construct();
|
||||
|
||||
$this->load($file);
|
||||
|
|
@ -62,17 +59,17 @@ class Config extends Object {
|
|||
* @return boolean Success of the load process
|
||||
* @todo Add the ability to load in multiple configuration files.
|
||||
*/
|
||||
public function load($file) {
|
||||
|
||||
public function load($file)
|
||||
{
|
||||
// Makes sure the file is legit on the surface
|
||||
if (file_exists($file) && is_file($file) && is_readable($file)) {
|
||||
|
||||
if (file_exists($file) && is_file($file) && is_readable($file))
|
||||
{
|
||||
// Pulls the contents of the file to allow for validation
|
||||
$contents = trim(file_get_contents($file));
|
||||
|
||||
// Checks that the file contents isn't empty and that the config node is present
|
||||
if ($contents != '' && substr($contents, 0, 8) == '<config>' && substr($contents, -9) == '</config>') {
|
||||
|
||||
if ($contents != '' && substr($contents, 0, 8) == '<config>' && substr($contents, -9) == '</config>')
|
||||
{
|
||||
/**
|
||||
* @todo LIBXML_NOCDATA is 5.1+ and I want PICKLES to
|
||||
* be 5.0+ compatible. Potential fix is to read
|
||||
|
|
@ -84,9 +81,12 @@ class Config extends Object {
|
|||
// Loops through the top level nodes to find public nodes
|
||||
$variables = get_object_vars($data);
|
||||
|
||||
if (is_array($variables)) {
|
||||
foreach ($variables as $key => $value) {
|
||||
if (is_object($value) && isset($value->attributes()->public) && $value->attributes()->public == true) {
|
||||
if (is_array($variables))
|
||||
{
|
||||
foreach ($variables as $key => $value)
|
||||
{
|
||||
if (is_object($value) && isset($value->attributes()->public) && $value->attributes()->public == true)
|
||||
{
|
||||
$this->_public[$key] = $value;
|
||||
}
|
||||
|
||||
|
|
@ -100,178 +100,22 @@ class Config extends Object {
|
|||
}
|
||||
|
||||
/**
|
||||
* Gets the authentication value
|
||||
* Get instance of the object
|
||||
*
|
||||
* @return boolean The module's authentication setting or false
|
||||
*/
|
||||
public function getAuthentication() {
|
||||
if (isset($this->modules->authentication) && $this->modules->authentication == 'true') {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the caching value
|
||||
* Instantiates a new object if one isn't already available, then
|
||||
* returns the instance.
|
||||
*
|
||||
* @return mixed The module's cache life span setting or true or false
|
||||
* @static
|
||||
* @return object self::$instance instance of the Config
|
||||
*/
|
||||
public function getCaching() {
|
||||
if (isset($this->modules->caching)) {
|
||||
if ($this->modules->caching == 'true') {
|
||||
return true;
|
||||
}
|
||||
else if ($this->modules->caching == 'false') {
|
||||
return false;
|
||||
}
|
||||
else {
|
||||
return (int)$this->modules->caching;
|
||||
}
|
||||
public static function getInstance()
|
||||
{
|
||||
if (!isset(self::$instance) || empty(self::$instance))
|
||||
{
|
||||
self::$instance = new Config();
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the authentication value
|
||||
*
|
||||
* @return boolean The module's authentication setting or false
|
||||
*/
|
||||
public function getDebug() {
|
||||
if (isset($this->modules->debug) && $this->modules->debug == 'true') {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for $config->modules->default with string cast
|
||||
*
|
||||
* @return Returns the default module set or null
|
||||
*/
|
||||
public function getDefaultModule() {
|
||||
if (isset($this->modules->default)) {
|
||||
return (string)$this->modules->default;
|
||||
}
|
||||
|
||||
return 'home';
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets active status of the site
|
||||
*
|
||||
* @return boolean The site's disabled setting or false
|
||||
*/
|
||||
public function getDisabled() {
|
||||
if (isset($this->modules->disabled) && $this->modules->disabled == 'true') {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for $config->_public
|
||||
*
|
||||
* @return Returns the variable value or null if no variable.
|
||||
*/
|
||||
public function getPublicData() {
|
||||
if (isset($this->_public)) {
|
||||
return $this->_public;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the session value
|
||||
*
|
||||
* @return boolean The module's session setting or false
|
||||
*/
|
||||
public function getSession() {
|
||||
if (isset($this->modules->session) && $this->modules->session == 'true') {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the shared module
|
||||
*
|
||||
* @param string $requested_module The module being requested
|
||||
* @return string The name of the shared module or null
|
||||
*/
|
||||
public function getSharedModule($requested_module) {
|
||||
|
||||
$additional = null;
|
||||
|
||||
if (strpos($requested_module, '/') !== false) {
|
||||
list($requested_module, $additional) = split('/', $requested_module, 2);
|
||||
$additional = '/' . $additional;
|
||||
}
|
||||
|
||||
if (isset($this->modules->shared->module)) {
|
||||
foreach ($this->modules->shared->module as $shared_module) {
|
||||
if (isset($shared_module->alias)) {
|
||||
if ($requested_module == $shared_module->alias) {
|
||||
return (string)$shared_module->name . $additional;
|
||||
}
|
||||
}
|
||||
else {
|
||||
if ($requested_module == $shared_module->name) {
|
||||
return (string)$shared_module->name . $additional;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
//return 'home';
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the mapping for a table
|
||||
*
|
||||
* @param string $requested_table The table being requested
|
||||
* @return array The mapping for the table
|
||||
*/
|
||||
public function getTableMapping($requested_table, $default_mapping) {
|
||||
|
||||
$table_mapping = $default_mapping;
|
||||
|
||||
if (isset($this->mappings->table)) {
|
||||
foreach ($this->mappings->table as $table) {
|
||||
if (isset($table->name) && trim($table->name) != '' && $table->name == $requested_table) {
|
||||
$table_mapping['name'] = (string)(isset($table->alias) && trim($table->alias) != '' ? $table->alias : $table->name);
|
||||
|
||||
if (isset($table->fields->field)) {
|
||||
foreach ($table->fields->field as $field) {
|
||||
if (isset($field->name) && trim($field->name) != '') {
|
||||
$table_mapping['fields'][(string)$field->name] = (string)(isset($field->alias) && trim($field->alias) != '' ? $field->alias : $field->name);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $table_mapping;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the viewer value
|
||||
*
|
||||
* @return boolean The module's viewer setting or false
|
||||
*/
|
||||
public function getViewer() {
|
||||
if (isset($this->modules->viewer) && $this->modules->viewer == 'true') {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
return self::$instance;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue