Class CookieComponent

__constructsource public

__construct( ComponentCollection $collection , array $settings array() )

Constructor

Parameters

ComponentCollection $collection

A ComponentCollection for this component

array $settings optional array()

Array of settings.

Overrides

Component::__construct()

_decodesource protected

_decode( string $value )

Decodes and decrypts a single value.

Parameters

string $value

The value to decode & decrypt.

Returns

string
Decoded value.

_decryptsource protected

_decrypt( array $values )

Decrypts $value using public $type method in Security class

Parameters

array $values

Values to decrypt

Returns

string
decrypted string

_deletesource protected

_delete( string $name )

Sets a cookie expire time to remove cookie value

Parameters

string $name

Name of cookie

_encryptsource protected

_encrypt( string $value )

Encrypts $value using public $type method in Security class

Parameters

string $value

Value to encrypt

Returns

string
Encoded values

_expiresource 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

integer
Unix timestamp

_explodesource 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

array
Map of key and values

_implodesource protected

_implode( array $array )

Implode method to keep keys are multidimensional arrays

Parameters

array $array

Map of key and values

Returns

string
A json encoded string.

_writesource protected

_write( string $name , string $value )

Set cookie

Parameters

string $name

Name for cookie

string $value

Value for cookie

checksource public

check( string $key null )

Returns true if given variable is set in cookie.

Parameters

string $key optional null

Variable name to check for

Returns

boolean
True if variable is there

deletesource 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

http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::delete

destroysource 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

http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::destroy

readsource 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

string|null
Value for specified key

Link

http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::read

startupsource public

startup( Controller $controller )

Start CookieComponent for use in the controller

Parameters

Controller $controller

Controller instance.

Overrides

Component::startup()

typesource 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

writesource 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

http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::write

__getsource public

__get( string $name )

Magic method for lazy loading $components.

Parameters

string $name

Name of component to get.

Returns

mixed
A Component object or null.

beforeRedirectsource 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:

• status The status code for the redirect
• exit 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.

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

array|null
Either an array or null.

Link

http://book.cakephp.org/2.0/en/controllers/components.html#Component::beforeRedirect

beforeRendersource 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

http://book.cakephp.org/2.0/en/controllers/components.html#Component::beforeRender

initializesource public

initialize( Controller $controller )

Called before the Controller::beforeFilter().

Parameters

Controller $controller

Controller with components to initialize

Link

http://book.cakephp.org/2.0/en/controllers/components.html#Component::initialize

shutdownsource 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

http://book.cakephp.org/2.0/en/controllers/components.html#Component::shutdown

_mergeVarssource 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.

_setsource 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.

_stopsource 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

dispatchMethodsource 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

mixed
Returns the result of the method call

logsource 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

boolean
Success of log write

requestActionsource 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

mixed
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toStringsource public

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

null

null

'cipher'

array()

''

false

null

'CakeCookie'

'/'

false

null

array()

array()

array()