CakeSession Class Reference

Inheritance diagram for CakeSession:

Object SessionComponent SessionHelper

List of all members.


Public Member Functions

 _checkValid ()
 check ($name)
 del ($name)
 destroy ()
 error ()
 id ($id=null)
 ignore ($var)
 read ($name=null)
 renew ()
 start ()
 started ()
 valid ()
 watch ($var)
 write ($name, $value)

Public Attributes

 $_userAgent = ''
 $error = false
 $id = null
 $lastError = null
 $path = '/'
 $security = null
 $sessionTime = false
 $time = false
 $valid = false
 $watchKeys = array()

Detailed Description

Definition at line 48 of file session.php.

Member Function Documentation

CakeSession::_checkValid (  ) 

Helper method to create a new session.

protected

Definition at line 548 of file session.php.

References $time, destroy(), Security::inactiveMins(), Configure::read(), read(), renew(), valid(), and write().

CakeSession::check ( $  name  ) 

Returns true if given variable is set in session.

Parameters:
string $name Variable name to check for
Returns:
boolean True if variable is there public

Reimplemented in SessionComponent, and SessionHelper.

Definition at line 192 of file session.php.

References Set::extract().

Referenced by del().

CakeSession::del ( $  name  ) 

Removes a variable from session.

Parameters:
string $name Session variable to remove
Returns:
boolean Success public

Reimplemented in SessionComponent.

Definition at line 224 of file session.php.

References check(), error(), and Set::remove().

CakeSession::destroy (  ) 

Helper method to destroy invalid sessions.

public

Reimplemented in SessionComponent.

Definition at line 394 of file session.php.

References $file, Configure::read(), and renew().

Referenced by _checkValid().

CakeSession::error (  ) 

Returns last occurred error as a string, if any.

Returns:
mixed Error description as a string, or false. public

Reimplemented in SessionComponent, and SessionHelper.

Definition at line 276 of file session.php.

Referenced by del(), and valid().

CakeSession::id ( $  id = null  ) 

Parameters:
id $name string
Returns:
string Session id public

Reimplemented in SessionComponent.

Definition at line 206 of file session.php.

References $id.

CakeSession::ignore ( $  var  ) 

Tells Session to stop watching a given key path

Parameters:
mixed $var The variable path to watch public

Definition at line 356 of file session.php.

CakeSession::read ( $  name = null  ) 

Returns given session variable, or all of them, if no parameters given.

Parameters:
mixed $name The name of the session variable (or a path as sent to Set.extract)
Returns:
mixed The value of the session variable public

Reimplemented in SessionComponent, and SessionHelper.

Definition at line 309 of file session.php.

References Set::extract().

Referenced by _checkValid(), and valid().

CakeSession::renew (  ) 

Restarts this session.

public

Reimplemented in SessionComponent.

Definition at line 617 of file session.php.

Referenced by _checkValid(), and destroy().

CakeSession::start (  ) 

Starts the Session.

Parameters:
string $name Variable name to check for
Returns:
boolean True if variable is there public

Definition at line 167 of file session.php.

CakeSession::started (  ) 

Determine if Session has been started.

public

Definition at line 179 of file session.php.

CakeSession::valid (  ) 

Returns true if session is valid.

Returns:
boolean Success public

Reimplemented in SessionComponent, and SessionHelper.

Definition at line 289 of file session.php.

References error(), Configure::read(), and read().

Referenced by _checkValid().

CakeSession::watch ( $  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 public

Definition at line 343 of file session.php.

CakeSession::write ( $  name,
$  value 
)

Writes value to given session variable name.

Parameters:
mixed $name Name of variable
string $value Value to write
Returns:
boolean True if the write was successful, false if the write failed public

Reimplemented in SessionComponent.

Definition at line 377 of file session.php.

References Debugger::exportVar(), Set::extract(), and Set::insert().

Referenced by _checkValid().

Member Data Documentation

CakeSession::$_userAgent = ''

Definition at line 69 of file session.php.

CakeSession::$error = false

Definition at line 62 of file session.php.

CakeSession::$id = null

Definition at line 118 of file session.php.

Referenced by id(), and SessionComponent::id().

CakeSession::$lastError = null

Definition at line 83 of file session.php.

CakeSession::$path = '/'

Definition at line 76 of file session.php.

CakeSession::$security = null

Definition at line 90 of file session.php.

CakeSession::$sessionTime = false

Definition at line 104 of file session.php.

CakeSession::$time = false

Definition at line 97 of file session.php.

Referenced by _checkValid().

CakeSession::$valid = false

Definition at line 55 of file session.php.

CakeSession::$watchKeys = array()

Definition at line 111 of file session.php.

The documentation for this class was generated from the following file: