This class is a wrapper for the native PHP session functions. It provides several defaults for the most common session configuration via external handlers and helps with using session in CLI without any warnings.
Sessions can be created from the defaults using Session::create()
or you can get an instance of a new session by just instantiating this class and passing the complete options you want to use.
When specific options are omitted, this class will take its defaults from the configuration values from the session.*
directives in php.ini. This class will also alter such directives when configuration values are provided.
\SessionHandlerInterface
The Session handler instance used as an engine for persisting the session data.
bool
Whether this session is running under a CLI environment
int
The time in seconds the session will be valid for
bool
Indicates whether the sessions has already started
Used to write new data to _SESSION, since PHP doesn't like us setting the _SESSION var itself.
Returns true if the session is no longer valid because the last time it was accessed was after the configured timeout.
Returns a new instance of a session after building a configuration bundle for it.
Calls ini_set for each of the keys in $options
and set them to the respective value in the passed array.
__construct(array $config)
Constructor.
session.cookie_path
php.ini config. Defaults to base path of app.engine
key. To be used as the session engine for persisting data. The rest of the keys in the array will be passed as the configuration array for the engine. You can set the engine
key to an already instantiated session handler object.array
$config optional The Configuration to apply to this session object
_defaultConfig(string $name)
Get one of the prebaked default session configurations.
string
$name Config name.
array|false
_hasSession()
Returns whether a session exists
bool
_overwrite(array $old, array $new)
Used to write new data to _SESSION, since PHP doesn't like us setting the _SESSION var itself.
array
$old Set of old variables => values
array
$new New set of variable => value
_timedOut()
Returns true if the session is no longer valid because the last time it was accessed was after the configured timeout.
bool
check(?string $name)
Returns true if given variable name is set in session.
string|null
$name optional Variable name to check for
bool
True if variable is there
clear(bool $renew)
Clears the session.
Optionally it also clears the session id and renews the session.
bool
$renew optional If session should be renewed, as well. Defaults to false.
close()
Write data and close the session
true
consume(string $name)
Reads and deletes a variable from session.
string
$name The key to read and remove (or a path as sent to Hash.extract).
mixed|null
The value of the session variable, null if session not available, session not started, or provided name not found in the session.
create(array $sessionConfig)
Returns a new instance of a session after building a configuration bundle for it.
This function allows an options array which will be used for configuring the session and the handler to be used. The most important key in the configuration array is defaults
, which indicates the set of configurations to inherit from, the possible defaults are:
config
key with the name of an already configured Cache engine.sessions
or a model
key in the configuration to indicate which Table object to use.The full list of options follows:
array
$sessionConfig optional Session config.
static
delete(string $name)
Removes a variable from session.
string
$name Session variable to remove
destroy()
Helper method to destroy invalid sessions.
engine(mixed $class, array $options)
Sets the session handler instance to use for this session.
If a string is passed for the first argument, it will be treated as the class name and the second argument will be passed as the first argument in the constructor.
If an instance of a SessionHandlerInterface is provided as the first argument, the handler will be set to it.
If no arguments are passed it will return the currently configured handler instance or null if none exists.
string|\SessionHandlerInterface|null
$class optional The session handler to use
array
$options optional the options to pass to the SessionHandler constructor
\SessionHandlerInterface|null
InvalidArgumentException
id(?string $id)
Returns the session id.
Calling this method will not auto start the session. You might have to manually assert a started session.
Passing an id into it, you can also replace the session id if the session has not already been started. Note that depending on the session handler, not all characters are allowed within the session id. For example, the file session handler only allows characters in the range a-z A-Z 0-9 , (comma) and - (minus).
string|null
$id optional Id to replace the current session id
string
Session id
options(array $options)
Calls ini_set for each of the keys in $options
and set them to the respective value in the passed array.
$session->options(['session.use_cookies' => 1]);
array
$options Ini options to set.
RuntimeException
read(?string $name, mixed $default)
Returns given session variable, or all of them, if no parameters given.
string|null
$name optional The name of the session variable (or a path as sent to Hash.extract)
mixed
$default optional The return value when the path does not exist
mixed|null
The value of the session variable, null if session not available, session not started, or provided name not found in the session.
readOrFail(string $name)
Returns given session variable, or throws Exception if not found.
string
$name The name of the session variable (or a path as sent to Hash.extract)
mixed|null
RuntimeException
renew()
Restarts this session.
setEngine(\SessionHandlerInterface $handler)
Set the engine property and update the session handler in PHP.
\SessionHandlerInterface
$handler The handler to set
\SessionHandlerInterface
start()
Starts the Session.
bool
True if session was started
RuntimeException
started()
Determine if Session has already been started.
bool
True if session has been started.
write(mixed $name, mixed $value)
Writes value to given session variable name.
string|array
$name Name of variable
mixed
$value optional Value to write
The Session handler instance used as an engine for persisting the session data.
\SessionHandlerInterface
Whether this session is running under a CLI environment
bool
The time in seconds the session will be valid for
int
Indicates whether the sessions has already started
bool
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Http.Session.html