Logo Search packages:      
Sourcecode: cakephp version File versions

configure.php

<?php
/* SVN FILE: $Id: configure.php 4603 2007-03-09 22:34:33Z phpnut $ */
/**
 * Short description for file.
 *
 * Long description for file
 *
 * PHP versions 4 and 5
 *
 * CakePHP(tm) :  Rapid Development Framework <http://www.cakephp.org/>
 * Copyright 2005-2007, Cake Software Foundation, Inc.
 *                                              1785 E. Sahara Avenue, Suite 490-204
 *                                              Las Vegas, Nevada 89104
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @filesource
 * @copyright           Copyright 2005-2007, Cake Software Foundation, Inc.
 * @link                      http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
 * @package             cake
 * @subpackage          cake.cake.libs
 * @since               CakePHP(tm) v 1.0.0.2363
 * @version             $Revision: 4603 $
 * @modifiedby          $LastChangedBy: phpnut $
 * @lastmodified  $Date: 2007-03-09 16:34:33 -0600 (Fri, 09 Mar 2007) $
 * @license             http://www.opensource.org/licenses/mit-license.php The MIT License
 */
/**
 * Short description for file.
 *
 * Long description for file
 *
 * @package       cake
 * @subpackage    cake.cake.libs
 */
class Configure extends Object {
/**
 * Hold array with paths to view files
 *
 * @var array
 * @access public
 */
      var $viewPaths = array();
/**
 * Hold array with paths to controller files
 *
 * @var array
 * @access public
 */
      var $controllerPaths = array();
/**
 * Enter description here...
 *
 * @var array
 * @access public
 */
      var $modelPaths = array();
/**
 * Enter description here...
 *
 * @var array
 * @access public
 */
      var $helperPaths = array();
/**
 * Enter description here...
 *
 * @var array
 * @access public
 */
      var $componentPaths = array();
/**
 * Enter description here...
 *
 * @var integer
 * @access public
 */
      var $debug = null;
/**
 * Return a singleton instance of Configure.
 *
 * @return Configure instance
 * @access public
 */
      function &getInstance() {
            static $instance = array();
            if (!$instance) {
                  $instance[0] =& new Configure;
                  $instance[0]->__loadBootstrap();
            }
            return $instance[0];
      }
/**
 * Used to write a dynamic var in the Configure instance.
 *
 * Usage
 * Configure::write('One.key1', 'value of the Configure::One[key1]');
 * Configure::write(array('One.key1' => 'value of the Configure::One[key1]'));
 * Configure::write('One', array('key1'=>'value of the Configure::One[key1]', 'key2'=>'value of the Configure::One[key2]');
 * Configure::write(array('One.key1' => 'value of the Configure::One[key1]', 'One.key2' => 'value of the Configure::One[key2]'));
 *
 * @param array $config
 * @return void
 * @access public
 */
      function write($config, $value = null){
            $_this =& Configure::getInstance();

            if(!is_array($config) && $value !== null) {
                  $name = $_this->__configVarNames($config);

                  if(count($name) > 1){
                        $_this->{$name[0]}[$name[1]] = $value;
                  } else {
                        $_this->{$name[0]} = $value;
                  }
            } else {

                  foreach($config as $names => $value){
                        $name = $_this->__configVarNames($names);
                        if(count($name) > 1){
                              $_this->{$name[0]}[$name[1]] = $value;
                        } else {
                              $_this->{$name[0]} = $value;
                        }
                  }
            }

            if ($config == 'debug' || (is_array($config) && in_array('debug', $config))) {
                  if ($_this->debug) {
                        error_reporting(E_ALL);

                        if (function_exists('ini_set')) {
                              ini_set('display_errors', 1);
                        }
                  } else {
                        error_reporting(0);
                  }
            }
      }
/**
 * Used to read Configure::$var
 *
 * Usage
 * Configure::read('Name'); will return all values for Name
 * Configure::read('Name.key'); will return only the value of Configure::Name[key]
 *
 * @param string $var
 * @return string value of Configure::$var
 * @access public
 */
      function read($var = 'debug'){
            $_this =& Configure::getInstance();
            if($var === 'debug') {
                  if(!isset($_this->debug)){
                        $_this->debug = DEBUG;
                  }
                  return $_this->debug;
            }

            $name = $_this->__configVarNames($var);
            if(count($name) > 1){
                  if(isset($_this->{$name[0]}[$name[1]])) {
                        return $_this->{$name[0]}[$name[1]];
                  }
                  return null;
            } else {
                  if(isset($_this->{$name[0]})) {
                        return $_this->{$name[0]};
                  }
                  return null;
            }
      }
/**
 * Used to delete a var from the Configure instance.
 *
 * Usage:
 * Configure::delete('Name'); will delete the entire Configure::Name
 * Configure::delete('Name.key'); will delete only the Configure::Name[key]
 *
 * @param string $var the var to be deleted
 * @return void
 * @access public
 */
      function delete($var = null){
            $_this =& Configure::getInstance();

            $name = $_this->__configVarNames($var);
            if(count($name) > 1){
                  unset($_this->{$name[0]}[$name[1]]);
            } else {
                  unset($_this->{$name[0]});
            }
      }
/**
 * Will load a file from app/config/configure_file.php
 * variables in the files should be formated like:
 *  $config['name'] = 'value';
 * These will be used to create dynamic Configure vars.
 *
 * Usage Configure::load('configure_file');
 *
 * @param string $fileName name of file to load, extension must be .php and only the name should be used, not the extenstion
 * @return Configure::write
 * @access public
 */
      function load($fileName) {
            $_this =& Configure::getInstance();

            if(!file_exists(CONFIGS . $fileName . '.php')) {
                  trigger_error("Configure::load() - $fileName.php not found", E_USER_WARNING);
                  return false;
            }
            include(CONFIGS . $fileName . '.php');
            if(!isset($config)){
                  trigger_error("Configure::load() - no variable \$config found in $fileName.php", E_USER_WARNING);
                  return false;
            }
            return $_this->write($config);
      }

/**
 * Used to determine the current version of CakePHP
 *
 * Usage Configure::version();
 *
 * @return string Current version of CakePHP
 * @access public
 */
      function version() {
            $_this =& Configure::getInstance();
            if(!isset($_this->Cake['version'])){
                  require(CORE_PATH . 'cake' . DS . 'config' . DS . 'config.php');
                  $_this->write($config);
            }
            return $_this->Cake['version'];
      }
/**
 * Checks $name for dot notation to create dynamic Configure::$var as an array when needed.
 *
 * @param mixed $name
 * @return array
 * @access private
 */
      function __configVarNames($name) {
            if (is_string($name)) {
                  if (strpos($name, ".")) {
                        $name = explode(".", $name);
                  } else {
                        $name = array($name);
                  }
            }
            return $name;
      }
/**
 * Sets the var modelPaths
 *
 * @param array $modelPaths
 * @access private
 */
      function __buildModelPaths($modelPaths) {
            $_this =& Configure::getInstance();
            $_this->modelPaths[] = MODELS;
            if (isset($modelPaths)) {
                  foreach($modelPaths as $value) {
                        $_this->modelPaths[] = $value;
                  }
            }
      }
/**
 * Sets the var viewPaths
 *
 * @param array $viewPaths
 * @access private
 */
      function __buildViewPaths($viewPaths) {
            $_this =& Configure::getInstance();
            $_this->viewPaths[] = VIEWS;
            if (isset($viewPaths)) {
                  foreach($viewPaths as $value) {
                        $_this->viewPaths[] = $value;
                  }
            }
      }
/**
 * Sets the var controllerPaths
 *
 * @param array $controllerPaths
 * @access private
 */
      function __buildControllerPaths($controllerPaths) {
            $_this =& Configure::getInstance();
            $_this->controllerPaths[] = CONTROLLERS;
            if (isset($controllerPaths)) {
                  foreach($controllerPaths as $value) {
                        $_this->controllerPaths[] = $value;
                  }
            }
      }
/**
 * Sets the var helperPaths
 *
 * @param array $helperPaths
 * @access private
 */
      function __buildHelperPaths($helperPaths) {
            $_this =& Configure::getInstance();
            $_this->helperPaths[] = HELPERS;
            if (isset($helperPaths)) {
                  foreach($helperPaths as $value) {
                        $_this->helperPaths[] = $value;
                  }
            }
      }
/**
 * Sets the var componentPaths
 *
 * @param array $componentPaths
 * @access private
 */
      function __buildComponentPaths($componentPaths) {
            $_this =& Configure::getInstance();
            $_this->componentPaths[] = COMPONENTS;
            if (isset($componentPaths)) {
                  foreach($componentPaths as $value) {
                        $_this->componentPaths[] = $value;
                  }
            }
      }
/**
 * Loads the app/config/bootstrap.php
 * If the alternative paths are set in this file
 * they will be added to the paths vars
 *
 * @access private
 */
      function __loadBootstrap() {
            $_this =& Configure::getInstance();
            $modelPaths = null;
            $viewPaths = null;
            $controllerPaths = null;
            $helperPaths = null;
            $componentPaths = null;
            require APP_PATH . 'config' . DS . 'bootstrap.php';
            $_this->__buildModelPaths($modelPaths);
            $_this->__buildViewPaths($viewPaths);
            $_this->__buildControllerPaths($controllerPaths);
            $_this->__buildHelperPaths($helperPaths);
            $_this->__buildComponentPaths($componentPaths);
      }
}
?>

Generated by  Doxygen 1.6.0   Back to index