Class CookieComponent
Cookie Component.
Cookie handling for the controller.
- Object
-
CookieComponent
Link: http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Cookies.html
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: controller/components/cookie.php
Properties summary
-
$__expirespublicstringExpire time of the cookie -
$__resetpublicstringUsed to reset cookie time if $expire is passed to CookieComponent::write() -
$__typepublicstringType of encryption to use. -
$__valuespublicstringValues stored in the cookie. -
$domainpublicstringDomain path. -
$keypublicstringEncryption key. -
$namepublicstringThe name of the cookie. -
$pathpublicstringCookie path. -
$securepublicbooleanSecure HTTPS only cookie. -
$timepublicmixedThe time a cookie will remain valid.
Method Summary
-
__decrypt() public
Decrypts $value using var $type method in Security class -
__delete() public
Sets a cookie expire time to remove cookie value -
__encrypt() public
Encrypts $value using var $type method in Security class -
__expire() public
Set the expire time for a session variable. -
__explode() public
Explode method to return array from string set in CookieComponent::__implode() -
__implode() public
Implode method to keep keys are multidimensional arrays -
__write() public
Set cookie -
delete() public
Delete a cookie value -
destroy() public
Destroy current cookie -
initialize() public
Main execution method. -
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. -
write() public
Write a value to the $_COOKIE[$key];
Method Detail
__decrypt() public ¶
__decrypt( array $values )
Decrypts $value using var $type method in Security class
Parameters
- array $values
- Values to decrypt
Returns
decrypted string
__delete() public ¶
__delete( string $name )
Sets a cookie expire time to remove cookie value
Parameters
- string $name
- Name of cookie
__encrypt() public ¶
__encrypt( string $value )
Encrypts $value using var $type method in Security class
Parameters
- string $value
- Value to encrypt
Returns
encrypted string
__expire() public ¶
__expire( mixed $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
- mixed $expires optional null
- Can be either Unix timestamp, or date string
Returns
Unix timestamp
__explode() public ¶
__explode( string $string )
Explode method to return array from string set in CookieComponent::__implode()
Parameters
- string $string
- String in the form key1|value1,key2|value2
Returns
If array, map of key and values. If string, value.
__implode() public ¶
__implode( array $array )
Implode method to keep keys are multidimensional arrays
Parameters
- array $array
- Map of key and values
Returns
String in the form key1|value1,key2|value2
__write() public ¶
__write( string $name , string $value )
Set cookie
Parameters
- string $name
- Name for cookie
- string $value
- Value for cookie
delete() public ¶
delete( string $key )
Delete a cookie value
Optional [Name.], required key $this->Cookie->read('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.
Parameters
- string $key
- Key of the value to be deleted
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.
initialize() public ¶
initialize( object $controller , $settings )
Main execution method.
Parameters
- object $controller
- A reference to the instantiating controller object
- $settings
read() public ¶
read( mixed $key = null )
Read the value of the $_COOKIE[$key];
Optional [Name.], required key $this->Cookie->read(Name.key);
Parameters
- mixed $key optional null
- Key of the value to be obtained. If none specified, obtain map key => values
Returns
or null, value for specified key
type() public ¶
type( string $type = 'cipher' )
Will allow overriding default encryption method.
Parameters
- string $type optional 'cipher'
- Encryption method
write() public ¶
write( mixed $key , mixed $value = null , boolean $encrypt = true , 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
- mixed $key
- Key for the value
- mixed $value optional null
- Value
- boolean $encrypt optional true
- Set to true to encrypt value, false otherwise
- string $expires optional null
- Can be either Unix timestamp, or date string
Methods inherited from Object
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_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() public ¶
_stop( $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
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_ERROR )
Convience 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_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $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.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
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 only one method is available 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
''
$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 var $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.
'/'