The CakePHP SessionComponent provides a way to persist client data between page requests. It acts as a wrapper for the $_SESSION
as well as providing convenience methods for several $_SESSION
related functions.
check( string $name )
Checks if a session variable is set.
In your controller: $this->Session->check('Controller.sessKey');
$name
boolean
consume( string $name )
Reads and deletes a session value for a key.
In your controller: $this->Session->consume('Controller.sessKey');
$name
mixed
delete( string $name )
Deletes a session value for a key.
In your controller: $this->Session->delete('Controller.sessKey');
$name
boolean
destroy( )
Used to destroy sessions
In your controller: $this->Session->destroy();
error( )
Used to determine the last error in a session.
In your controller: $this->Session->error();
string
id( string $id null )
Get/Set the session id.
When fetching the session id, the session will be started if it has not already been started. When setting the session id, the session will not be started.
$id
optional null string
read( string $name null )
Reads a session value for a key or returns values for all keys.
In your controller: $this->Session->read('Controller.sessKey'); Calling the method without a param will return all session vars
$name
optional null mixed
setFlash( string $message , string $element 'default' , array $params array() , string $key 'flash' )
Used to set a session variable that can be used to output messages in the view.
In your controller: $this->Session->setFlash('This has been saved');
Additional params below can be passed to customize the output, or the Message.[key]. You can also set additional parameters when rendering flash messages. See SessionHelper::flash() for more information on how to do that.
$message
$element
optional 'default' $params
optional array() $key
optional 'flash' started( )
Returns a bool, whether or not the session has been started.
boolean
userAgent( string $userAgent null )
Get / Set the userAgent
$userAgent
optional null string
valid( )
Used to check for a valid session.
In your controller: $this->Session->valid();
boolean
write( string $name , string $value null )
Writes a value to a session key.
In your controller: $this->Session->write('Controller.sessKey', 'session value');
$name
$value
optional null boolean
__construct( ComponentCollection $collection , array $settings array() )
Constructor
ComponentCollection
$collection
$settings
optional array() Object::__construct()
__get( string $name )
Magic method for lazy loading $components.
$name
mixed
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 array|null
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
startup( Controller $controller )
Called after the Controller::beforeFilter() and before the controller action
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() mixed
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 boolean
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
$extra
optional array() mixed
toString( )
Object-to-string conversion. Each class can override this method as necessary.
string
protected ComponentCollection
Component collection class used to lazy load components.
protected array
A component lookup table used to lazy load component objects.
array()
© 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.7/class-SessionComponent.html