SessionComponent Class Info:
- Class Declaration:
class SessionComponent extends CakeSession
- File name:
- cake/libs/controller/components/session.php
- Description:
Session Component.
Session handling from the controller.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs.controller.components
- Link
- http://book.cakephp.org/view/1310/Sessions
Properties:
-
cookieLifeTime integer
The number of seconds to set for session.cookie_lifetime. 0 means at browser close.
-
error array
Error messages for this session
-
host string
Hostname
-
id string
Current Session id
-
lastError integer
Error number of last occurred error
-
path string
Path to where the session is active.
-
security string
'Security.level' setting, "high", "medium", or "low".
-
sessionTime integer
Time when this session becomes invalid.
-
time integer
Start time for this session.
-
timeout integer
Session timeout multiplier factor
-
_userAgent string
User agent string
-
valid boolean
True if the Session is still valid
-
watchKeys array
Keeps track of keys to watch for writes on
Method Summary:
- activate( $base = NULL )
- cakeError( $method, $messages = array ( ) )
- check( $name )
- _checkValid( )
- __construct( $base = NULL )
- delete( $name )
- destroy( )
- dispatchMethod( $method, $params = array ( ) )
- error( )
- id( $id = NULL )
- ignore( $var )
- log( $msg, $type = 2 )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- read( $name = NULL )
- renew( )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- setFlash( $message, $element = 'default', $params = array ( ), $key = 'flash' )
- start( )
- started( )
- startup( $controller )
- _stop( $status = 0 )
- toString( )
- valid( )
- watch( $var )
- write( $name, $value = NULL )
activate
topStarts Session on if 'Session.start' is set to false in core.php
- Parameters:
-
-
string $base optional NULL
The base path for the Session
-
- Method defined in:
- cake/libs/controller/components/session.php on line 85
- Return
void
- Access
public
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
check
topUsed to check if a session variable is set
In your controller: $this->Session->check('Controller.sessKey');
- Parameters:
-
-
string $name required
the name of the session key you want to check
-
- Method defined in:
- cake/libs/controller/components/session.php on line 171
- Return
boolean true is session variable is set, false if not
- Access
public
- Link
- http://book.cakephp.org/view/1315/check
_checkValid
topHelper method to create a new session.
- Method defined in:
- cake/libs/cake_session.php on line 602
- Return
void
- Access
protected
__construct
topClass constructor
- Parameters:
-
-
string $base optional NULL
The base path for the Session
-
- Method defined in:
- cake/libs/controller/components/session.php on line 57
delete
topWrapper for SessionComponent::del();
In your controller: $this->Session->delete('Controller.sessKey');
- Parameters:
-
-
string $name required
the name of the session key you want to delete
-
- Method defined in:
- cake/libs/controller/components/session.php on line 153
- Return
boolean true is session variable is set and can be deleted, false is variable was not set.
- Access
public
- Link
- http://book.cakephp.org/view/1316/delete
destroy
topUsed to destroy sessions
In your controller: $this->Session->destroy();
- Method defined in:
- cake/libs/controller/components/session.php on line 257
- Return
void
- Access
public
- Link
- http://book.cakephp.org/view/1317/destroy
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
error
topUsed to determine the last error in a session.
In your controller: $this->Session->error();
- Method defined in:
- cake/libs/controller/components/session.php on line 188
- Return
string Last session error
- Access
public
- Link
- http://book.cakephp.org/view/1318/error
id
topReturns Session id
If $id is passed in a beforeFilter, the Session will be started with the specified id
- Parameters:
-
-
$id optional NULL
-
- Method defined in:
- cake/libs/controller/components/session.php on line 274
- Return
string
- Access
public
ignore
topTells Session to stop watching a given key path
- Parameters:
-
-
mixed $var required
The variable path to watch
-
- Method defined in:
- cake/libs/cake_session.php on line 418
- Return
void
- 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
topUsed to read a session values for a key or return values for all keys.
In your controller: $this->Session->read('Controller.sessKey'); Calling the method without a param will return all session vars
- Parameters:
-
-
string $name optional NULL
the name of the session key you want to read
-
- Method defined in:
- cake/libs/controller/components/session.php on line 135
- Return
mixed value from the session vars
- Access
public
- Link
- http://book.cakephp.org/view/1314/read
renew
topUsed to renew a session id
In your controller: $this->Session->renew();
- Method defined in:
- cake/libs/controller/components/session.php on line 225
- Return
void
- 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
setFlash
topUsed 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]
- Parameters:
-
-
string $message required
Message to be flashed
-
string $element optional 'default'
Element to wrap flash message in.
-
array $params optional array ( )
Parameters to be sent to layout as view variables
-
string $key optional 'flash'
Message key, default is 'flash'
-
- Method defined in:
- cake/libs/controller/components/session.php on line 210
- Access
public
- Link
- http://book.cakephp.org/view/1313/setFlash
start
topStarts the Session.
- Method defined in:
- cake/libs/cake_session.php on line 211
- Return
boolean True if session was started
- Access
public
started
topDetermine if Session has been started.
- Method defined in:
- cake/libs/cake_session.php on line 229
- Access
public
- Return
boolean True if session has been started.
startup
topStartup method.
- Parameters:
-
-
object $controller required
Instantiating controller
-
- Method defined in:
- cake/libs/controller/components/session.php on line 72
- Return
void
- 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
valid
topUsed to check for a valid session.
In your controller: $this->Session->valid();
- Method defined in:
- cake/libs/controller/components/session.php on line 240
- Return
boolean true is session is valid, false is session is invalid
- Access
public
watch
topTells Session to write a notification when a certain session path or subpath is written to
- Parameters:
-
-
mixed $var required
The variable path to watch
-
- Method defined in:
- cake/libs/cake_session.php on line 402
- Return
void
- Access
public
write
topUsed to write a value to a session key.
In your controller: $this->Session->write('Controller.sessKey', 'session value');
This should be in a Controller.key format for better organizing
- Parameters:
-
-
string $name required
The name of the key your are setting in the session.
-
string $value optional NULL
The value you want to store in a session.
-
- Method defined in:
- cake/libs/controller/components/session.php on line 105
- Return
boolean Success
- Access
public
- Link
- http://book.cakephp.org/view/1312/write
