Class CookieComponent
Cookie Component.
Cookie handling for the controller.
Link: http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Controller/Component/CookieComponent.php
Properties summary
-
$_expiresprotectedstringExpire time of the cookie -
$_resetprotectedstringUsed to reset cookie time if $expire is passed to CookieComponent::write() -
$_responseprotectedA reference to the Controller's CakeResponse object -
$_typeprotectedstringType of encryption to use. -
$_valuesprotectedstringValues stored in the cookie. -
$domainpublicstringDomain path. -
$httpOnlypublicbooleanHTTP only cookie -
$keypublicstringEncryption key. -
$namepublicstringThe name of the cookie. -
$pathpublicstringCookie path. -
$securepublicbooleanSecure HTTPS only cookie. -
$timepublicmixedThe time a cookie will remain valid.
Inherited Properties
Method Summary
-
__construct() public
Constructor -
_decrypt() protected
Decrypts $value using public $type method in Security class -
_delete() protected
Sets a cookie expire time to remove cookie value -
_encrypt() protected
Encrypts $value using public $type method in Security class -
_expire() protected
Set the expire time for a session variable. -
_explode() protected
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
-
_implode() protected
Implode method to keep keys are multidimensional arrays -
_write() protected
Set cookie -
check() public
Returns true if given variable is set in cookie. -
delete() public
Delete a cookie value -
destroy() public
Destroy current cookie -
read() public
Read the value of the $_COOKIE[$key]; -
startup() public
Start CookieComponent for use in the controller -
type() public
Will allow overriding default encryption method. Use this method in ex: AppController::beforeFilter() before you have read or written any cookies.
-
write() public
Write a value to the $_COOKIE[$key];
Method Detail
__construct() public ¶
__construct( ComponentCollection $collection , array $settings = array() )
Constructor
Parameters
-
ComponentCollection$collection - A ComponentCollection for this component
- array $settings optional array()
- Array of settings.
Overrides
_decrypt() protected ¶
_decrypt( array $values )
Decrypts $value using public $type method in Security class
Parameters
- array $values
- Values to decrypt
Returns
decrypted string
_delete() protected ¶
_delete( string $name )
Sets a cookie expire time to remove cookie value
Parameters
- string $name
- Name of cookie
_encrypt() protected ¶
_encrypt( string $value )
Encrypts $value using public $type method in Security class
Parameters
- string $value
- Value to encrypt
Returns
Encoded values
_expire() protected ¶
_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');
Parameters
- integer|string $expires optional null
- Can be either Unix timestamp, or date string
Returns
Unix timestamp
_explode() protected ¶
_explode( string $string )
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
Parameters
- string $string
- A string containing JSON encoded data, or a bare string.
Returns
Map of key and values
_implode() protected ¶
_implode( array $array )
Implode method to keep keys are multidimensional arrays
Parameters
- array $array
- Map of key and values
Returns
A json encoded string.
_write() protected ¶
_write( string $name , string $value )
Set cookie
Parameters
- string $name
- Name for cookie
- string $value
- Value for cookie
check() public ¶
check( string $key = null )
Returns true if given variable is set in cookie.
Parameters
- string $key optional null
- $var Variable name to check for
Returns
True if variable is there
delete() public ¶
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.
Parameters
- string $key
- Key of the value to be deleted
Link
destroy() public ¶
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.
Link
read() public ¶
read( string $key = null )
Read the value of the $_COOKIE[$key];
Optional [Name.], required key $this->Cookie->read(Name.key);
Parameters
- string $key optional null
- Key of the value to be obtained. If none specified, obtain map key => values
Returns
or null, value for specified key
Link
startup() public ¶
startup( Controller $controller )
type() public ¶
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.
Parameters
- string $type optional 'cipher'
- Encryption method
write() public ¶
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.
Parameters
- string|array $key
- Key for the value
- mixed $value optional null
- Value
- boolean $encrypt optional true
- Set to true to encrypt value, false otherwise
- integer|string $expires optional null
Can be either the number of seconds until a cookie expires, or a strtotime compatible time offset.
Link
Methods inherited from Component
__get() public ¶
__get( string $name )
Magic method for lazy loading $components.
Parameters
- string $name
- Name of component to get.
Returns
A Component object or null.
beforeRedirect() public ¶
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:
statusThe status code for the redirectexitWhether 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.
Parameters
-
Controller$controller - Controller with components to beforeRedirect
- string|array $url
- Either the string or URL array that is being redirected to.
- integer $status optional null
- The status code of the redirect
- boolean $exit optional true
- Will the script exit.
Returns
Either an array or null.
Link
beforeRender() public ¶
beforeRender( Controller $controller )
Called before the Controller::beforeRender(), and before the view class is loaded, and before Controller::render()
Parameters
-
Controller$controller - Controller with components to beforeRender
Link
initialize() public ¶
initialize( Controller $controller )
Called before the Controller::beforeFilter().
Parameters
-
Controller$controller - Controller with components to initialize
Link
shutdown() public ¶
shutdown( Controller $controller )
Called after Controller::render() and before the output is printed to the browser.
Parameters
-
Controller$controller - Controller with components to shutdown
Link
Methods inherited from Object
_mergeVars() protected ¶
_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.
Parameters
- array $properties
- The name of the properties to merge.
- string $class
- The class to merge the property with.
- boolean $normalize optional true
- Set to true to run the properties through Hash::normalize() before merging.
_set() protected ¶
_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.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() protected ¶
_stop( integer|string $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- integer|string $status optional 0
- see http://php.net/exit for values
dispatchMethod() public ¶
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
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
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.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERR
- Error type constant. Defined in app/Config/core.php.
- null|string|array $scope optional null
The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
Returns
Success of log write
requestAction() public ¶
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()
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.
Parameters
- 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.
- array $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.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class
Properties detail
$_reset ¶
Used to reset cookie time if $expire is passed to CookieComponent::write()
null
$_type ¶
Type of encryption to use.
Currently two methods are available: cipher and rijndael Defaults to Security::cipher();
'cipher'
$_values ¶
Values stored in the cookie.
Accessed in the controller using $this->Cookie->read('Name.key');
See
array()
$domain ¶
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
''
$httpOnly ¶
HTTP only cookie
Set to true to make HTTP only cookies. Cookies that are HTTP only are not accessible in JavaScript.
false
$key ¶
Encryption key.
Overridden with the controller beforeFilter(); $this->Cookie->key = 'SomeRandomString';
null
$name ¶
The name of the cookie.
Overridden with the controller beforeFilter(); $this->Cookie->name = 'CookieName';
'CakeCookie'
$path ¶
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.
'/'