Class SessionComponent

Session Component.

Session handling from the controller.

Object

CakeSession

SessionComponent

Package: cake\cake\libs\controller\components
Link: http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Sessions.html#Sessions
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: controller/components/session.php

Properties summary

$__active public

boolean

Used to determine if methods implementation is used, or bypassed
$__bare public

boolean

Used to determine if request are from an Ajax request

Inherited Properties

_userAgent, cookieLifeTime, error, host, id, lastError, path, security, sessionTime, time, timeout, valid, watchKeys

Method Summary

__construct() public

Class constructor
__start() public

Starts Session if SessionComponent is used in Controller::beforeFilter(), or is called from
activate() public

Starts Session on if 'Session.start' is set to false in core.php
check() public

Used to check if a session variable is set
delete() public

Wrapper for SessionComponent::del();
destroy() public

Used to destroy sessions
error() public

Used to determine the last error in a session.
id() public

Returns Session id
read() public

Used to read a session values for a key or return values for all keys.
renew() public

Used to renew a session id
setFlash() public

Used to set a session variable that can be used to output messages in the view.
startup() public

Startup method.
valid() public

Used to check for a valid session.
write() public

Used to write a value to a session key.

Method Detail

__construct() public ¶

__construct( string $base = null )

Class constructor

Parameters

string $base optional null: The base path for the Session

Overrides

CakeSession::__construct()

__start() public ¶

__start( )

Starts Session if SessionComponent is used in Controller::beforeFilter(), or is called from

Returns

boolean

activate() public ¶

activate( string $base = null )

Starts Session on if 'Session.start' is set to false in core.php

Parameters

string $base optional null: The base path for the Session

check() public ¶

check( string $name )

Used to check if a session variable is set

In your controller: $this->Session->check('Controller.sessKey');

Parameters

string $name: the name of the session key you want to check

Returns

boolean
true is session variable is set, false if not

Link

http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Sessions.html#check

Overrides

CakeSession::check()

delete() public ¶

delete( string $name )

Wrapper for SessionComponent::del();

In your controller: $this->Session->delete('Controller.sessKey');

Parameters

string $name: the name of the session key you want to delete

Returns

boolean
true is session variable is set and can be deleted, false is variable was not set.

Link

http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Sessions.html#delete

Overrides

CakeSession::delete()

destroy() public ¶

destroy( )

Used to destroy sessions

In your controller: $this->Session->destroy();

Link

http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Sessions.html#destroy

Overrides

CakeSession::destroy()

error() public ¶

error( )

Used to determine the last error in a session.

In your controller: $this->Session->error();

Returns

string
Last session error

Link

http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Sessions.html#error

Overrides

CakeSession::error()

id() public ¶

id( $id = null )

Returns Session id

If $id is passed in a beforeFilter, the Session will be started with the specified id

Parameters

$id optional null: string

Returns

string

Overrides

CakeSession::id()

read() public ¶

read( string $name = null )

Used 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

Returns

mixed
value from the session vars

Link

http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Sessions.html#read

Overrides

CakeSession::read()

renew() public ¶

renew( )

Used to renew a session id

In your controller: $this->Session->renew();

Overrides

CakeSession::renew()

setFlash() public ¶

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]

Parameters

string $message: 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'

Link

http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Sessions.html#setFlash

startup() public ¶

startup( object $controller )

Startup method.

Parameters

object $controller: Instantiating controller

valid() public ¶

valid( )

Used to check for a valid session.

In your controller: $this->Session->valid();

Returns

boolean
true is session is valid, false is session is invalid

Overrides

CakeSession::valid()

write() public ¶

write( string $name , string $value = null )

Used to write a value to a session key.

In your controller: $this->Session->write('Controller.sessKey', 'session value');

Parameters

string $name: The name of the key your are setting in the session. This should be in a Controller.key format for better organizing
string $value optional null: The value you want to store in a session.

Returns

boolean
Success

Link

http://book.cakephp.org/1.3/en/The-Manual/Core-Components/Sessions.html#write

Overrides

CakeSession::write()

