Upgrade CakePHP from 2.2.5 to 2.9.5

This commit is contained in:
Brm Ko 2017-02-26 15:29:44 +01:00
parent 5a580df460
commit 235a541597
793 changed files with 60746 additions and 23753 deletions

View file

@ -2,27 +2,29 @@
/**
* App class
*
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package Cake.Core
* @since CakePHP(tm) v 1.2.0.6001
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
App::uses('Inflector', 'Utility');
App::uses('CakePlugin', 'Core');
/**
* App is responsible for path management, class location and class loading.
*
* ### Adding paths
*
* You can add paths to the search indexes App uses to find classes using `App::build()`. Adding
* You can add paths to the search indexes App uses to find classes using `App::build()`. Adding
* additional controller paths for example would alter where CakePHP looks for controllers.
* This allows you to split your application up across the filesystem.
*
@ -31,7 +33,7 @@
* CakePHP is organized around the idea of packages, each class belongs to a package or folder where other
* classes reside. You can configure each package location in your application using `App::build('APackage/SubPackage', $paths)`
* to inform the framework where should each class be loaded. Almost every class in the CakePHP framework can be swapped
* by your own compatible implementation. If you wish to use you own class instead of the classes the framework provides,
* by your own compatible implementation. If you wish to use your own class instead of the classes the framework provides,
* just add the class to your libs folder mocking the directory location of where CakePHP expects to find it.
*
* For instance if you'd like to use your own HttpSocket class, put it under
@ -48,8 +50,8 @@
*
* ### Locating plugins and themes
*
* Plugins and Themes can be located with App as well. Using App::pluginPath('DebugKit') for example, will
* give you the full path to the DebugKit plugin. App::themePath('purple'), would give the full path to the
* Plugins and Themes can be located with App as well. Using App::pluginPath('DebugKit') for example, will
* give you the full path to the DebugKit plugin. App::themePath('purple'), would give the full path to the
* `purple` theme.
*
* ### Inspecting known objects
@ -65,28 +67,28 @@ class App {
/**
* Append paths
*
* @constant APPEND
* @var string
*/
const APPEND = 'append';
/**
* Prepend paths
*
* @constant PREPEND
* @var string
*/
const PREPEND = 'prepend';
/**
* Register package
*
* @constant REGISTER
* @var string
*/
const REGISTER = 'register';
/**
* Reset paths instead of merging
*
* @constant RESET
* @var bool
*/
const RESET = true;
@ -120,7 +122,7 @@ class App {
/**
* Whether or not to return the file that is loaded.
*
* @var boolean
* @var bool
*/
public static $return = false;
@ -182,14 +184,14 @@ class App {
/**
* Indicates whether the class cache should be stored again because of an addition to it
*
* @var boolean
* @var bool
*/
protected static $_cacheChange = false;
/**
* Indicates whether the object cache should be stored again because of an addition to it
*
* @var boolean
* @var bool
*/
protected static $_objectCacheChange = false;
@ -197,7 +199,7 @@ class App {
* Indicates the the Application is in the bootstrapping process. Used to better cache
* loaded classes while the cache libraries have not been yet initialized
*
* @var boolean
* @var bool
*/
public static $bootstrapping = false;
@ -216,14 +218,14 @@ class App {
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::path
*/
public static function path($type, $plugin = null) {
if (!empty(self::$legacy[$type])) {
$type = self::$legacy[$type];
if (!empty(static::$legacy[$type])) {
$type = static::$legacy[$type];
}
if (!empty($plugin)) {
$path = array();
$pluginPath = self::pluginPath($plugin);
$packageFormat = self::_packageFormat();
$pluginPath = CakePlugin::path($plugin);
$packageFormat = static::_packageFormat();
if (!empty($packageFormat[$type])) {
foreach ($packageFormat[$type] as $f) {
$path[] = sprintf($f, $pluginPath);
@ -232,22 +234,22 @@ class App {
return $path;
}
if (!isset(self::$_packages[$type])) {
if (!isset(static::$_packages[$type])) {
return array();
}
return self::$_packages[$type];
return static::$_packages[$type];
}
/**
* Get all the currently loaded paths from App. Useful for inspecting
* or storing all paths App knows about. For a paths to a specific package
* or storing all paths App knows about. For a paths to a specific package
* use App::path()
*
* @return array An array of packages and their associated paths.
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::paths
*/
public static function paths() {
return self::$_packages;
return static::$_packages;
}
/**
@ -257,7 +259,7 @@ class App {
*
* Usage:
*
* `App::build(array(Model' => array('/a/full/path/to/models/'))); will setup a new search path for the Model package`
* `App::build(array('Model' => array('/a/full/path/to/models/'))); will setup a new search path for the Model package`
*
* `App::build(array('Model' => array('/path/to/models/')), App::RESET); will setup the path as the only valid path for searching models`
*
@ -268,7 +270,7 @@ class App {
* If reset is set to true, all loaded plugins will be forgotten and they will be needed to be loaded again.
*
* @param array $paths associative array with package names as keys and a list of directories for new search paths
* @param boolean|string $mode App::RESET will set paths, App::APPEND with append paths, App::PREPEND will prepend paths (default)
* @param bool|string $mode App::RESET will set paths, App::APPEND with append paths, App::PREPEND will prepend paths (default)
* App::REGISTER will register new packages and their paths, %s in path will be replaced by APP path
* @return void
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::build
@ -277,8 +279,8 @@ class App {
//Provides Backwards compatibility for old-style package names
$legacyPaths = array();
foreach ($paths as $type => $path) {
if (!empty(self::$legacy[$type])) {
$type = self::$legacy[$type];
if (!empty(static::$legacy[$type])) {
$type = static::$legacy[$type];
}
$legacyPaths[$type] = $path;
}
@ -286,17 +288,17 @@ class App {
if ($mode === App::RESET) {
foreach ($paths as $type => $new) {
self::$_packages[$type] = (array)$new;
self::objects($type, null, false);
static::$_packages[$type] = (array)$new;
static::objects($type, null, false);
}
return;
}
if (empty($paths)) {
self::$_packageFormat = null;
static::$_packageFormat = null;
}
$packageFormat = self::_packageFormat();
$packageFormat = static::_packageFormat();
if ($mode === App::REGISTER) {
foreach ($paths as $package => $formats) {
@ -307,7 +309,7 @@ class App {
$packageFormat[$package] = array_values(array_unique($formats));
}
}
self::$_packageFormat = $packageFormat;
static::$_packageFormat = $packageFormat;
}
$defaults = array();
@ -318,7 +320,7 @@ class App {
}
if (empty($paths)) {
self::$_packages = $defaults;
static::$_packages = $defaults;
return;
}
@ -327,8 +329,8 @@ class App {
}
foreach ($defaults as $type => $default) {
if (!empty(self::$_packages[$type])) {
$path = self::$_packages[$type];
if (!empty(static::$_packages[$type])) {
$path = static::$_packages[$type];
} else {
$path = $default;
}
@ -345,7 +347,7 @@ class App {
$path = array_values(array_unique($path));
}
self::$_packages[$type] = $path;
static::$_packages[$type] = $path;
}
}
@ -359,13 +361,14 @@ class App {
* @param string $plugin CamelCased/lower_cased plugin name to find the path of.
* @return string full path to the plugin.
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::pluginPath
* @deprecated 3.0.0 Use `CakePlugin::path()` instead.
*/
public static function pluginPath($plugin) {
return CakePlugin::path($plugin);
}
/**
* Finds the path that a theme is on. Searches through the defined theme paths.
* Finds the path that a theme is on. Searches through the defined theme paths.
*
* Usage:
*
@ -377,12 +380,12 @@ class App {
*/
public static function themePath($theme) {
$themeDir = 'Themed' . DS . Inflector::camelize($theme);
foreach (self::$_packages['View'] as $path) {
foreach (static::$_packages['View'] as $path) {
if (is_dir($path . $themeDir)) {
return $path . $themeDir . DS;
}
}
return self::$_packages['View'][0] . $themeDir . DS;
return static::$_packages['View'][0] . $themeDir . DS;
}
/**
@ -392,7 +395,7 @@ class App {
*
* `App::core('Cache/Engine'); will return the full path to the cache engines package`
*
* @param string $type
* @param string $type Package type.
* @return array full path to package
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::core
*/
@ -419,11 +422,15 @@ class App {
*
* @param string $type Type of object, i.e. 'Model', 'Controller', 'View/Helper', 'file', 'class' or 'plugin'
* @param string|array $path Optional Scan only the path given. If null, paths for the chosen type will be used.
* @param boolean $cache Set to false to rescan objects of the chosen type. Defaults to true.
* @return mixed Either false on incorrect / miss. Or an array of found objects.
* @param bool $cache Set to false to rescan objects of the chosen type. Defaults to true.
* @return mixed Either false on incorrect / miss. Or an array of found objects.
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::objects
*/
public static function objects($type, $path = null, $cache = true) {
if (empty(static::$_objects) && $cache === true) {
static::$_objects = (array)Cache::read('object_map', '_cake_core_');
}
$extension = '/\.php$/';
$includeDirectories = false;
$name = $type;
@ -432,15 +439,15 @@ class App {
$type = 'plugins';
}
if ($type == 'plugins') {
if ($type === 'plugins') {
$extension = '/.*/';
$includeDirectories = true;
}
list($plugin, $type) = pluginSplit($type);
if (isset(self::$legacy[$type . 's'])) {
$type = self::$legacy[$type . 's'];
if (isset(static::$legacy[$type . 's'])) {
$type = static::$legacy[$type . 's'];
}
if ($type === 'file' && !$path) {
@ -450,17 +457,13 @@ class App {
$name = $type . str_replace(DS, '', $path);
}
if (empty(self::$_objects) && $cache === true) {
self::$_objects = Cache::read('object_map', '_cake_core_');
}
$cacheLocation = empty($plugin) ? 'app' : $plugin;
if ($cache !== true || !isset(self::$_objects[$cacheLocation][$name])) {
if ($cache !== true || !isset(static::$_objects[$cacheLocation][$name])) {
$objects = array();
if (empty($path)) {
$path = self::path($type, $plugin);
$path = static::path($type, $plugin);
}
foreach ((array)$path as $dir) {
@ -491,13 +494,13 @@ class App {
return $objects;
}
self::$_objects[$cacheLocation][$name] = $objects;
static::$_objects[$cacheLocation][$name] = $objects;
if ($cache) {
self::$_objectCacheChange = true;
static::$_objectCacheChange = true;
}
}
return self::$_objects[$cacheLocation][$name];
return static::$_objects[$cacheLocation][$name];
}
/**
@ -516,7 +519,7 @@ class App {
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::uses
*/
public static function uses($className, $location) {
self::$_classMap[$className] = $location;
static::$_classMap[$className] = $location;
}
/**
@ -526,28 +529,32 @@ class App {
* if a class is name `MyCustomClass` the file name should be `MyCustomClass.php`
*
* @param string $className the name of the class to load
* @return boolean
* @return bool
*/
public static function load($className) {
if (!isset(self::$_classMap[$className])) {
if (!isset(static::$_classMap[$className])) {
return false;
}
if (strpos($className, '..') !== false) {
return false;
}
$parts = explode('.', self::$_classMap[$className], 2);
$parts = explode('.', static::$_classMap[$className], 2);
list($plugin, $package) = count($parts) > 1 ? $parts : array(null, current($parts));
if ($file = self::_mapped($className, $plugin)) {
$file = static::_mapped($className, $plugin);
if ($file) {
return include $file;
}
$paths = self::path($package, $plugin);
$paths = static::path($package, $plugin);
if (empty($plugin)) {
$appLibs = empty(self::$_packages['Lib']) ? APPLIBS : current(self::$_packages['Lib']);
$appLibs = empty(static::$_packages['Lib']) ? APPLIBS : current(static::$_packages['Lib']);
$paths[] = $appLibs . $package . DS;
$paths[] = APP . $package . DS;
$paths[] = CAKE . $package . DS;
} else {
$pluginPath = self::pluginPath($plugin);
$pluginPath = CakePlugin::path($plugin);
$paths[] = $pluginPath . 'Lib' . DS . $package . DS;
$paths[] = $pluginPath . $package . DS;
}
@ -556,7 +563,7 @@ class App {
foreach ($paths as $path) {
$file = $path . $normalizedClassName . '.php';
if (file_exists($file)) {
self::_map($file, $className, $plugin);
static::_map($file, $className, $plugin);
return include $file;
}
}
@ -568,33 +575,33 @@ class App {
* Returns the package name where a class was defined to be located at
*
* @param string $className name of the class to obtain the package name from
* @return string package name or null if not declared
* @return string|null Package name, or null if not declared
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::location
*/
public static function location($className) {
if (!empty(self::$_classMap[$className])) {
return self::$_classMap[$className];
if (!empty(static::$_classMap[$className])) {
return static::$_classMap[$className];
}
return null;
}
/**
* Finds classes based on $name or specific file(s) to search. Calling App::import() will
* Finds classes based on $name or specific file(s) to search. Calling App::import() will
* not construct any classes contained in the files. It will only find and require() the file.
*
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#including-files-with-app-import
* @param string|array $type The type of Class if passed as a string, or all params can be passed as
* an single array to $type,
* a single array to $type.
* @param string $name Name of the Class or a unique name for the file
* @param boolean|array $parent boolean true if Class Parent should be searched, accepts key => value
* array('parent' => $parent ,'file' => $file, 'search' => $search, 'ext' => '$ext');
* $ext allows setting the extension of the file name
* based on Inflector::underscore($name) . ".$ext";
* @param bool|array $parent boolean true if Class Parent should be searched, accepts key => value
* array('parent' => $parent, 'file' => $file, 'search' => $search, 'ext' => '$ext');
* $ext allows setting the extension of the file name
* based on Inflector::underscore($name) . ".$ext";
* @param array $search paths to search for files, array('path 1', 'path 2', 'path 3');
* @param string $file full name of the file to search for including extension
* @param boolean $return Return the loaded file, the file must have a return
* statement in it to work: return $variable;
* @return boolean true if Class is already in memory or if file is found and loaded, false if not
* @param bool $return Return the loaded file, the file must have a return
* statement in it to work: return $variable;
* @return bool true if Class is already in memory or if file is found and loaded, false if not
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#including-files-with-app-import
*/
public static function import($type = null, $name = null, $parent = true, $search = array(), $file = null, $return = false) {
$ext = null;
@ -607,7 +614,7 @@ class App {
extract($parent, EXTR_OVERWRITE);
}
if ($name == null && $file == null) {
if (!$name && !$file) {
return false;
}
@ -622,8 +629,8 @@ class App {
$originalType = strtolower($type);
$specialPackage = in_array($originalType, array('file', 'vendor'));
if (!$specialPackage && isset(self::$legacy[$originalType . 's'])) {
$type = self::$legacy[$originalType . 's'];
if (!$specialPackage && isset(static::$legacy[$originalType . 's'])) {
$type = static::$legacy[$originalType . 's'];
}
list($plugin, $name) = pluginSplit($name);
if (!empty($plugin)) {
@ -633,15 +640,15 @@ class App {
}
if (!$specialPackage) {
return self::_loadClass($name, $plugin, $type, $originalType, $parent);
return static::_loadClass($name, $plugin, $type, $originalType, $parent);
}
if ($originalType == 'file' && !empty($file)) {
return self::_loadFile($name, $plugin, $search, $file, $return);
if ($originalType === 'file' && !empty($file)) {
return static::_loadFile($name, $plugin, $search, $file, $return);
}
if ($originalType == 'vendor') {
return self::_loadVendor($name, $plugin, $file, $ext);
if ($originalType === 'vendor') {
return static::_loadVendor($name, $plugin, $file, $ext);
}
return false;
@ -655,18 +662,18 @@ class App {
* @param string $plugin camel cased plugin name if any
* @param string $type name of the packed where the class is located
* @param string $originalType type name as supplied initially by the user
* @param boolean $parent whether to load the class parent or not
* @return boolean true indicating the successful load and existence of the class
* @param bool $parent whether to load the class parent or not
* @return bool true indicating the successful load and existence of the class
*/
protected static function _loadClass($name, $plugin, $type, $originalType, $parent) {
if ($type == 'Console/Command' && $name == 'Shell') {
if ($type === 'Console/Command' && $name === 'Shell') {
$type = 'Console';
} elseif (isset(self::$types[$originalType]['suffix'])) {
$suffix = self::$types[$originalType]['suffix'];
$name .= ($suffix == $name) ? '' : $suffix;
} elseif (isset(static::$types[$originalType]['suffix'])) {
$suffix = static::$types[$originalType]['suffix'];
$name .= ($suffix === $name) ? '' : $suffix;
}
if ($parent && isset(self::$types[$originalType]['extends'])) {
$extends = self::$types[$originalType]['extends'];
if ($parent && isset(static::$types[$originalType]['extends'])) {
$extends = static::$types[$originalType]['extends'];
$extendType = $type;
if (strpos($extends, '/') !== false) {
$parts = explode('/', $extends);
@ -693,11 +700,11 @@ class App {
* @param string $plugin camel cased plugin name if any
* @param array $search list of paths to search the file into
* @param string $file filename if known, the $name param will be used otherwise
* @param boolean $return whether this function should return the contents of the file after being parsed by php or just a success notice
* @param bool $return whether this function should return the contents of the file after being parsed by php or just a success notice
* @return mixed if $return contents of the file after php parses it, boolean indicating success otherwise
*/
protected static function _loadFile($name, $plugin, $search, $file, $return) {
$mapped = self::_mapped($name, $plugin);
$mapped = static::_mapped($name, $plugin);
if ($mapped) {
$file = $mapped;
} elseif (!empty($search)) {
@ -714,7 +721,7 @@ class App {
}
}
if (!empty($file) && file_exists($file)) {
self::_map($file, $name, $plugin);
static::_map($file, $name, $plugin);
$returnValue = include $file;
if ($return) {
return $returnValue;
@ -731,10 +738,10 @@ class App {
* @param string $plugin camel cased plugin name if any
* @param string $file file name if known
* @param string $ext file extension if known
* @return boolean true if the file was loaded successfully, false otherwise
* @return bool true if the file was loaded successfully, false otherwise
*/
protected static function _loadVendor($name, $plugin, $file, $ext) {
if ($mapped = self::_mapped($name, $plugin)) {
if ($mapped = static::_mapped($name, $plugin)) {
return (bool)include_once $mapped;
}
$fileTries = array();
@ -752,7 +759,7 @@ class App {
foreach ($fileTries as $file) {
foreach ($paths as $path) {
if (file_exists($path . $file)) {
self::_map($path . $file, $name, $plugin);
static::_map($path . $file, $name, $plugin);
return (bool)include $path . $file;
}
}
@ -766,8 +773,7 @@ class App {
* @return void
*/
public static function init() {
self::$_map += (array)Cache::read('file_map', '_cake_core_');
self::$_objects += (array)Cache::read('object_map', '_cake_core_');
static::$_map += (array)Cache::read('file_map', '_cake_core_');
register_shutdown_function(array('App', 'shutdown'));
}
@ -784,14 +790,14 @@ class App {
if ($plugin) {
$key = 'plugin.' . $name;
}
if ($plugin && empty(self::$_map[$name])) {
self::$_map[$key] = $file;
if ($plugin && empty(static::$_map[$name])) {
static::$_map[$key] = $file;
}
if (!$plugin && empty(self::$_map['plugin.' . $name])) {
self::$_map[$key] = $file;
if (!$plugin && empty(static::$_map['plugin.' . $name])) {
static::$_map[$key] = $file;
}
if (!self::$bootstrapping) {
self::$_cacheChange = true;
if (!static::$bootstrapping) {
static::$_cacheChange = true;
}
}
@ -807,7 +813,7 @@ class App {
if ($plugin) {
$key = 'plugin.' . $name;
}
return isset(self::$_map[$key]) ? self::$_map[$key] : false;
return isset(static::$_map[$key]) ? static::$_map[$key] : false;
}
/**
@ -816,8 +822,8 @@ class App {
* @return array templates for each customizable package path
*/
protected static function _packageFormat() {
if (empty(self::$_packageFormat)) {
self::$_packageFormat = array(
if (empty(static::$_packageFormat)) {
static::$_packageFormat = array(
'Model' => array(
'%s' . 'Model' . DS
),
@ -868,16 +874,47 @@ class App {
),
'Vendor' => array(
'%s' . 'Vendor' . DS,
dirname(dirname(CAKE)) . DS . 'vendors' . DS,
ROOT . DS . 'vendors' . DS,
dirname(dirname(CAKE)) . DS . 'vendors' . DS
),
'Plugin' => array(
APP . 'Plugin' . DS,
ROOT . DS . 'plugins' . DS,
dirname(dirname(CAKE)) . DS . 'plugins' . DS
)
);
}
return self::$_packageFormat;
return static::$_packageFormat;
}
/**
* Increases the PHP "memory_limit" ini setting by the specified amount
* in kilobytes
*
* @param string $additionalKb Number in kilobytes
* @return void
*/
public static function increaseMemoryLimit($additionalKb) {
$limit = ini_get("memory_limit");
if (!is_string($limit) || !strlen($limit)) {
return;
}
$limit = trim($limit);
$units = strtoupper(substr($limit, -1));
$current = substr($limit, 0, strlen($limit) - 1);
if ($units === "M") {
$current = $current * 1024;
$units = "K";
}
if ($units === "G") {
$current = $current * 1024 * 1024;
$units = "K";
}
if ($units === "K") {
ini_set("memory_limit", ceil($current + $additionalKb) . "K");
}
}
/**
@ -889,14 +926,21 @@ class App {
* @return void
*/
public static function shutdown() {
if (self::$_cacheChange) {
Cache::write('file_map', array_filter(self::$_map), '_cake_core_');
$megabytes = Configure::read('Error.extraFatalErrorMemory');
if ($megabytes === null) {
$megabytes = 4;
}
if (self::$_objectCacheChange) {
Cache::write('object_map', self::$_objects, '_cake_core_');
if ($megabytes !== false && $megabytes > 0) {
static::increaseMemoryLimit($megabytes * 1024);
}
self::_checkFatalError();
if (static::$_cacheChange) {
Cache::write('file_map', array_filter(static::$_map), '_cake_core_');
}
if (static::$_objectCacheChange) {
Cache::write('object_map', static::$_objects, '_cake_core_');
}
static::_checkFatalError();
}
/**

View file

@ -0,0 +1,212 @@
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package Cake.Core
* @since CakePHP(tm) v 0.2.9
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
App::uses('CakeLog', 'Log');
App::uses('Dispatcher', 'Routing');
App::uses('Router', 'Routing');
App::uses('Set', 'Utility');
/**
* CakeObject class provides a few generic methods used in several subclasses.
*
* Also includes methods for logging and the special method RequestAction,
* to call other Controllers' Actions from anywhere.
*
* @package Cake.Core
*/
class CakeObject {
/**
* Constructor, no-op
*/
public function __construct() {
}
/**
* CakeObject-to-string conversion.
* Each class can override this method as necessary.
*
* @return string The name of this class
*/
public function toString() {
$class = get_class($this);
return $class;
}
/**
* Calls a controller's method from any location. Can be used to connect controllers together
* or tie plugins into a main application. requestAction can be used to return rendered views
* or fetch the return value from controller actions.
*
* Under the hood this method uses Router::reverse() to convert the $url parameter into a string
* URL. You should use URL formats that are compatible with Router::reverse()
*
* #### Passing POST and GET data
*
* POST and GET data can be simulated in requestAction. Use `$extra['url']` for
* GET data. The `$extra['data']` parameter allows POST data simulation.
*
* @param string|array $url String or array-based URL. Unlike other URL arrays in CakePHP, this
* URL will not automatically handle passed and named arguments in the $url parameter.
* @param array $extra if array includes the key "return" it sets the AutoRender to true. Can
* also be used to submit GET/POST data, and named/passed arguments.
* @return mixed Boolean true or false on success/failure, or contents
* of rendered action if 'return' is set in $extra.
*/
public function requestAction($url, $extra = array()) {
if (empty($url)) {
return false;
}
if (($index = array_search('return', $extra)) !== false) {
$extra['return'] = 0;
$extra['autoRender'] = 1;
unset($extra[$index]);
}
$arrayUrl = is_array($url);
if ($arrayUrl && !isset($extra['url'])) {
$extra['url'] = array();
}
if ($arrayUrl && !isset($extra['data'])) {
$extra['data'] = array();
}
$extra += array('autoRender' => 0, 'return' => 1, 'bare' => 1, 'requested' => 1);
$data = isset($extra['data']) ? $extra['data'] : null;
unset($extra['data']);
if (is_string($url) && strpos($url, Router::fullBaseUrl()) === 0) {
$url = Router::normalize(str_replace(Router::fullBaseUrl(), '', $url));
}
if (is_string($url)) {
$request = new CakeRequest($url);
} elseif (is_array($url)) {
$params = $url + array('pass' => array(), 'named' => array(), 'base' => false);
$params = $extra + $params;
$request = new CakeRequest(Router::reverse($params));
}
if (isset($data)) {
$request->data = $data;
}
$dispatcher = new Dispatcher();
$result = $dispatcher->dispatch($request, new CakeResponse(), $extra);
Router::popRequest();
return $result;
}
/**
* Calls a method on this object with the given parameters. Provides an OO wrapper
* for `call_user_func_array`
*
* @param string $method Name of the method to call
* @param array $params Parameter list to use when calling $method
* @return mixed Returns the result of the method call
*/
public function dispatchMethod($method, $params = array()) {
switch (count($params)) {
case 0:
return $this->{$method}();
case 1:
return $this->{$method}($params[0]);
case 2:
return $this->{$method}($params[0], $params[1]);
case 3:
return $this->{$method}($params[0], $params[1], $params[2]);
case 4:
return $this->{$method}($params[0], $params[1], $params[2], $params[3]);
case 5:
return $this->{$method}($params[0], $params[1], $params[2], $params[3], $params[4]);
default:
return call_user_func_array(array(&$this, $method), $params);
}
}
/**
* Stop execution of the current script. Wraps exit() making
* testing easier.
*
* @param int|string $status see http://php.net/exit for values
* @return void
*/
protected function _stop($status = 0) {
exit($status);
}
/**
* Convenience method to write a message to CakeLog. See CakeLog::write()
* for more information on writing to logs.
*
* @param string $msg Log message
* @param int $type Error type constant. Defined in app/Config/core.php.
* @param null|string|array $scope The scope(s) a log message is being created in.
* See CakeLog::config() for more information on logging scopes.
* @return bool Success of log write
*/
public function log($msg, $type = LOG_ERR, $scope = null) {
if (!is_string($msg)) {
$msg = print_r($msg, true);
}
return CakeLog::write($type, $msg, $scope);
}
/**
* Allows setting of multiple properties of the object in a single line of code. Will only set
* properties that are part of a class declaration.
*
* @param array $properties An associative array containing properties and corresponding values.
* @return void
*/
protected function _set($properties = array()) {
if (is_array($properties) && !empty($properties)) {
$vars = get_object_vars($this);
foreach ($properties as $key => $val) {
if (array_key_exists($key, $vars)) {
$this->{$key} = $val;
}
}
}
}
/**
* Merges this objects $property with the property in $class' definition.
* This classes value for the property will be merged on top of $class'
*
* This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine
* this method as an empty function.
*
* @param array $properties The name of the properties to merge.
* @param string $class The class to merge the property with.
* @param bool $normalize Set to true to run the properties through Hash::normalize() before merging.
* @return void
*/
protected function _mergeVars($properties, $class, $normalize = true) {
$classProperties = get_class_vars($class);
foreach ($properties as $var) {
if (isset($classProperties[$var]) &&
!empty($classProperties[$var]) &&
is_array($this->{$var}) &&
$this->{$var} != $classProperties[$var]
) {
if ($normalize) {
$classProperties[$var] = Hash::normalize($classProperties[$var]);
$this->{$var} = Hash::normalize($this->{$var});
}
$this->{$var} = Hash::merge($classProperties[$var], $this->{$var});
}
}
}
}

View file

@ -2,19 +2,18 @@
/**
* CakePlugin class
*
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package Cake.Core
* @since CakePHP(tm) v 2.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
/**
@ -34,32 +33,54 @@ class CakePlugin {
protected static $_plugins = array();
/**
* Loads a plugin and optionally loads bootstrapping, routing files or loads a initialization function
* Loads a plugin and optionally loads bootstrapping, routing files or loads an initialization function
*
* Examples:
*
* `CakePlugin::load('DebugKit')` will load the DebugKit plugin and will not load any bootstrap nor route files
* `CakePlugin::load('DebugKit', array('bootstrap' => true, 'routes' => true))` will load the bootstrap.php and routes.php files
* `CakePlugin::load('DebugKit', array('bootstrap' => false, 'routes' => true))` will load routes.php file but not bootstrap.php
* `CakePlugin::load('DebugKit', array('bootstrap' => array('config1', 'config2')))` will load config1.php and config2.php files
* `CakePlugin::load('DebugKit', array('bootstrap' => 'aCallableMethod'))` will run the aCallableMethod function to initialize it
* `CakePlugin::load('DebugKit')`
*
* Bootstrap initialization functions can be expressed as a PHP callback type, including closures. Callbacks will receive two
* parameters (plugin name, plugin configuration)
* Will load the DebugKit plugin and will not load any bootstrap nor route files
*
* `CakePlugin::load('DebugKit', array('bootstrap' => true, 'routes' => true))`
*
* will load the bootstrap.php and routes.php files
*
* `CakePlugin::load('DebugKit', array('bootstrap' => false, 'routes' => true))`
*
* will load routes.php file but not bootstrap.php
*
* `CakePlugin::load('DebugKit', array('bootstrap' => array('config1', 'config2')))`
*
* will load config1.php and config2.php files
*
* `CakePlugin::load('DebugKit', array('bootstrap' => 'aCallableMethod'))`
*
* will run the aCallableMethod function to initialize it
*
* Bootstrap initialization functions can be expressed as a PHP callback type,
* including closures. Callbacks will receive two parameters
* (plugin name, plugin configuration)
*
* It is also possible to load multiple plugins at once. Examples:
*
* `CakePlugin::load(array('DebugKit', 'ApiGenerator'))` will load the DebugKit and ApiGenerator plugins
* `CakePlugin::load(array('DebugKit', 'ApiGenerator'), array('bootstrap' => true))` will load bootstrap file for both plugins
* `CakePlugin::load(array('DebugKit', 'ApiGenerator'))`
*
* {{{
* will load the DebugKit and ApiGenerator plugins
*
* `CakePlugin::load(array('DebugKit', 'ApiGenerator'), array('bootstrap' => true))`
*
* will load bootstrap file for both plugins
*
* ```
* CakePlugin::load(array(
* 'DebugKit' => array('routes' => true),
* 'ApiGenerator'
* ), array('bootstrap' => true))
* }}}
* ```
*
* Will only load the bootstrap for ApiGenerator and only the routes for DebugKit
* Will only load the bootstrap for ApiGenerator and only the routes for DebugKit.
* By using the `path` option you can specify an absolute path to the plugin. Make
* sure that the path is slash terminated or your plugin will not be located properly.
*
* @param string|array $plugin name of the plugin to be loaded in CamelCase format or array or plugins to load
* @param array $config configuration options for the plugin
@ -70,34 +91,34 @@ class CakePlugin {
if (is_array($plugin)) {
foreach ($plugin as $name => $conf) {
list($name, $conf) = (is_numeric($name)) ? array($conf, $config) : array($name, $conf);
self::load($name, $conf);
static::load($name, $conf);
}
return;
}
$config += array('bootstrap' => false, 'routes' => false);
$config += array('bootstrap' => false, 'routes' => false, 'ignoreMissing' => false);
if (empty($config['path'])) {
foreach (App::path('plugins') as $path) {
if (is_dir($path . $plugin)) {
self::$_plugins[$plugin] = $config + array('path' => $path . $plugin . DS);
static::$_plugins[$plugin] = $config + array('path' => $path . $plugin . DS);
break;
}
//Backwards compatibility to make easier to migrate to 2.0
$underscored = Inflector::underscore($plugin);
if (is_dir($path . $underscored)) {
self::$_plugins[$plugin] = $config + array('path' => $path . $underscored . DS);
static::$_plugins[$plugin] = $config + array('path' => $path . $underscored . DS);
break;
}
}
} else {
self::$_plugins[$plugin] = $config;
static::$_plugins[$plugin] = $config;
}
if (empty(self::$_plugins[$plugin]['path'])) {
if (empty(static::$_plugins[$plugin]['path'])) {
throw new MissingPluginException(array('plugin' => $plugin));
}
if (!empty(self::$_plugins[$plugin]['bootstrap'])) {
self::bootstrap($plugin);
if (!empty(static::$_plugins[$plugin]['bootstrap'])) {
static::bootstrap($plugin);
}
}
@ -106,27 +127,40 @@ class CakePlugin {
* If passed an options array, it will be used as a common default for all plugins to be loaded
* It is possible to set specific defaults for each plugins in the options array. Examples:
*
* {{{
* ```
* CakePlugin::loadAll(array(
* array('bootstrap' => true),
* 'DebugKit' => array('routes' => true),
* array('bootstrap' => true),
* 'DebugKit' => array('routes' => true, 'bootstrap' => false),
* ))
* }}}
* ```
*
* The above example will load the bootstrap file for all plugins, but for DebugKit it will only load the routes file
* and will not look for any bootstrap script.
* The above example will load the bootstrap file for all plugins, but for DebugKit it will only load
* the routes file and will not look for any bootstrap script. If you are loading
* many plugins that inconsistently support routes/bootstrap files, instead of detailing
* each plugin you can use the `ignoreMissing` option:
*
* @param array $options
* ```
* CakePlugin::loadAll(array(
* 'ignoreMissing' => true,
* 'bootstrap' => true,
* 'routes' => true,
* ));
* ```
*
* The ignoreMissing option will do additional file_exists() calls but is simpler
* to use.
*
* @param array $options Options list. See CakePlugin::load() for valid options.
* @return void
*/
public static function loadAll($options = array()) {
$plugins = App::objects('plugins');
foreach ($plugins as $p) {
$opts = isset($options[$p]) ? $options[$p] : null;
if ($opts === null && isset($options[0])) {
$opts = $options[0];
$opts = isset($options[$p]) ? (array)$options[$p] : array();
if (isset($options[0])) {
$opts += $options[0];
}
self::load($p, (array)$opts);
static::load($p, $opts);
}
}
@ -138,10 +172,10 @@ class CakePlugin {
* @throws MissingPluginException if the folder for plugin was not found or plugin has not been loaded
*/
public static function path($plugin) {
if (empty(self::$_plugins[$plugin])) {
if (empty(static::$_plugins[$plugin])) {
throw new MissingPluginException(array('plugin' => $plugin));
}
return self::$_plugins[$plugin]['path'];
return static::$_plugins[$plugin]['path'];
}
/**
@ -152,7 +186,7 @@ class CakePlugin {
* @see CakePlugin::load() for examples of bootstrap configuration
*/
public static function bootstrap($plugin) {
$config = self::$_plugins[$plugin];
$config = static::$_plugins[$plugin];
if ($config['bootstrap'] === false) {
return false;
}
@ -160,14 +194,20 @@ class CakePlugin {
return call_user_func_array($config['bootstrap'], array($plugin, $config));
}
$path = self::path($plugin);
$path = static::path($plugin);
if ($config['bootstrap'] === true) {
return include $path . 'Config' . DS . 'bootstrap.php';
return static::_includeFile(
$path . 'Config' . DS . 'bootstrap.php',
$config['ignoreMissing']
);
}
$bootstrap = (array)$config['bootstrap'];
foreach ($bootstrap as $file) {
include $path . 'Config' . DS . $file . '.php';
static::_includeFile(
$path . 'Config' . DS . $file . '.php',
$config['ignoreMissing']
);
}
return true;
@ -178,35 +218,38 @@ class CakePlugin {
*
* @param string $plugin name of the plugin, if null will operate on all plugins having enabled the
* loading of routes files
* @return boolean
* @return bool
*/
public static function routes($plugin = null) {
if ($plugin === null) {
foreach (self::loaded() as $p) {
self::routes($p);
foreach (static::loaded() as $p) {
static::routes($p);
}
return true;
}
$config = self::$_plugins[$plugin];
$config = static::$_plugins[$plugin];
if ($config['routes'] === false) {
return false;
}
return (bool)include self::path($plugin) . 'Config' . DS . 'routes.php';
return (bool)static::_includeFile(
static::path($plugin) . 'Config' . DS . 'routes.php',
$config['ignoreMissing']
);
}
/**
* Returns true if the plugin $plugin is already loaded
* If plugin is null, it will return a list of all loaded plugins
*
* @param string $plugin
* @param string $plugin Plugin name to check.
* @return mixed boolean true if $plugin is already loaded.
* If $plugin is null, returns a list of plugins that have been loaded
*/
public static function loaded($plugin = null) {
if ($plugin) {
return isset(self::$_plugins[$plugin]);
return isset(static::$_plugins[$plugin]);
}
$return = array_keys(self::$_plugins);
$return = array_keys(static::$_plugins);
sort($return);
return $return;
}
@ -218,11 +261,25 @@ class CakePlugin {
* @return void
*/
public static function unload($plugin = null) {
if (is_null($plugin)) {
self::$_plugins = array();
if ($plugin === null) {
static::$_plugins = array();
} else {
unset(self::$_plugins[$plugin]);
unset(static::$_plugins[$plugin]);
}
}
/**
* Include file, ignoring include error if needed if file is missing
*
* @param string $file File to include
* @param bool $ignoreMissing Whether to ignore include error for missing files
* @return mixed
*/
protected static function _includeFile($file, $ignoreMissing = false) {
if ($ignoreMissing && !is_file($file)) {
return false;
}
return include $file;
}
}

View file

@ -1,20 +1,22 @@
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package Cake.Core
* @since CakePHP(tm) v 1.0.0.2363
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
App::uses('Hash', 'Utility');
App::uses('ConfigReaderInterface', 'Configure');
/**
* Compatibility with 2.1, which expects Configure to load Set.
*/
@ -60,24 +62,22 @@ class Configure {
* - Include app/Config/bootstrap.php.
* - Setup error/exception handlers.
*
* @param boolean $boot
* @param bool $boot Whether to do bootstrapping.
* @return void
*/
public static function bootstrap($boot = true) {
if ($boot) {
self::write('App', array(
'base' => false,
'baseUrl' => false,
'dir' => APP_DIR,
'webroot' => WEBROOT_DIR,
'www_root' => WWW_ROOT
));
static::_appDefaults();
if (!include APP . 'Config' . DS . 'core.php') {
trigger_error(__d('cake_dev', "Can't find application core file. Please create %score.php, and make sure it is readable by PHP.", APP . 'Config' . DS), E_USER_ERROR);
trigger_error(__d('cake_dev',
"Can't find application core file. Please create %s, and make sure it is readable by PHP.",
APP . 'Config' . DS . 'core.php'),
E_USER_ERROR
);
}
App::$bootstrapping = false;
App::init();
App::$bootstrapping = false;
App::build();
$exception = array(
@ -87,31 +87,56 @@ class Configure {
'handler' => 'ErrorHandler::handleError',
'level' => E_ALL & ~E_DEPRECATED,
);
self::_setErrorHandlers($error, $exception);
if (PHP_SAPI === 'cli') {
App::uses('ConsoleErrorHandler', 'Console');
$console = new ConsoleErrorHandler();
$exception['handler'] = array($console, 'handleException');
$error['handler'] = array($console, 'handleError');
}
static::_setErrorHandlers($error, $exception);
if (!include APP . 'Config' . DS . 'bootstrap.php') {
trigger_error(__d('cake_dev', "Can't find application bootstrap file. Please create %sbootstrap.php, and make sure it is readable by PHP.", APP . 'Config' . DS), E_USER_ERROR);
trigger_error(__d('cake_dev',
"Can't find application bootstrap file. Please create %s, and make sure it is readable by PHP.",
APP . 'Config' . DS . 'bootstrap.php'),
E_USER_ERROR
);
}
restore_error_handler();
self::_setErrorHandlers(
self::$_values['Error'],
self::$_values['Exception']
static::_setErrorHandlers(
static::$_values['Error'],
static::$_values['Exception']
);
// Preload Debugger + String in case of E_STRICT errors when loading files.
if (self::$_values['debug'] > 0) {
// Preload Debugger + CakeText in case of E_STRICT errors when loading files.
if (static::$_values['debug'] > 0) {
class_exists('Debugger');
class_exists('String');
class_exists('CakeText');
}
}
}
/**
* Set app's default configs
*
* @return void
*/
protected static function _appDefaults() {
static::write('App', (array)static::read('App') + array(
'base' => false,
'baseUrl' => false,
'dir' => APP_DIR,
'webroot' => WEBROOT_DIR,
'www_root' => WWW_ROOT
));
}
/**
* Used to store a dynamic variable in Configure.
*
* 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(
@ -123,12 +148,13 @@ class Configure {
* 'One.key1' => 'value of the Configure::One[key1]',
* 'One.key2' => 'value of the Configure::One[key2]'
* ));
* }}}
* ```
*
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::write
* @param array $config Name of var to write
* @param string|array $config The key to write, can be a dot notation value.
* Alternatively can be an array containing key(s) and value(s).
* @param mixed $value Value to set for var
* @return boolean True if write was successful
* @return bool True if write was successful
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::write
*/
public static function write($config, $value = null) {
if (!is_array($config)) {
@ -136,11 +162,11 @@ class Configure {
}
foreach ($config as $name => $value) {
self::$_values = Hash::insert(self::$_values, $name, $value);
static::$_values = Hash::insert(static::$_values, $name, $value);
}
if (isset($config['debug']) && function_exists('ini_set')) {
if (self::$_values['debug']) {
if (static::$_values['debug']) {
ini_set('display_errors', 1);
} else {
ini_set('display_errors', 0);
@ -150,92 +176,128 @@ class Configure {
}
/**
* Used to read information stored in Configure. Its not
* Used to read information stored in Configure. It's not
* possible to store `null` values in Configure.
*
* Usage:
* {{{
* ```
* Configure::read('Name'); will return all values for Name
* Configure::read('Name.key'); will return only the value of Configure::Name[key]
* }}}
* ```
*
* @linkhttp://book.cakephp.org/2.0/en/development/configuration.html#Configure::read
* @param string $var Variable to obtain. Use '.' to access array elements.
* @param string|null $var Variable to obtain. Use '.' to access array elements.
* @return mixed value stored in configure, or null.
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::read
*/
public static function read($var = null) {
if ($var === null) {
return self::$_values;
return static::$_values;
}
return Hash::get(self::$_values, $var);
return Hash::get(static::$_values, $var);
}
/**
* Used to read and delete a variable from Configure.
*
* This is primarily used during bootstrapping to move configuration data
* out of configure into the various other classes in CakePHP.
*
* @param string $var The key to read and remove.
* @return array|null
*/
public static function consume($var) {
$simple = strpos($var, '.') === false;
if ($simple && !isset(static::$_values[$var])) {
return null;
}
if ($simple) {
$value = static::$_values[$var];
unset(static::$_values[$var]);
return $value;
}
$value = Hash::get(static::$_values, $var);
static::$_values = Hash::remove(static::$_values, $var);
return $value;
}
/**
* Returns true if given variable is set in Configure.
*
* @param string $var Variable name to check for
* @return bool True if variable is there
*/
public static function check($var) {
if (empty($var)) {
return false;
}
return Hash::get(static::$_values, $var) !== null;
}
/**
* Used to delete a variable from Configure.
*
* Usage:
* {{{
* ```
* Configure::delete('Name'); will delete the entire Configure::Name
* Configure::delete('Name.key'); will delete only the Configure::Name[key]
* }}}
* ```
*
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::delete
* @param string $var the var to be deleted
* @return void
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::delete
*/
public static function delete($var = null) {
$keys = explode('.', $var);
self::$_values = Hash::remove(self::$_values, $var);
public static function delete($var) {
static::$_values = Hash::remove(static::$_values, $var);
}
/**
* Add a new reader to Configure. Readers allow you to read configuration
* files in various formats/storage locations. CakePHP comes with two built-in readers
* PhpReader and IniReader. You can also implement your own reader classes in your application.
* Add a new reader to Configure. Readers allow you to read configuration
* files in various formats/storage locations. CakePHP comes with two built-in readers
* PhpReader and IniReader. You can also implement your own reader classes in your application.
*
* To add a new reader to Configure:
*
* `Configure::config('ini', new IniReader());`
*
* @param string $name The name of the reader being configured. This alias is used later to
* @param string $name The name of the reader being configured. This alias is used later to
* read values from a specific reader.
* @param ConfigReaderInterface $reader The reader to append.
* @return void
*/
public static function config($name, ConfigReaderInterface $reader) {
self::$_readers[$name] = $reader;
static::$_readers[$name] = $reader;
}
/**
* Gets the names of the configured reader objects.
*
* @param string $name
* @param string|null $name Name to check. If null returns all configured reader names.
* @return array Array of the configured reader objects.
*/
public static function configured($name = null) {
if ($name) {
return isset(self::$_readers[$name]);
return isset(static::$_readers[$name]);
}
return array_keys(self::$_readers);
return array_keys(static::$_readers);
}
/**
* Remove a configured reader. This will unset the reader
* Remove a configured reader. This will unset the reader
* and make any future attempts to use it cause an Exception.
*
* @param string $name Name of the reader to drop.
* @return boolean Success
* @return bool Success
*/
public static function drop($name) {
if (!isset(self::$_readers[$name])) {
if (!isset(static::$_readers[$name])) {
return false;
}
unset(self::$_readers[$name]);
unset(static::$_readers[$name]);
return true;
}
/**
* Loads stored configuration information from a resource. You can add
* Loads stored configuration information from a resource. You can add
* config file resource readers with `Configure::config()`.
*
* Loaded configuration information will be merged with the current
@ -244,7 +306,7 @@ class Configure {
*
* `Configure::load('Users.user', 'default')`
*
* Would load the 'user' config file using the default config reader. You can load
* Would load the 'user' config file using the default config reader. You can load
* app config files by giving the name of the resource you want loaded.
*
* `Configure::load('setup', 'default');`
@ -252,15 +314,15 @@ class Configure {
* If using `default` config and no reader has been configured for it yet,
* one will be automatically created using PhpReader
*
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::load
* @param string $key name of configuration resource to load.
* @param string $config Name of the configured reader to use to read the resource identified by $key.
* @param boolean $merge if config files should be merged instead of simply overridden
* @return mixed false if file not found, void if load successful.
* @param bool $merge if config files should be merged instead of simply overridden
* @return bool False if file not found, true if load successful.
* @throws ConfigureException Will throw any exceptions the reader raises.
* @link http://book.cakephp.org/2.0/en/development/configuration.html#Configure::load
*/
public static function load($key, $config = 'default', $merge = true) {
$reader = self::_getReader($config);
$reader = static::_getReader($config);
if (!$reader) {
return false;
}
@ -269,18 +331,18 @@ class Configure {
if ($merge) {
$keys = array_keys($values);
foreach ($keys as $key) {
if (($c = self::read($key)) && is_array($values[$key]) && is_array($c)) {
if (($c = static::read($key)) && is_array($values[$key]) && is_array($c)) {
$values[$key] = Hash::merge($c, $values[$key]);
}
}
}
return self::write($values);
return static::write($values);
}
/**
* Dump data currently in Configure into $filename. The serialization format
* is decided by the config reader attached as $config. For example, if the
* Dump data currently in Configure into $key. The serialization format
* is decided by the config reader attached as $config. For example, if the
* 'default' adapter is a PhpReader, the generated file will be a PHP
* configuration file loadable by the PhpReader.
*
@ -300,18 +362,18 @@ class Configure {
* @param string $config The name of the configured adapter to dump data with.
* @param array $keys The name of the top-level keys you want to dump.
* This allows you save only some data stored in Configure.
* @return boolean success
* @return bool success
* @throws ConfigureException if the adapter does not implement a `dump` method.
*/
public static function dump($key, $config = 'default', $keys = array()) {
$reader = self::_getReader($config);
$reader = static::_getReader($config);
if (!$reader) {
throw new ConfigureException(__d('cake', 'There is no "%s" adapter.', $config));
throw new ConfigureException(__d('cake_dev', 'There is no "%s" adapter.', $config));
}
if (!method_exists($reader, 'dump')) {
throw new ConfigureException(__d('cake', 'The "%s" adapter, does not have a dump() method.', $config));
throw new ConfigureException(__d('cake_dev', 'The "%s" adapter, does not have a %s method.', $config, 'dump()'));
}
$values = self::$_values;
$values = static::$_values;
if (!empty($keys) && is_array($keys)) {
$values = array_intersect_key($values, array_flip($keys));
}
@ -326,14 +388,14 @@ class Configure {
* @return mixed Reader instance or false
*/
protected static function _getReader($config) {
if (!isset(self::$_readers[$config])) {
if (!isset(static::$_readers[$config])) {
if ($config !== 'default') {
return false;
}
App::uses('PhpReader', 'Configure');
self::config($config, new PhpReader());
static::config($config, new PhpReader());
}
return self::$_readers[$config];
return static::$_readers[$config];
}
/**
@ -344,42 +406,42 @@ class Configure {
* @return string Current version of CakePHP
*/
public static function version() {
if (!isset(self::$_values['Cake']['version'])) {
if (!isset(static::$_values['Cake']['version'])) {
require CAKE . 'Config' . DS . 'config.php';
self::write($config);
static::write($config);
}
return self::$_values['Cake']['version'];
return static::$_values['Cake']['version'];
}
/**
* Used to write runtime configuration into Cache. Stored runtime configuration can be
* restored using `Configure::restore()`. These methods can be used to enable configuration managers
* Used to write runtime configuration into Cache. Stored runtime configuration can be
* restored using `Configure::restore()`. These methods can be used to enable configuration managers
* frontends, or other GUI type interfaces for configuration.
*
* @param string $name The storage name for the saved configuration.
* @param string $cacheConfig The cache configuration to save into. Defaults to 'default'
* @param string $cacheConfig The cache configuration to save into. Defaults to 'default'
* @param array $data Either an array of data to store, or leave empty to store all values.
* @return boolean Success
* @return bool Success
*/
public static function store($name, $cacheConfig = 'default', $data = null) {
if ($data === null) {
$data = self::$_values;
$data = static::$_values;
}
return Cache::write($name, $data, $cacheConfig);
}
/**
* Restores configuration data stored in the Cache into configure. Restored
* Restores configuration data stored in the Cache into configure. Restored
* values will overwrite existing ones.
*
* @param string $name Name of the stored config file to load.
* @param string $cacheConfig Name of the Cache configuration to read from.
* @return boolean Success.
* @return bool Success.
*/
public static function restore($name, $cacheConfig = 'default') {
$values = Cache::read($name, $cacheConfig);
if ($values) {
return self::write($values);
return static::write($values);
}
return false;
}
@ -387,12 +449,13 @@ class Configure {
/**
* Clear all values stored in Configure.
*
* @return boolean success.
* @return bool Success.
*/
public static function clear() {
self::$_values = array();
static::$_values = array();
return true;
}
/**
* Set the error and exception handlers.
*
@ -413,4 +476,5 @@ class Configure {
set_exception_handler($exception['handler']);
}
}
}

View file

@ -1,209 +1,18 @@
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package Cake.Core
* @since CakePHP(tm) v 0.2.9
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
App::uses('Set', 'Utility');
/**
* Object class provides a few generic methods used in several subclasses.
*
* Also includes methods for logging and the special method RequestAction,
* to call other Controllers' Actions from anywhere.
*
* @package Cake.Core
*/
class Object {
/**
* constructor, no-op
*
*/
public function __construct() {
}
/**
* Object-to-string conversion.
* Each class can override this method as necessary.
*
* @return string The name of this class
*/
public function toString() {
$class = get_class($this);
return $class;
}
/**
* Calls a controller's method from any location. Can be used to connect controllers together
* or tie plugins into a main application. requestAction can be used to return rendered views
* or fetch the return value from controller actions.
*
* Under the hood this method uses Router::reverse() to convert the $url parameter into a string
* URL. You should use URL formats that are compatible with Router::reverse()
*
* #### Passing POST and GET data
*
* POST and GET data can be simulated in requestAction. Use `$extra['url']` for
* GET data. The `$extra['data']` parameter allows POST data simulation.
*
* @param string|array $url String or array-based url. Unlike other url arrays in CakePHP, this
* url will not automatically handle passed and named arguments in the $url parameter.
* @param array $extra if array includes the key "return" it sets the AutoRender to true. Can
* also be used to submit GET/POST data, and named/passed arguments.
* @return mixed Boolean true or false on success/failure, or contents
* of rendered action if 'return' is set in $extra.
*/
public function requestAction($url, $extra = array()) {
if (empty($url)) {
return false;
}
App::uses('Dispatcher', 'Routing');
if (($index = array_search('return', $extra)) !== false) {
$extra['return'] = 0;
$extra['autoRender'] = 1;
unset($extra[$index]);
}
$arrayUrl = is_array($url);
if ($arrayUrl && !isset($extra['url'])) {
$extra['url'] = array();
}
if ($arrayUrl && !isset($extra['data'])) {
$extra['data'] = array();
}
$extra = array_merge(array('autoRender' => 0, 'return' => 1, 'bare' => 1, 'requested' => 1), $extra);
$data = isset($extra['data']) ? $extra['data'] : null;
unset($extra['data']);
if (is_string($url) && strpos($url, FULL_BASE_URL) === 0) {
$url = Router::normalize(str_replace(FULL_BASE_URL, '', $url));
}
if (is_string($url)) {
$request = new CakeRequest($url);
} elseif (is_array($url)) {
$params = $url + array('pass' => array(), 'named' => array(), 'base' => false);
$params = array_merge($params, $extra);
$request = new CakeRequest(Router::reverse($params));
}
if (isset($data)) {
$request->data = $data;
}
$dispatcher = new Dispatcher();
$result = $dispatcher->dispatch($request, new CakeResponse(), $extra);
Router::popRequest();
return $result;
}
/**
* Calls a method on this object with the given parameters. Provides an OO wrapper
* for `call_user_func_array`
*
* @param string $method Name of the method to call
* @param array $params Parameter list to use when calling $method
* @return mixed Returns the result of the method call
*/
public function dispatchMethod($method, $params = array()) {
switch (count($params)) {
case 0:
return $this->{$method}();
case 1:
return $this->{$method}($params[0]);
case 2:
return $this->{$method}($params[0], $params[1]);
case 3:
return $this->{$method}($params[0], $params[1], $params[2]);
case 4:
return $this->{$method}($params[0], $params[1], $params[2], $params[3]);
case 5:
return $this->{$method}($params[0], $params[1], $params[2], $params[3], $params[4]);
default:
return call_user_func_array(array(&$this, $method), $params);
}
}
/**
* Stop execution of the current script. Wraps exit() making
* testing easier.
*
* @param integer|string $status see http://php.net/exit for values
* @return void
*/
protected function _stop($status = 0) {
exit($status);
}
/**
* Convenience method to write a message to CakeLog. See CakeLog::write()
* for more information on writing to logs.
*
* @param string $msg Log message
* @param integer $type Error type constant. Defined in app/Config/core.php.
* @return boolean Success of log write
*/
public function log($msg, $type = LOG_ERR) {
App::uses('CakeLog', 'Log');
if (!is_string($msg)) {
$msg = print_r($msg, true);
}
return CakeLog::write($type, $msg);
}
/**
* Allows setting of multiple properties of the object in a single line of code. Will only set
* properties that are part of a class declaration.
*
* @param array $properties An associative array containing properties and corresponding values.
* @return void
*/
protected function _set($properties = array()) {
if (is_array($properties) && !empty($properties)) {
$vars = get_object_vars($this);
foreach ($properties as $key => $val) {
if (array_key_exists($key, $vars)) {
$this->{$key} = $val;
}
}
}
}
/**
* Merges this objects $property with the property in $class' definition.
* This classes value for the property will be merged on top of $class'
*
* This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine
* this method as an empty function.
*
* @param array $properties The name of the properties to merge.
* @param string $class The class to merge the property with.
* @param boolean $normalize Set to true to run the properties through Hash::normalize() before merging.
* @return void
*/
protected function _mergeVars($properties, $class, $normalize = true) {
$classProperties = get_class_vars($class);
foreach ($properties as $var) {
if (
isset($classProperties[$var]) &&
!empty($classProperties[$var]) &&
is_array($this->{$var}) &&
$this->{$var} != $classProperties[$var]
) {
if ($normalize) {
$classProperties[$var] = Hash::normalize($classProperties[$var]);
$this->{$var} = Hash::normalize($this->{$var});
}
$this->{$var} = Hash::merge($classProperties[$var], $this->{$var});
}
}
}
}
App::uses('CakeObject', 'Core');
class_alias('CakeObject', 'Object');