mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-15 03:18:26 +00:00
More API docblock fixes.
This commit is contained in:
parent
90c0556a4a
commit
3d9b2b80cb
25 changed files with 102 additions and 110 deletions
|
@ -39,8 +39,8 @@ class CakeErrorController extends AppController {
|
|||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param CakeRequest $request
|
||||
* @param CakeResponse $response
|
||||
* @param CakeRequest $request Request instance.
|
||||
* @param CakeResponse $response Response instance.
|
||||
*/
|
||||
public function __construct($request = null, $response = null) {
|
||||
parent::__construct($request, $response);
|
||||
|
|
|
@ -53,8 +53,8 @@ class AclComponent extends Component {
|
|||
/**
|
||||
* Constructor. Will return an instance of the correct ACL class as defined in `Configure::read('Acl.classname')`
|
||||
*
|
||||
* @param ComponentCollection $collection
|
||||
* @param array $settings
|
||||
* @param ComponentCollection $collection Collection instance.
|
||||
* @param array $settings Settings list.
|
||||
* @throws CakeException when Acl.classname could not be loaded.
|
||||
*/
|
||||
public function __construct(ComponentCollection $collection, $settings = array()) {
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
<?php
|
||||
/**
|
||||
*
|
||||
*
|
||||
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
||||
*
|
||||
|
@ -66,7 +64,7 @@ abstract class AbstractPasswordHasher {
|
|||
* and check against existing hash.
|
||||
*
|
||||
* @param string|array $password Plain text password to hash or data array.
|
||||
* @param string Existing hashed password.
|
||||
* @param string $hashedPassword Existing hashed password.
|
||||
* @return boolean True if hashes match else false.
|
||||
*/
|
||||
abstract public function check($password, $hashedPassword);
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
<?php
|
||||
/**
|
||||
*
|
||||
*
|
||||
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
||||
*
|
||||
|
@ -79,7 +77,7 @@ abstract class BaseAuthorize {
|
|||
* Checks user authorization.
|
||||
*
|
||||
* @param array $user Active user data
|
||||
* @param CakeRequest $request
|
||||
* @param CakeRequest $request Request instance.
|
||||
* @return boolean
|
||||
*/
|
||||
abstract public function authorize($user, CakeRequest $request);
|
||||
|
@ -107,7 +105,7 @@ abstract class BaseAuthorize {
|
|||
* that need to get information about the plugin, controller, and action being invoked.
|
||||
*
|
||||
* @param CakeRequest $request The request a path is needed for.
|
||||
* @param string $path
|
||||
* @param string $path Path format.
|
||||
* @return string the action path for the given request.
|
||||
*/
|
||||
public function action(CakeRequest $request, $path = '/:plugin/:controller/:action') {
|
||||
|
@ -144,7 +142,7 @@ abstract class BaseAuthorize {
|
|||
*
|
||||
* You can use the custom CRUD operations to create additional generic permissions
|
||||
* that behave like CRUD operations. Doing this will require additional columns on the
|
||||
* permissions lookup. For example if one wanted an additional search CRUD operation
|
||||
* permissions lookup. For example if one wanted an additional search CRUD operation
|
||||
* one would create and additional column '_search' in the aros_acos table. One could
|
||||
* create a custom admin CRUD operation for administration functions similarly if needed.
|
||||
*
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
<?php
|
||||
/**
|
||||
*
|
||||
*
|
||||
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
||||
*
|
||||
|
@ -40,7 +38,7 @@ class BlowfishPasswordHasher extends AbstractPasswordHasher {
|
|||
* Check hash. Generate hash for user provided password and check against existing hash.
|
||||
*
|
||||
* @param string $password Plain text password to hash.
|
||||
* @param string Existing hashed password.
|
||||
* @param string $hashedPassword Existing hashed password.
|
||||
* @return boolean True if hashes match else false.
|
||||
*/
|
||||
public function check($password, $hashedPassword) {
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
<?php
|
||||
/**
|
||||
*
|
||||
*
|
||||
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
||||
*
|
||||
|
@ -58,7 +56,7 @@ class ControllerAuthorize extends BaseAuthorize {
|
|||
* Checks user authorization using a controller callback.
|
||||
*
|
||||
* @param array $user Active user data
|
||||
* @param CakeRequest $request
|
||||
* @param CakeRequest $request Request instance.
|
||||
* @return boolean
|
||||
*/
|
||||
public function authorize($user, CakeRequest $request) {
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
<?php
|
||||
/**
|
||||
*
|
||||
*
|
||||
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
|
||||
*
|
||||
|
@ -47,7 +45,7 @@ class SimplePasswordHasher extends AbstractPasswordHasher {
|
|||
* Check hash. Generate hash for user provided password and check against existing hash.
|
||||
*
|
||||
* @param string $password Plain text password to hash.
|
||||
* @param string Existing hashed password.
|
||||
* @param string $hashedPassword Existing hashed password.
|
||||
* @return boolean True if hashes match else false.
|
||||
*/
|
||||
public function check($password, $hashedPassword) {
|
||||
|
|
|
@ -512,7 +512,7 @@ class AuthComponent extends Component {
|
|||
* `$this->Auth->allow('edit', 'add');` or
|
||||
* `$this->Auth->allow();` to allow all actions
|
||||
*
|
||||
* @param string|array $action,... Controller action name or array of actions
|
||||
* @param string|array $action Controller action name or array of actions
|
||||
* @return void
|
||||
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#making-actions-public
|
||||
*/
|
||||
|
@ -537,7 +537,7 @@ class AuthComponent extends Component {
|
|||
* `$this->Auth->deny('edit', 'add');` or
|
||||
* `$this->Auth->deny();` to remove all items from the allowed list
|
||||
*
|
||||
* @param string|array $action,... Controller action name or array of actions
|
||||
* @param string|array $action Controller action name or array of actions
|
||||
* @return void
|
||||
* @see AuthComponent::allow()
|
||||
* @link http://book.cakephp.org/2.0/en/core-libraries/components/authentication.html#making-actions-require-authorization
|
||||
|
|
|
@ -185,7 +185,7 @@ class CookieComponent extends Component {
|
|||
/**
|
||||
* Start CookieComponent for use in the controller
|
||||
*
|
||||
* @param Controller $controller
|
||||
* @param Controller $controller Controller instance.
|
||||
* @return void
|
||||
*/
|
||||
public function startup(Controller $controller) {
|
||||
|
@ -293,7 +293,7 @@ class CookieComponent extends Component {
|
|||
/**
|
||||
* Returns true if given variable is set in cookie.
|
||||
*
|
||||
* @param string $var Variable name to check for
|
||||
* @param string $key Variable name to check for
|
||||
* @return boolean True if variable is there
|
||||
*/
|
||||
public function check($key = null) {
|
||||
|
|
|
@ -423,7 +423,7 @@ class EmailComponent extends Component {
|
|||
/**
|
||||
* Format addresses to be an array with email as key and alias as value
|
||||
*
|
||||
* @param array $addresses
|
||||
* @param array $addresses Address to format.
|
||||
* @return array
|
||||
*/
|
||||
protected function _formatAddresses($addresses) {
|
||||
|
|
|
@ -224,7 +224,7 @@ class RequestHandlerComponent extends Component {
|
|||
* Helper method to parse xml input data, due to lack of anonymous functions
|
||||
* this lives here.
|
||||
*
|
||||
* @param string $xml
|
||||
* @param string $xml XML string.
|
||||
* @return array Xml array data
|
||||
*/
|
||||
public function convertXml($xml) {
|
||||
|
@ -246,7 +246,7 @@ class RequestHandlerComponent extends Component {
|
|||
* @param Controller $controller A reference to the controller
|
||||
* @param string|array $url A string or array containing the redirect location
|
||||
* @param integer|array $status HTTP Status for redirect
|
||||
* @param boolean $exit
|
||||
* @param boolean $exit Whether to exit script, defaults to `true`.
|
||||
* @return void
|
||||
*/
|
||||
public function beforeRedirect(Controller $controller, $url, $status = null, $exit = true) {
|
||||
|
@ -279,7 +279,7 @@ class RequestHandlerComponent extends Component {
|
|||
* render process is skipped. And the client will get a blank response with a
|
||||
* "304 Not Modified" header.
|
||||
*
|
||||
* @params Controller $controller
|
||||
* @param Controller $controller Controller instance.
|
||||
* @return boolean false if the render process should be aborted
|
||||
*/
|
||||
public function beforeRender(Controller $controller) {
|
||||
|
@ -444,9 +444,10 @@ class RequestHandlerComponent extends Component {
|
|||
/**
|
||||
* Gets remote client IP
|
||||
*
|
||||
* @param boolean $safe
|
||||
* @param boolean $safe Use safe = false when you think the user might manipulate
|
||||
* their HTTP_CLIENT_IP header. Setting $safe = false will also look at HTTP_X_FORWARDED_FOR
|
||||
* @return string Client IP address
|
||||
* @deprecated use $this->request->clientIp() from your, controller instead.
|
||||
* @deprecated use $this->request->clientIp() from your, controller instead.
|
||||
*/
|
||||
public function getClientIP($safe = true) {
|
||||
return $this->request->clientIp($safe);
|
||||
|
|
|
@ -346,7 +346,7 @@ class Controller extends Object implements CakeEventListener {
|
|||
* Provides backwards compatibility to avoid problems with empty and isset to alias properties.
|
||||
* Lazy loads models using the loadModel() method if declared in $uses
|
||||
*
|
||||
* @param string $name
|
||||
* @param string $name Property name to check.
|
||||
* @return boolean
|
||||
*/
|
||||
public function __isset($name) {
|
||||
|
@ -412,8 +412,8 @@ class Controller extends Object implements CakeEventListener {
|
|||
/**
|
||||
* Provides backwards compatibility access for setting values to the request object.
|
||||
*
|
||||
* @param string $name
|
||||
* @param mixed $value
|
||||
* @param string $name Property name to set.
|
||||
* @param mixed $value Value to set.
|
||||
* @return void
|
||||
*/
|
||||
public function __set($name, $value) {
|
||||
|
@ -448,7 +448,7 @@ class Controller extends Object implements CakeEventListener {
|
|||
* - $this->autoRender - To false if $request->params['return'] == 1
|
||||
* - $this->passedArgs - The the combined results of params['named'] and params['pass]
|
||||
*
|
||||
* @param CakeRequest $request
|
||||
* @param CakeRequest $request Request instance.
|
||||
* @return void
|
||||
*/
|
||||
public function setRequest(CakeRequest $request) {
|
||||
|
@ -471,7 +471,7 @@ class Controller extends Object implements CakeEventListener {
|
|||
* Dispatches the controller action. Checks that the action
|
||||
* exists and isn't private.
|
||||
*
|
||||
* @param CakeRequest $request
|
||||
* @param CakeRequest $request Request instance.
|
||||
* @return mixed The resulting response.
|
||||
* @throws PrivateActionException When actions are not public or prefixed by _
|
||||
* @throws MissingActionException When actions are not defined and scaffolding is
|
||||
|
@ -528,7 +528,7 @@ class Controller extends Object implements CakeEventListener {
|
|||
/**
|
||||
* Returns a scaffold object to use for dynamically scaffolded controllers.
|
||||
*
|
||||
* @param CakeRequest $request
|
||||
* @param CakeRequest $request Request instance.
|
||||
* @return Scaffold
|
||||
*/
|
||||
protected function _getScaffold(CakeRequest $request) {
|
||||
|
@ -887,11 +887,11 @@ class Controller extends Object implements CakeEventListener {
|
|||
}
|
||||
|
||||
/**
|
||||
* Validates models passed by parameters. Example:
|
||||
* Validates models passed by parameters. Takes a list of models as a variable argument.
|
||||
* Example:
|
||||
*
|
||||
* `$errors = $this->validateErrors($this->Article, $this->User);`
|
||||
*
|
||||
* @param mixed A list of models as a variable argument
|
||||
* @return array Validation errors, or false if none
|
||||
* @deprecated This method will be removed in 3.0
|
||||
*/
|
||||
|
@ -1145,7 +1145,7 @@ class Controller extends Object implements CakeEventListener {
|
|||
/**
|
||||
* Alias to beforeScaffold()
|
||||
*
|
||||
* @param string $method
|
||||
* @param string $method Method name.
|
||||
* @return boolean
|
||||
* @see Controller::beforeScaffold()
|
||||
* @deprecated Will be removed in 3.0.
|
||||
|
@ -1168,7 +1168,7 @@ class Controller extends Object implements CakeEventListener {
|
|||
/**
|
||||
* Alias to afterScaffoldSave()
|
||||
*
|
||||
* @param string $method
|
||||
* @param string $method Method name.
|
||||
* @return boolean
|
||||
* @see Controller::afterScaffoldSave()
|
||||
* @deprecated Will be removed in 3.0.
|
||||
|
@ -1191,7 +1191,7 @@ class Controller extends Object implements CakeEventListener {
|
|||
/**
|
||||
* Alias to afterScaffoldSaveError()
|
||||
*
|
||||
* @param string $method
|
||||
* @param string $method Method name.
|
||||
* @return boolean
|
||||
* @see Controller::afterScaffoldSaveError()
|
||||
* @deprecated Will be removed in 3.0.
|
||||
|
@ -1216,7 +1216,7 @@ class Controller extends Object implements CakeEventListener {
|
|||
/**
|
||||
* Alias to scaffoldError()
|
||||
*
|
||||
* @param string $method
|
||||
* @param string $method Method name.
|
||||
* @return boolean
|
||||
* @see Controller::scaffoldError()
|
||||
* @deprecated Will be removed in 3.0.
|
||||
|
|
|
@ -356,9 +356,9 @@ class CakeLog {
|
|||
/**
|
||||
* Gets the logging engine from the active streams.
|
||||
*
|
||||
* @see BaseLog
|
||||
* @param string $streamName Key name of a configured stream to get.
|
||||
* @return mixed instance of BaseLog or false if not found
|
||||
* @see BaseLog
|
||||
*/
|
||||
public static function stream($streamName) {
|
||||
if (empty(self::$_Collection)) {
|
||||
|
|
|
@ -27,8 +27,8 @@ interface CakeLogInterface {
|
|||
/**
|
||||
* Write method to handle writes being made to the Logger
|
||||
*
|
||||
* @param string $type
|
||||
* @param string $message
|
||||
* @param string $type Message type.
|
||||
* @param string $message Message to write.
|
||||
* @return void
|
||||
*/
|
||||
public function write($type, $message);
|
||||
|
|
|
@ -83,7 +83,7 @@ class FileLog extends BaseLog {
|
|||
* - `mask` A mask is applied when log files are created. Left empty no chmod
|
||||
* is made.
|
||||
*
|
||||
* @param array $options Options for the FileLog, see above.
|
||||
* @param array $config Options for the FileLog, see above.
|
||||
*/
|
||||
public function __construct($config = array()) {
|
||||
$config = Hash::merge($this->_defaults, $config);
|
||||
|
@ -157,6 +157,7 @@ class FileLog extends BaseLog {
|
|||
|
||||
/**
|
||||
* Get filename
|
||||
*
|
||||
* @param string $type The type of log.
|
||||
* @return string File name
|
||||
*/
|
||||
|
|
|
@ -87,7 +87,7 @@ class SyslogLog extends BaseLog {
|
|||
* Make sure the configuration contains the format parameter, by default it uses
|
||||
* the error number and the type as a prefix to the message
|
||||
*
|
||||
* @param array $config
|
||||
* @param array $config Options list.
|
||||
*/
|
||||
public function __construct($config = array()) {
|
||||
$config += $this->_defaults;
|
||||
|
@ -142,8 +142,8 @@ class SyslogLog extends BaseLog {
|
|||
* Extracts the call to syslog() in order to run unit tests on it. This function
|
||||
* will perform the actual write in the system logger
|
||||
*
|
||||
* @param integer $priority
|
||||
* @param string $message
|
||||
* @param integer $priority Message priority.
|
||||
* @param string $message Message to log.
|
||||
* @return boolean
|
||||
*/
|
||||
protected function _write($priority, $message) {
|
||||
|
|
|
@ -157,7 +157,7 @@ class CakeValidationRule {
|
|||
* Checks whether the field failed the `field should be present` validation
|
||||
*
|
||||
* @param string $field Field name
|
||||
* @param array $data Data to check rule against
|
||||
* @param array &$data Data to check rule against
|
||||
* @return boolean
|
||||
*/
|
||||
public function checkRequired($field, &$data) {
|
||||
|
@ -174,7 +174,7 @@ class CakeValidationRule {
|
|||
* Checks if the allowEmpty key applies
|
||||
*
|
||||
* @param string $field Field name
|
||||
* @param array $data data to check rule against
|
||||
* @param array &$data data to check rule against
|
||||
* @return boolean
|
||||
*/
|
||||
public function checkEmpty($field, &$data) {
|
||||
|
@ -259,8 +259,8 @@ class CakeValidationRule {
|
|||
* Dispatches the validation rule to the given validator method
|
||||
*
|
||||
* @param string $field Field name
|
||||
* @param array $data Data array
|
||||
* @param array $methods Methods list
|
||||
* @param array &$data Data array
|
||||
* @param array &$methods Methods list
|
||||
* @return boolean True if the rule could be dispatched, false otherwise
|
||||
*/
|
||||
public function process($field, &$data, &$methods) {
|
||||
|
@ -334,7 +334,7 @@ class CakeValidationRule {
|
|||
* Parses the rule and sets the rule and ruleParams
|
||||
*
|
||||
* @param string $field Field name
|
||||
* @param array $data Data array
|
||||
* @param array &$data Data array
|
||||
* @return void
|
||||
*/
|
||||
protected function _parseRule($field, &$data) {
|
||||
|
|
|
@ -74,8 +74,8 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable {
|
|||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $fieldName The fieldname
|
||||
* @param array $ruleset
|
||||
* @param string $fieldName The fieldname.
|
||||
* @param array $ruleSet Rules set.
|
||||
*/
|
||||
public function __construct($fieldName, $ruleSet) {
|
||||
$this->field = $fieldName;
|
||||
|
@ -93,7 +93,7 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable {
|
|||
/**
|
||||
* Sets the list of methods to use for validation
|
||||
*
|
||||
* @param array $methods Methods list
|
||||
* @param array &$methods Methods list
|
||||
* @return void
|
||||
*/
|
||||
public function setMethods(&$methods) {
|
||||
|
@ -160,7 +160,7 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable {
|
|||
/**
|
||||
* Gets a rule for a given name if exists
|
||||
*
|
||||
* @param string $name
|
||||
* @param string $name Field name.
|
||||
* @return CakeValidationRule
|
||||
*/
|
||||
public function getRule($name) {
|
||||
|
@ -330,11 +330,10 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable {
|
|||
* This is a wrapper for ArrayAccess. Use setRule() directly for
|
||||
* chainable access.
|
||||
*
|
||||
* @see http://www.php.net/manual/en/arrayobject.offsetset.php
|
||||
*
|
||||
* @param string $index name of the rule
|
||||
* @param CakeValidationRule|array rule to add to $index
|
||||
* @param string $index Name of the rule.
|
||||
* @param CakeValidationRule|array $rule Rule to add to $index.
|
||||
* @return void
|
||||
* @see http://www.php.net/manual/en/arrayobject.offsetset.php
|
||||
*/
|
||||
public function offsetSet($index, $rule) {
|
||||
$this->setRule($index, $rule);
|
||||
|
|
|
@ -793,7 +793,7 @@ class CakeRequest implements ArrayAccess {
|
|||
* Only qualifiers will be extracted, any other accept extensions will be
|
||||
* discarded as they are not frequently used.
|
||||
*
|
||||
* @param string $header
|
||||
* @param string $header Header to parse.
|
||||
* @return array
|
||||
*/
|
||||
protected static function _parseAcceptWithQualifier($header) {
|
||||
|
@ -854,7 +854,7 @@ class CakeRequest implements ArrayAccess {
|
|||
* You can write to any value, even paths/keys that do not exist, and the arrays
|
||||
* will be created for you.
|
||||
*
|
||||
* @param string $name,... Dot separated name of the value to read/write
|
||||
* @param string $name Dot separated name of the value to read/write, one or more args.
|
||||
* @return mixed Either the value being read, or this so you can chain consecutive writes.
|
||||
*/
|
||||
public function data($name) {
|
||||
|
@ -945,11 +945,11 @@ class CakeRequest implements ArrayAccess {
|
|||
/**
|
||||
* Alias of CakeRequest::allowMethod() for backwards compatibility.
|
||||
*
|
||||
* @see CakeRequest::allowMethod()
|
||||
* @deprecated 2.5 Use CakeRequest::allowMethod() instead.
|
||||
* @param string|array $methods Allowed HTTP request methods.
|
||||
* @return boolean true
|
||||
* @throws MethodNotAllowedException
|
||||
* @see CakeRequest::allowMethod()
|
||||
* @deprecated 2.5 Use CakeRequest::allowMethod() instead.
|
||||
*/
|
||||
public function onlyAllow($methods) {
|
||||
if (!is_array($methods)) {
|
||||
|
|
|
@ -559,10 +559,10 @@ class CakeResponse {
|
|||
* e.g `header('WWW-Authenticate: Negotiate'); header('WWW-Authenticate: Not-Negotiate');`
|
||||
* will have the same effect as only doing `header('WWW-Authenticate: Not-Negotiate');`
|
||||
*
|
||||
* @param string|array $header. An array of header strings or a single header string
|
||||
* @param string|array $header An array of header strings or a single header string
|
||||
* - an associative array of "header name" => "header value" is also accepted
|
||||
* - an array of string headers is also accepted
|
||||
* @param string|array $value. The header value(s)
|
||||
* @param string|array $value The header value(s)
|
||||
* @return array list of headers to be sent
|
||||
*/
|
||||
public function header($header = null, $value = null) {
|
||||
|
@ -586,6 +586,7 @@ class CakeResponse {
|
|||
* Acccessor for the location header.
|
||||
*
|
||||
* Get/Set the Location header value.
|
||||
*
|
||||
* @param null|string $url Either null to get the current location, or a string to set one.
|
||||
* @return string|null When setting the location null will be returned. When reading the location
|
||||
* a string of the current location header value (if any) will be returned.
|
||||
|
@ -702,7 +703,7 @@ class CakeResponse {
|
|||
*
|
||||
* e.g `type(array('jpg' => 'text/plain'));`
|
||||
*
|
||||
* @param string $contentType
|
||||
* @param string $contentType Content type key.
|
||||
* @return mixed current content type or false if supplied an invalid content type
|
||||
*/
|
||||
public function type($contentType = null) {
|
||||
|
@ -765,7 +766,7 @@ class CakeResponse {
|
|||
* Sets the response charset
|
||||
* if $charset is null the current charset is returned
|
||||
*
|
||||
* @param string $charset
|
||||
* @param string $charset Character set string.
|
||||
* @return string current charset
|
||||
*/
|
||||
public function charset($charset = null) {
|
||||
|
@ -892,8 +893,8 @@ class CakeResponse {
|
|||
* with the origin.
|
||||
* If called with no parameters, this function will return whether must-revalidate is present.
|
||||
*
|
||||
* @param integer $seconds if null, the method will return the current
|
||||
* must-revalidate value
|
||||
* @param boolean $enable If null returns whether directive is set, if boolean
|
||||
* sets or unsets directive.
|
||||
* @return boolean
|
||||
*/
|
||||
public function mustRevalidate($enable = null) {
|
||||
|
@ -934,7 +935,7 @@ class CakeResponse {
|
|||
* `$response->expires(new DateTime('+1 day'))` Will set the expiration in next 24 hours
|
||||
* `$response->expires()` Will return the current expiration header value
|
||||
*
|
||||
* @param string|DateTime $time
|
||||
* @param string|DateTime $time Valid time string or DateTime object.
|
||||
* @return string
|
||||
*/
|
||||
public function expires($time = null) {
|
||||
|
@ -958,7 +959,7 @@ class CakeResponse {
|
|||
* `$response->modified(new DateTime('+1 day'))` Will set the modification date in the past 24 hours
|
||||
* `$response->modified()` Will return the current Last-Modified header value
|
||||
*
|
||||
* @param string|DateTime $time
|
||||
* @param string|DateTime $time Valid time string or DateTime object.
|
||||
* @return string
|
||||
*/
|
||||
public function modified($time = null) {
|
||||
|
@ -1033,7 +1034,7 @@ class CakeResponse {
|
|||
*
|
||||
* If no parameters are passed, current Etag header is returned.
|
||||
*
|
||||
* @param string $hash the unique has that identifies this response
|
||||
* @param string $tag Tag to set.
|
||||
* @param boolean $weak whether the response is semantically the same as
|
||||
* other with the same hash or not
|
||||
* @return string
|
||||
|
@ -1052,7 +1053,7 @@ class CakeResponse {
|
|||
* Returns a DateTime object initialized at the $time param and using UTC
|
||||
* as timezone
|
||||
*
|
||||
* @param string|integer|DateTime $time
|
||||
* @param string|DateTime $time Valid time string or unix timestamp or DateTime object.
|
||||
* @return DateTime
|
||||
*/
|
||||
protected function _getUTCDate($time = null) {
|
||||
|
@ -1104,7 +1105,7 @@ class CakeResponse {
|
|||
* Sets the protocol to be used when sending the response. Defaults to HTTP/1.1
|
||||
* If called with no arguments, it will return the current configured protocol
|
||||
*
|
||||
* @param string protocol to be used for sending response
|
||||
* @param string $protocol Protocol to be used for sending response.
|
||||
* @return string protocol currently set
|
||||
*/
|
||||
public function protocol($protocol = null) {
|
||||
|
@ -1287,8 +1288,8 @@ class CakeResponse {
|
|||
/**
|
||||
* Normalize the origin to regular expressions and put in an array format
|
||||
*
|
||||
* @param array $domains
|
||||
* @param boolean $requestIsSSL
|
||||
* @param array $domains Domains to normalize
|
||||
* @param boolean $requestIsSSL Whether it's a SSL request.
|
||||
* @return array
|
||||
*/
|
||||
protected function _normalizeCorsDomains($domains, $requestIsSSL = false) {
|
||||
|
|
|
@ -182,8 +182,8 @@ class CakeSocket {
|
|||
*
|
||||
* Instead we need to handle those errors manually.
|
||||
*
|
||||
* @param integer $code
|
||||
* @param string $message
|
||||
* @param integer $code Code.
|
||||
* @param string $message Message.
|
||||
* @return void
|
||||
*/
|
||||
protected function _connectionErrorHandler($code, $message) {
|
||||
|
|
|
@ -26,8 +26,8 @@ class BasicAuthentication {
|
|||
/**
|
||||
* Authentication
|
||||
*
|
||||
* @param HttpSocket $http
|
||||
* @param array $authInfo
|
||||
* @param HttpSocket $http Http socket instance.
|
||||
* @param array &$authInfo Authentication info.
|
||||
* @return void
|
||||
* @see http://www.ietf.org/rfc/rfc2617.txt
|
||||
*/
|
||||
|
@ -40,8 +40,8 @@ class BasicAuthentication {
|
|||
/**
|
||||
* Proxy Authentication
|
||||
*
|
||||
* @param HttpSocket $http
|
||||
* @param array $proxyInfo
|
||||
* @param HttpSocket $http Http socket instance.
|
||||
* @param array &$proxyInfo Proxy info.
|
||||
* @return void
|
||||
* @see http://www.ietf.org/rfc/rfc2617.txt
|
||||
*/
|
||||
|
@ -54,8 +54,8 @@ class BasicAuthentication {
|
|||
/**
|
||||
* Generate basic [proxy] authentication header
|
||||
*
|
||||
* @param string $user
|
||||
* @param string $pass
|
||||
* @param string $user Username.
|
||||
* @param string $pass Password.
|
||||
* @return string
|
||||
*/
|
||||
protected static function _generateHeader($user, $pass) {
|
||||
|
|
|
@ -26,8 +26,8 @@ class DigestAuthentication {
|
|||
/**
|
||||
* Authentication
|
||||
*
|
||||
* @param HttpSocket $http
|
||||
* @param array $authInfo
|
||||
* @param HttpSocket $http Http socket instance.
|
||||
* @param array &$authInfo Authentication info.
|
||||
* @return void
|
||||
* @link http://www.ietf.org/rfc/rfc2617.txt
|
||||
*/
|
||||
|
@ -43,8 +43,8 @@ class DigestAuthentication {
|
|||
/**
|
||||
* Retrieve information about the authentication
|
||||
*
|
||||
* @param HttpSocket $http
|
||||
* @param array $authInfo
|
||||
* @param HttpSocket $http Http socket instance.
|
||||
* @param array &$authInfo Authentication info.
|
||||
* @return boolean
|
||||
*/
|
||||
protected static function _getServerInformation(HttpSocket $http, &$authInfo) {
|
||||
|
@ -70,8 +70,8 @@ class DigestAuthentication {
|
|||
/**
|
||||
* Generate the header Authorization
|
||||
*
|
||||
* @param HttpSocket $http
|
||||
* @param array $authInfo
|
||||
* @param HttpSocket $http Http socket instance.
|
||||
* @param array &$authInfo Authentication info.
|
||||
* @return string
|
||||
*/
|
||||
protected static function _generateHeader(HttpSocket $http, &$authInfo) {
|
||||
|
|
|
@ -543,7 +543,7 @@ class HttpSocket extends CakeSocket {
|
|||
*
|
||||
* Would return `/search?q=socket`.
|
||||
*
|
||||
* @param string|array Either a string or array of URL options to create a URL with.
|
||||
* @param string|array $url Either a string or array of URL options to create a URL with.
|
||||
* @param string $uriTemplate A template string to use for URL formatting.
|
||||
* @return mixed Either false on failure or a string containing the composed URL.
|
||||
*/
|
||||
|
@ -910,7 +910,7 @@ class HttpSocket extends CakeSocket {
|
|||
* Builds the header.
|
||||
*
|
||||
* @param array $header Header to build
|
||||
* @param string $mode
|
||||
* @param string $mode Mode
|
||||
* @return string Header built from array
|
||||
*/
|
||||
protected function _buildHeader($header, $mode = 'standard') {
|
||||
|
@ -972,7 +972,7 @@ class HttpSocket extends CakeSocket {
|
|||
* Escapes a given $token according to RFC 2616 (HTTP 1.1 specs)
|
||||
*
|
||||
* @param string $token Token to escape
|
||||
* @param array $chars
|
||||
* @param array $chars Characters to escape
|
||||
* @return string Escaped token
|
||||
*/
|
||||
protected function _escapeToken($token, $chars = null) {
|
||||
|
@ -985,7 +985,7 @@ class HttpSocket extends CakeSocket {
|
|||
* Gets escape chars according to RFC 2616 (HTTP 1.1 specs).
|
||||
*
|
||||
* @param boolean $hex true to get them as HEX values, false otherwise
|
||||
* @param array $chars
|
||||
* @param array $chars Characters to escape
|
||||
* @return array Escape chars
|
||||
*/
|
||||
protected function _tokenEscapeChars($hex = true, $chars = null) {
|
||||
|
|
|
@ -82,7 +82,7 @@ class HttpSocketResponse implements ArrayAccess {
|
|||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $message
|
||||
* @param string $message Message to parse.
|
||||
*/
|
||||
public function __construct($message = null) {
|
||||
if ($message !== null) {
|
||||
|
@ -102,8 +102,8 @@ class HttpSocketResponse implements ArrayAccess {
|
|||
/**
|
||||
* Get header in case insensitive
|
||||
*
|
||||
* @param string $name Header name
|
||||
* @param array $headers
|
||||
* @param string $name Header name.
|
||||
* @param array $headers Headers to format.
|
||||
* @return mixed String if header exists or null
|
||||
*/
|
||||
public function getHeader($name, $headers = null) {
|
||||
|
@ -331,8 +331,8 @@ class HttpSocketResponse implements ArrayAccess {
|
|||
/**
|
||||
* Unescapes a given $token according to RFC 2616 (HTTP 1.1 specs)
|
||||
*
|
||||
* @param string $token Token to unescape
|
||||
* @param array $chars
|
||||
* @param string $token Token to unescape.
|
||||
* @param array $chars Characters to unescape.
|
||||
* @return string Unescaped token
|
||||
*/
|
||||
protected function _unescapeToken($token, $chars = null) {
|
||||
|
@ -344,8 +344,8 @@ class HttpSocketResponse implements ArrayAccess {
|
|||
/**
|
||||
* Gets escape chars according to RFC 2616 (HTTP 1.1 specs).
|
||||
*
|
||||
* @param boolean $hex true to get them as HEX values, false otherwise
|
||||
* @param array $chars
|
||||
* @param boolean $hex True to get them as HEX values, false otherwise.
|
||||
* @param array $chars Characters to uescape.
|
||||
* @return array Escape chars
|
||||
*/
|
||||
protected function _tokenEscapeChars($hex = true, $chars = null) {
|
||||
|
@ -371,7 +371,7 @@ class HttpSocketResponse implements ArrayAccess {
|
|||
/**
|
||||
* ArrayAccess - Offset Exists
|
||||
*
|
||||
* @param string $offset
|
||||
* @param string $offset Offset to check.
|
||||
* @return boolean
|
||||
*/
|
||||
public function offsetExists($offset) {
|
||||
|
@ -381,7 +381,7 @@ class HttpSocketResponse implements ArrayAccess {
|
|||
/**
|
||||
* ArrayAccess - Offset Get
|
||||
*
|
||||
* @param string $offset
|
||||
* @param string $offset Offset to get.
|
||||
* @return mixed
|
||||
*/
|
||||
public function offsetGet($offset) {
|
||||
|
@ -418,8 +418,8 @@ class HttpSocketResponse implements ArrayAccess {
|
|||
/**
|
||||
* ArrayAccess - Offset Set
|
||||
*
|
||||
* @param string $offset
|
||||
* @param mixed $value
|
||||
* @param string $offset Offset to set.
|
||||
* @param mixed $value Value.
|
||||
* @return void
|
||||
*/
|
||||
public function offsetSet($offset, $value) {
|
||||
|
@ -428,7 +428,7 @@ class HttpSocketResponse implements ArrayAccess {
|
|||
/**
|
||||
* ArrayAccess - Offset Unset
|
||||
*
|
||||
* @param string $offset
|
||||
* @param string $offset Offset to unset.
|
||||
* @return void
|
||||
*/
|
||||
public function offsetUnset($offset) {
|
||||
|
|
Loading…
Reference in a new issue