Cookie Component.
Cookie handling for the controller.
$_expires
protected string
$_reset
protected string
$_response
protected $_type
protected string
$_values
protected string
$domain
public string
$httpOnly
public boolean
$key
public string
$name
public string
$path
public string
$secure
public boolean
$time
public mixed
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
Will allow overriding default encryption method. Use this method in ex: AppController::beforeFilter() before you have read or written any cookies.
__construct( ComponentCollection $collection , array $settings array() )
Constructor
ComponentCollection
$collection
$settings
optional array() Component::__construct()
_decode( string $value )
Decodes and decrypts a single value.
$value
_decrypt( array $values )
Decrypts $value using public $type method in Security class
$values
_delete( string $name )
Sets a cookie expire time to remove cookie value
$name
_encrypt( string $value )
Encrypts $value using public $type method in Security class
$value
_expire( integer|string $expires null )
Set the expire time for a session variable.
Creates a new expire time for a session variable. $expire can be either integer Unix timestamp or a date string.
Used by write() CookieComponent::write(string, string, boolean, 8400); CookieComponent::write(string, string, boolean, '5 Days');
$expires
optional null _explode( string $string )
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
$string
_implode( array $array )
Implode method to keep keys are multidimensional arrays
$array
_write( string $name , string $value )
Set cookie
$name
$value
check( string $key null )
Returns true if given variable is set in cookie.
$key
optional null delete( string $key )
Delete a cookie value
Optional [Name.], required key $this->Cookie->delete('Name.key);
You must use this method before any output is sent to the browser. Failure to do so will result in header already sent errors.
This method will delete both the top level and 2nd level cookies set. For example assuming that $name = App, deleting User
will delete both App[User]
and any other cookie values like App[User][email]
This is done to clean up cookie storage from before 2.4.3, where cookies were stored inconsistently.
$key
destroy( )
Destroy current cookie
You must use this method before any output is sent to the browser. Failure to do so will result in header already sent errors.
read( string $key null )
Read the value of the $_COOKIE[$key];
Optional [Name.], required key $this->Cookie->read(Name.key);
$key
optional null startup( Controller $controller )
Start CookieComponent for use in the controller
Controller
$controller
Component::startup()
type( string $type 'cipher' )
Will allow overriding default encryption method. Use this method in ex: AppController::beforeFilter() before you have read or written any cookies.
$type
optional 'cipher' write( string|array $key , mixed $value null , boolean $encrypt true , integer|string $expires null )
Write a value to the $_COOKIE[$key];
Optional [Name.], required key, optional $value, optional $encrypt, optional $expires $this->Cookie->write('[Name.]key, $value);
By default all values are encrypted. You must pass $encrypt false to store values in clear test
You must use this method before any output is sent to the browser. Failure to do so will result in header already sent errors.
$key
$value
optional null $encrypt
optional true $expires
optional null Can be either the number of seconds until a cookie expires, or a strtotime compatible time offset.
__get( string $name )
Magic method for lazy loading $components.
$name
beforeRedirect( Controller $controller , string|array $url , integer $status null , boolean $exit true )
Called before Controller::redirect(). Allows you to replace the URL that will be redirected to with a new URL. The return of this method can either be an array or a string.
If the return is an array and contains a 'url' key. You may also supply the following:
status
The status code for the redirectexit
Whether or not the redirect should exit.If your response is a string or an array that does not contain a 'url' key it will be used as the new URL to redirect to.
Controller
$controller
$url
$status
optional null $exit
optional true beforeRender( Controller $controller )
Called before the Controller::beforeRender(), and before the view class is loaded, and before Controller::render()
Controller
$controller
initialize( Controller $controller )
Called before the Controller::beforeFilter().
Controller
$controller
shutdown( Controller $controller )
Called after Controller::render() and before the output is printed to the browser.
Controller
$controller
_mergeVars( array $properties , string $class , boolean $normalize true )
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.
$properties
$class
$normalize
optional true _set( array $properties array() )
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.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 dispatchMethod( string $method , array $params array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array
$method
$params
optional array() log( string $msg , integer $type LOG_ERR , null|string|array $scope null )
Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
requestAction( string|array $url , array $extra array() )
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()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$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.
$extra
optional array() 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.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
Object-to-string conversion. Each class can override this method as necessary.
protected string
Expire time of the cookie
This is controlled by CookieComponent::time;
protected string
Used to reset cookie time if $expire is passed to CookieComponent::write()
null
protected string
Type of encryption to use.
Currently two methods are available: cipher and rijndael Defaults to Security::cipher(). Cipher is horribly insecure and only the default because of backwards compatibility. In new applications you should always change this to 'aes' or 'rijndael'.
'cipher'
protected string
Values stored in the cookie.
Accessed in the controller using $this->Cookie->read('Name.key');
array()
public string
Domain path.
The domain that the cookie is available.
Overridden with the controller beforeFilter(); $this->Cookie->domain = '.example.com';
To make the cookie available on all subdomains of example.com. Set $this->Cookie->domain = '.example.com'; in your controller beforeFilter
''
public boolean
HTTP only cookie
Set to true to make HTTP only cookies. Cookies that are HTTP only are not accessible in JavaScript.
false
public string
Encryption key.
Overridden with the controller beforeFilter(); $this->Cookie->key = 'SomeRandomString';
null
public string
The name of the cookie.
Overridden with the controller beforeFilter(); $this->Cookie->name = 'CookieName';
'CakeCookie'
public string
Cookie path.
Overridden with the controller beforeFilter(); $this->Cookie->path = '/';
The path on the server in which the cookie will be available on. If public $cookiePath is set to '/foo/', the cookie will only be available within the /foo/ directory and all sub-directories such as /foo/bar/ of domain. The default value is the entire domain.
'/'
public boolean
Secure HTTPS only cookie.
Overridden with the controller beforeFilter(); $this->Cookie->secure = true;
Indicates that the cookie should only be transmitted over a secure HTTPS connection. When set to true, the cookie will only be set if a secure connection exists.
false
public mixed
The time a cookie will remain valid.
Can be either integer Unix timestamp or a date string.
Overridden with the controller beforeFilter(); $this->Cookie->time = '5 Days';
null
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-CookieComponent.html