/ cake / libs / controller / components / cookie.php
Defined Classes
CookieComponent Class Info:
- Class Declaration:
class CookieComponent extends Object
- File name:
- cake/libs/controller/components/cookie.php
- Description:
Cookie Component.
Cookie handling for the controller.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs.controller.components
- Link
- http://book.cakephp.org/view/1280/Cookies
Properties:
-
domain 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
-
key string
Encryption key.
Overridden with the controller beforeFilter(); $this->Cookie->key = 'SomeRandomString';
-
name string
The name of the cookie.
Overridden with the controller beforeFilter(); $this->Cookie->name = 'CookieName';
-
path 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 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.
-
secure 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.
-
time 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';
Method Summary:
- cakeError( $method, $messages = array ( ) )
- __construct( )
- delete( $key )
- destroy( )
- dispatchMethod( $method, $params = array ( ) )
- initialize( $controller, $settings )
- log( $msg, $type = 2 )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- read( $key = NULL )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- startup( )
- _stop( $status = 0 )
- toString( )
- type( $type = 'cipher' )
- write( $key, $value = NULL, $encrypt = true, $expires = NULL )
cakeError
topUsed 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 required
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
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
__construct
topClass constructor, overridden in descendant classes.
- Method defined in:
- cake/libs/object.php on line 54
delete
topDelete 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 required
Key of the value to be deleted
-
- Method defined in:
- cake/libs/controller/components/cookie.php on line 276
- Return
void
- Access
public
destroy
topDestroy 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.
- Method defined in:
- cake/libs/controller/components/cookie.php on line 299
- Return
void
- Access
public
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
initialize
topMain execution method.
- Parameters:
-
-
object $controller required
A reference to the instantiating controller object
-
$settings required
-
- Method defined in:
- cake/libs/controller/components/cookie.php on line 166
- Access
public
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA 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()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
_persist
topChecks 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 required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
read
topRead 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
-
- Method defined in:
- cake/libs/controller/components/cookie.php on line 240
- Return
string or null, value for specified key
- Access
public
requestAction
topCalls 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 required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows 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.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
startup
topStart CookieComponent for use in the controller
- Method defined in:
- cake/libs/controller/components/cookie.php on line 176
- Access
public
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
type
topWill allow overriding default encryption method.
- Parameters:
-
-
string $type optional 'cipher'
Encryption method
-
- Method defined in:
- cake/libs/controller/components/cookie.php on line 323
- Access
public
- Todo
NOT IMPLEMENTED
write
topWrite 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 required
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
-
- Method defined in:
- cake/libs/controller/components/cookie.php on line 202
- Access
public
