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();
}
/**