Methods inherited from CakeSession

__close() public ¶

__close( )

Method called on close of a database session.

Returns

boolean
Success

__destroy() public ¶

__destroy( integer $id )

Method called on the destruction of a database session.

Parameters

integer $id: ID that uniquely identifies session in database

Returns

boolean
True for successful delete, false otherwise.

__error() public ¶

__error( integer $errorNumber )

Return error description for given error number.

Parameters

integer $errorNumber: Error to set

Returns

string
Error as string

__gc() public ¶

__gc( integer $expires = null )

Helper function called on gc for database sessions.

Parameters

integer $expires optional null: Timestamp (defaults to current time)

Returns

boolean
Success

__initSession() public ¶

__initSession( )

Helper method to initialize a session, based on Cake core settings.

__open() public ¶

__open( )

Method called on open of a database session.

Returns

boolean
Success

__overwrite() public ¶

__overwrite( array $old , array $new )

Used to write new data to _SESSION, since PHP doesn't like us setting the _SESSION var itself

Parameters

array $old: Set of old variables => values
array $new: New set of variable => value

__read() public ¶

__read( mixed $id )

Method used to read from a database session.

Parameters

mixed $id: The key of the value to read

Returns

mixed
The value of the key or false if it does not exist

__regenerateId() public ¶

__regenerateId( )

Helper method to restart a session.

__returnSessionVars() public ¶

__returnSessionVars( )

Returns all session variables.

Returns

mixed
Full $_SESSION array, or false on error.

__setError() public ¶

__setError( integer $errorNumber , string $errorMessage )

Helper method to set an internal error message.

Parameters

integer $errorNumber: Number of the error
string $errorMessage: Description of the error

__startSession() public ¶

__startSession( )

Helper method to start a session

__write() public ¶

__write( integer $id , mixed $data )

Helper function called on write for database sessions.

Parameters

integer $id: ID that uniquely identifies session in database
mixed $data: The value of the data to be saved.

Returns

boolean
True for successful write, false otherwise.

_checkValid() public ¶

_checkValid( )

Helper method to create a new session.

ignore() public ¶

ignore( mixed $var )

Tells Session to stop watching a given key path

Parameters

mixed $var: The variable path to watch

start() public ¶

start( )

Starts the Session.

Returns

boolean
True if session was started

started() public ¶

started( )

Determine if Session has been started.

Returns

boolean
True if session has been started.

watch() public ¶

watch( mixed $var )

Tells Session to write a notification when a certain session path or subpath is written to

Parameters

mixed $var: The variable path to watch

Methods inherited from 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

Object

__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

boolean
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

boolean
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

error
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

mixed
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

boolean
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

mixed

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

string
The name of this class

Properties detail

`$__active` ¶

public boolean

Used to determine if methods implementation is used, or bypassed

true

`$__bare` ¶

public boolean

Used to determine if request are from an Ajax request

Classes

Functions

Class SessionComponent

Properties summary

Inherited Properties

Method Summary

__construct() public

__start() public

activate() public

check() public

delete() public

destroy() public

error() public

id() public

read() public

renew() public

setFlash() public

startup() public

valid() public

write() public

Method Detail

__construct() public ¶

Parameters

Overrides

__start() public ¶

Returns

activate() public ¶

Parameters

check() public ¶

Parameters

Returns

Link

Overrides

delete() public ¶

Parameters

Returns

Link

Overrides

destroy() public ¶

Link

Overrides

error() public ¶

Returns

Link

Overrides

id() public ¶

Parameters

Returns

Overrides

read() public ¶

Parameters

Returns

Link

Overrides

renew() public ¶

Overrides

setFlash() public ¶

Parameters

Link

startup() public ¶

Parameters

valid() public ¶

Returns

Overrides

write() public ¶

Parameters

Returns

Link

Overrides

Methods inherited from CakeSession

__close() public ¶

Returns

__destroy() public ¶

Parameters

Returns

__error() public ¶

Parameters

Returns

__gc() public ¶

Parameters

`$__active` ¶

`$__bare` ¶