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:
-
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:
- cakeError( $method, $messages = array ( ) )
- check( $name )
- _checkValid( )
- __construct( $base = NULL, $start = true )
- 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 ( ) )
- start( )
- started( )
- _stop( $status = 0 )
- toString( )
- valid( )
- watch( $var )
- 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 243
- 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
__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 151
- 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 277
- Return
boolean Success
- Access
public
destroy
topHelper method to destroy invalid sessions.
- Method defined in:
- cake/libs/cake_session.php on line 456
- Return
void
- Access
public
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
topReturns last occurred error as a string, if any.
- Method defined in:
- cake/libs/cake_session.php on line 330
- Return
mixed Error description as a string, or false.
- Access
public
id
topReturns the Session id
- Parameters:
-
-
$id optional NULL
-
- Method defined in:
- cake/libs/cake_session.php on line 258
- 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 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
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 365
- Return
mixed The value of the session variable
- Access
public
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
_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
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.
_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 344
- 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 402
- Return
void
- Access
public
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 439
- Return
boolean True if the write was successful, false if the write failed
- Access
public
