CakeSession Class Info:
- Class Declaration:
class CakeSession extends Object
- File name:
- cake/libs/cake_session.php
- Description:
Session class for Cake.
Cake abstracts the handling of sessions. There are several convenient methods to access session information. This class is the implementation of those methods. They are mostly used by the Session Component.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs
Properties:
-
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 ineteger
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:
- cakeError( $method, $messages = array ( ) )
- check( $name )
- _checkValid( )
- __close( )
- __construct( $base = NULL, $start = true )
- delete( $name )
- destroy( )
- __destroy( $id )
- dispatchMethod( $method, $params = array ( ) )
- __error( $errorNumber )
- error( )
- __gc( $expires = NULL )
- id( $id = NULL )
- ignore( $var )
- __initSession( )
- log( $msg, $type = 2 )
- Object( )
- __open( )
- __openPersistent( $name, $type = NULL )
- __overwrite( $old, $new )
- _persist( $name, $return, $object, $type = NULL )
- read( $name = NULL )
- __read( $id )
- __regenerateId( )
- renew( )
- requestAction( $url, $extra = array ( ) )
- __returnSessionVars( )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- __setError( $errorNumber, $errorMessage )
- start( )
- started( )
- __startSession( )
- _stop( $status = 0 )
- toString( )
- valid( )
- watch( $var )
- __write( $id, $data )
- write( $name, $value )
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
topReturns true if given variable is set in session.
- Parameters:
-
-
string $name required
Variable name to check for
-
- Method defined in:
- cake/libs/cake_session.php on line 235
- Return
boolean True if variable is there
- Access
public
_checkValid
topHelper method to create a new session.
- Method defined in:
- cake/libs/cake_session.php on line 602
- Return
void
- Access
protected
__close
topMethod called on close of a database session.
- Method defined in:
- cake/libs/cake_session.php on line 709
- Return
boolean Success
- Access
private
__construct
topConstructor.
- Parameters:
-
-
string $base optional NULL
The base path for the Session
-
boolean $start optional true
Should session be started right now
-
- Method defined in:
- cake/libs/cake_session.php on line 140
- Access
public
delete
topRemoves a variable from session.
- Parameters:
-
-
string $name required
Session variable to remove
-
- Method defined in:
- cake/libs/cake_session.php on line 269
- Return
boolean Success
- Access
public
destroy
topHelper method to destroy invalid sessions.
- Method defined in:
- cake/libs/cake_session.php on line 448
- Return
void
- Access
public
__destroy
topMethod called on the destruction of a database session.
- Parameters:
-
-
integer $id required
ID that uniquely identifies session in database
-
- Method defined in:
- cake/libs/cake_session.php on line 767
- Return
boolean True for successful delete, false otherwise.
- Access
private
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
topReturn error description for given error number.
- Parameters:
-
-
integer $errorNumber required
Error to set
-
- Method defined in:
- cake/libs/cake_session.php on line 308
- Return
string Error as string
- Access
private
error
topReturns last occurred error as a string, if any.
- Method defined in:
- cake/libs/cake_session.php on line 322
- Return
mixed Error description as a string, or false.
- Access
public
__gc
topHelper function called on gc for database sessions.
- Parameters:
-
-
integer $expires optional NULL
Timestamp (defaults to current time)
-
- Method defined in:
- cake/libs/cake_session.php on line 781
- Return
boolean Success
- Access
private
id
topReturns the Session id
- Parameters:
-
-
$id optional NULL
-
- Method defined in:
- cake/libs/cake_session.php on line 250
- Return
string Session id
- 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 410
- Return
void
- Access
public
__initSession
topHelper method to initialize a session, based on Cake core settings.
- Method defined in:
- cake/libs/cake_session.php on line 461
- Access
private
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
__open
topMethod called on open of a database session.
- Method defined in:
- cake/libs/cake_session.php on line 699
- Return
boolean Success
- Access
private
__openPersistent
topOpen the persistent class file for reading Used by Object::_persist()
- Parameters:
-
-
string $name required
Name of persisted class
-
string $type optional NULL
Type of persistance (e.g: registry)
-
- Method defined in:
- cake/libs/object.php on line 268
- Return
void
- Access
private
__overwrite
topUsed to write new data to _SESSION, since PHP doesn't like us setting the _SESSION var itself
- Parameters:
-
-
array $old required
Set of old variables => values
-
array $new required
New set of variable => value
-
- Method defined in:
- cake/libs/cake_session.php on line 288
- Access
private
_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
topReturns given session variable, or all of them, if no parameters given.
- Parameters:
-
-
mixed $name optional NULL
The name of the session variable (or a path as sent to Set.extract)
-
- Method defined in:
- cake/libs/cake_session.php on line 357
- Return
mixed The value of the session variable
- Access
public
__read
topMethod used to read from a database session.
- Parameters:
-
-
mixed $id required
The key of the value to read
-
- Method defined in:
- cake/libs/cake_session.php on line 731
- Return
mixed The value of the key or false if it does not exist
- Access
private
__regenerateId
topHelper method to restart a session.
- Method defined in:
- cake/libs/cake_session.php on line 638
- Return
void
- Access
private
renew
toprequestAction
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
__returnSessionVars
topReturns all session variables.
- Method defined in:
- cake/libs/cake_session.php on line 379
- Return
mixed Full $_SESSION array, or false on error.
- Access
private
_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
__setError
topHelper method to set an internal error message.
- Parameters:
-
-
integer $errorNumber required
Number of the error
-
string $errorMessage required
Description of the error
-
- Method defined in:
- cake/libs/cake_session.php on line 685
- Return
void
- Access
private
start
topStarts the Session.
- Method defined in:
- cake/libs/cake_session.php on line 203
- 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 221
- Access
public
- Return
boolean True if session has been started.
__startSession
topHelper method to start a session
- Method defined in:
- cake/libs/cake_session.php on line 579
- Access
private
_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
topReturns true if session is valid.
- Method defined in:
- cake/libs/cake_session.php on line 336
- Return
boolean Success
- 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 394
- Return
void
- Access
public
__write
topHelper function called on write for database sessions.
- Parameters:
-
-
integer $id required
ID that uniquely identifies session in database
-
mixed $data required
The value of the the data to be saved.
-
- Method defined in:
- cake/libs/cake_session.php on line 753
- Return
boolean True for successful write, false otherwise.
- Access
private
write
topWrites value to given session variable name.
- Parameters:
-
-
mixed $name required
Name of variable
-
string $value required
Value to write
-
- Method defined in:
- cake/libs/cake_session.php on line 431
- Return
boolean True if the write was successful, false if the write failed
- Access
public
