mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-15 03:18:26 +00:00
Fixed some API doc in routing and cache.
This commit is contained in:
parent
3723f7d396
commit
e74d835a62
9 changed files with 18 additions and 16 deletions
|
@ -108,6 +108,7 @@ class ApcEngine extends CacheEngine {
|
||||||
/**
|
/**
|
||||||
* Delete all keys from the cache. This will clear every cache config using APC.
|
* Delete all keys from the cache. This will clear every cache config using APC.
|
||||||
*
|
*
|
||||||
|
* @param boolean $check
|
||||||
* @return boolean True if the cache was successfully cleared, false otherwise
|
* @return boolean True if the cache was successfully cleared, false otherwise
|
||||||
*/
|
*/
|
||||||
public function clear($check) {
|
public function clear($check) {
|
||||||
|
|
|
@ -247,6 +247,8 @@ class FileEngine extends CacheEngine {
|
||||||
/**
|
/**
|
||||||
* Not implemented
|
* Not implemented
|
||||||
*
|
*
|
||||||
|
* @param string $key
|
||||||
|
* @param integer $offset
|
||||||
* @return void
|
* @return void
|
||||||
* @throws CacheException
|
* @throws CacheException
|
||||||
*/
|
*/
|
||||||
|
@ -257,6 +259,8 @@ class FileEngine extends CacheEngine {
|
||||||
/**
|
/**
|
||||||
* Not implemented
|
* Not implemented
|
||||||
*
|
*
|
||||||
|
* @param string $key
|
||||||
|
* @param integer $offset
|
||||||
* @return void
|
* @return void
|
||||||
* @throws CacheException
|
* @throws CacheException
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -189,6 +189,7 @@ class MemcacheEngine extends CacheEngine {
|
||||||
/**
|
/**
|
||||||
* Delete all keys from the cache
|
* Delete all keys from the cache
|
||||||
*
|
*
|
||||||
|
* @param boolean $check
|
||||||
* @return boolean True if the cache was successfully cleared, false otherwise
|
* @return boolean True if the cache was successfully cleared, false otherwise
|
||||||
*/
|
*/
|
||||||
public function clear($check) {
|
public function clear($check) {
|
||||||
|
|
|
@ -115,6 +115,7 @@ class WincacheEngine extends CacheEngine {
|
||||||
* Delete all keys from the cache. This will clear every cache value stored
|
* Delete all keys from the cache. This will clear every cache value stored
|
||||||
* in wincache.
|
* in wincache.
|
||||||
*
|
*
|
||||||
|
* @param boolean $check
|
||||||
* @return boolean True if the cache was successfully cleared, false otherwise
|
* @return boolean True if the cache was successfully cleared, false otherwise
|
||||||
*/
|
*/
|
||||||
public function clear($check) {
|
public function clear($check) {
|
||||||
|
|
|
@ -124,6 +124,7 @@ class XcacheEngine extends CacheEngine {
|
||||||
/**
|
/**
|
||||||
* Delete all keys from the cache
|
* Delete all keys from the cache
|
||||||
*
|
*
|
||||||
|
* @param boolean $check
|
||||||
* @return boolean True if the cache was successfully cleared, false otherwise
|
* @return boolean True if the cache was successfully cleared, false otherwise
|
||||||
*/
|
*/
|
||||||
public function clear($check) {
|
public function clear($check) {
|
||||||
|
@ -144,7 +145,7 @@ class XcacheEngine extends CacheEngine {
|
||||||
* (see xcache.admin configuration settings)
|
* (see xcache.admin configuration settings)
|
||||||
*
|
*
|
||||||
* @param boolean $reverse Revert changes
|
* @param boolean $reverse Revert changes
|
||||||
* @access private
|
* @return void
|
||||||
*/
|
*/
|
||||||
function __auth($reverse = false) {
|
function __auth($reverse = false) {
|
||||||
static $backup = array();
|
static $backup = array();
|
||||||
|
|
|
@ -95,8 +95,8 @@ class Dispatcher {
|
||||||
*
|
*
|
||||||
* @param Controller $controller Controller to invoke
|
* @param Controller $controller Controller to invoke
|
||||||
* @param CakeRequest $request The request object to invoke the controller for.
|
* @param CakeRequest $request The request object to invoke the controller for.
|
||||||
* @return string Output as sent by controller
|
* @param CakeResponse $response The response object to receive the output
|
||||||
* @throws MissingActionException when the action being called is missing.
|
* @return void
|
||||||
*/
|
*/
|
||||||
protected function _invoke(Controller $controller, CakeRequest $request, CakeResponse $response) {
|
protected function _invoke(Controller $controller, CakeRequest $request, CakeResponse $response) {
|
||||||
$controller->constructClasses();
|
$controller->constructClasses();
|
||||||
|
@ -165,7 +165,7 @@ class Dispatcher {
|
||||||
/**
|
/**
|
||||||
* Load controller and return controller classname
|
* Load controller and return controller classname
|
||||||
*
|
*
|
||||||
* @param array $params Array of parameters
|
* @param CakeRequest $request
|
||||||
* @return string|bool Name of controller class name
|
* @return string|bool Name of controller class name
|
||||||
*/
|
*/
|
||||||
protected function _loadController($request) {
|
protected function _loadController($request) {
|
||||||
|
@ -202,6 +202,7 @@ class Dispatcher {
|
||||||
* Outputs cached dispatch view cache
|
* Outputs cached dispatch view cache
|
||||||
*
|
*
|
||||||
* @param string $path Requested URL path
|
* @param string $path Requested URL path
|
||||||
|
* @return string|boolean False if is not cached or output
|
||||||
*/
|
*/
|
||||||
public function cached($path) {
|
public function cached($path) {
|
||||||
if (Configure::read('Cache.check') === true) {
|
if (Configure::read('Cache.check') === true) {
|
||||||
|
|
|
@ -27,7 +27,6 @@ class CakeRoute {
|
||||||
* `/:controller/:action/:id` has 3 key elements
|
* `/:controller/:action/:id` has 3 key elements
|
||||||
*
|
*
|
||||||
* @var array
|
* @var array
|
||||||
* @access public
|
|
||||||
*/
|
*/
|
||||||
public $keys = array();
|
public $keys = array();
|
||||||
|
|
||||||
|
@ -35,7 +34,6 @@ class CakeRoute {
|
||||||
* An array of additional parameters for the Route.
|
* An array of additional parameters for the Route.
|
||||||
*
|
*
|
||||||
* @var array
|
* @var array
|
||||||
* @access public
|
|
||||||
*/
|
*/
|
||||||
public $options = array();
|
public $options = array();
|
||||||
|
|
||||||
|
@ -43,7 +41,6 @@ class CakeRoute {
|
||||||
* Default parameters for a Route
|
* Default parameters for a Route
|
||||||
*
|
*
|
||||||
* @var array
|
* @var array
|
||||||
* @access public
|
|
||||||
*/
|
*/
|
||||||
public $defaults = array();
|
public $defaults = array();
|
||||||
|
|
||||||
|
@ -51,7 +48,6 @@ class CakeRoute {
|
||||||
* The routes template string.
|
* The routes template string.
|
||||||
*
|
*
|
||||||
* @var string
|
* @var string
|
||||||
* @access public
|
|
||||||
*/
|
*/
|
||||||
public $template = null;
|
public $template = null;
|
||||||
|
|
||||||
|
@ -60,7 +56,6 @@ class CakeRoute {
|
||||||
* template
|
* template
|
||||||
*
|
*
|
||||||
* @var string
|
* @var string
|
||||||
* @access protected
|
|
||||||
*/
|
*/
|
||||||
protected $_greedy = false;
|
protected $_greedy = false;
|
||||||
|
|
||||||
|
@ -68,7 +63,6 @@ class CakeRoute {
|
||||||
* The compiled route regular expresssion
|
* The compiled route regular expresssion
|
||||||
*
|
*
|
||||||
* @var string
|
* @var string
|
||||||
* @access protected
|
|
||||||
*/
|
*/
|
||||||
protected $_compiledRoute = null;
|
protected $_compiledRoute = null;
|
||||||
|
|
||||||
|
@ -76,7 +70,6 @@ class CakeRoute {
|
||||||
* HTTP header shortcut map. Used for evaluating header-based route expressions.
|
* HTTP header shortcut map. Used for evaluating header-based route expressions.
|
||||||
*
|
*
|
||||||
* @var array
|
* @var array
|
||||||
* @access private
|
|
||||||
*/
|
*/
|
||||||
private $__headerMap = array(
|
private $__headerMap = array(
|
||||||
'type' => 'content_type',
|
'type' => 'content_type',
|
||||||
|
@ -89,7 +82,7 @@ class CakeRoute {
|
||||||
*
|
*
|
||||||
* @param string $template Template string with parameter placeholders
|
* @param string $template Template string with parameter placeholders
|
||||||
* @param array $defaults Array of defaults for the route.
|
* @param array $defaults Array of defaults for the route.
|
||||||
* @param string $params Array of parameters and additional options for the Route
|
* @param array $options Array of additional options for the Route
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function __construct($template, $defaults = array(), $options = array()) {
|
public function __construct($template, $defaults = array(), $options = array()) {
|
||||||
|
|
|
@ -42,7 +42,7 @@ class RedirectRoute extends CakeRoute {
|
||||||
*
|
*
|
||||||
* @param string $template Template string with parameter placeholders
|
* @param string $template Template string with parameter placeholders
|
||||||
* @param array $defaults Array of defaults for the route.
|
* @param array $defaults Array of defaults for the route.
|
||||||
* @param string $params Array of parameters and additional options for the Route
|
* @param array $options Array of additional options for the Route
|
||||||
*/
|
*/
|
||||||
public function __construct($template, $defaults = array(), $options = array()) {
|
public function __construct($template, $defaults = array(), $options = array()) {
|
||||||
parent::__construct($template, $defaults, $options);
|
parent::__construct($template, $defaults, $options);
|
||||||
|
|
|
@ -520,7 +520,7 @@ class Router {
|
||||||
* Will accept either a CakeRequest object or an array of arrays. Support for
|
* Will accept either a CakeRequest object or an array of arrays. Support for
|
||||||
* accepting arrays may be removed in the future.
|
* accepting arrays may be removed in the future.
|
||||||
*
|
*
|
||||||
* @param mixed $params Parameters and path information or a CakeRequest object.
|
* @param CakeRequest|array $request Parameters and path information or a CakeRequest object.
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public static function setRequestInfo($request) {
|
public static function setRequestInfo($request) {
|
||||||
|
@ -618,7 +618,7 @@ class Router {
|
||||||
/**
|
/**
|
||||||
* Promote a route (by default, the last one added) to the beginning of the list
|
* Promote a route (by default, the last one added) to the beginning of the list
|
||||||
*
|
*
|
||||||
* @param $which A zero-based array index representing the route to move. For example,
|
* @param integer $which A zero-based array index representing the route to move. For example,
|
||||||
* if 3 routes have been added, the last route would be 2.
|
* if 3 routes have been added, the last route would be 2.
|
||||||
* @return boolean Returns false if no route exists at the position specified by $which.
|
* @return boolean Returns false if no route exists at the position specified by $which.
|
||||||
*/
|
*/
|
||||||
|
@ -909,7 +909,7 @@ class Router {
|
||||||
* This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those
|
* This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those
|
||||||
* are used for CakePHP internals and should not normally be part of an output url.
|
* are used for CakePHP internals and should not normally be part of an output url.
|
||||||
*
|
*
|
||||||
* @param mixed $param The params array or CakeRequest object that needs to be reversed.
|
* @param CakeRequest|array $params The params array or CakeRequest object that needs to be reversed.
|
||||||
* @param boolean $full Set to true to include the full url including the protocol when reversing
|
* @param boolean $full Set to true to include the full url including the protocol when reversing
|
||||||
* the url.
|
* the url.
|
||||||
* @return string The string that is the reversed result of the array
|
* @return string The string that is the reversed result of the array
|
||||||
|
|
Loading…
Reference in a new issue