Session
class Session
Provides access to session sections as well as session settings and management methods.
Constants
| private DEFAULT_FILE_LIFETIME |
Default file lifetime |
| private SECURITY_OPTIONS |
|
Properties
| $onStart | |||
| $onBeforeWrite |
Methods
Starts and initializes session data.
No description
No description
Has been session started?
Ends the current session and store session data.
Destroys all data registered to a session.
Does session exist for the current request?
Regenerates the session ID.
Returns the current session ID. Don't make dependencies, can be changed for each request.
Gets the session name.
Returns specified session section.
Checks if a session section exist and is not empty.
Sets session options.
Returns all session options.
Sets the amount of time (like '20 minutes') allowed between requests before the session will be terminated, null means "for a maximum of 3 hours or until the browser is closed".
Sets the session cookie parameters.
Sets path of the directory used to save session data.
Details
at line 80
void
start()
Starts and initializes session data.
at line 136
void
autoStart(bool $forWrite)
| internal |
No description
at line 192
__destruct()
No description
at line 201
bool
isStarted()
Has been session started?
at line 210
void
close()
Ends the current session and store session data.
at line 223
void
destroy()
Destroys all data registered to a session.
at line 243
bool
exists()
Does session exist for the current request?
at line 254
void
regenerateId()
Regenerates the session ID.
at line 277
string
getId()
Returns the current session ID. Don't make dependencies, can be changed for each request.
at line 286
Session
setName(string $name)
Sets the session name to a specified one.
at line 302
string
getName()
Gets the session name.
at line 314
SessionSection
getSection(string $section, string $class = SessionSection::class)
Returns specified session section.
at line 323
bool
hasSection(string $section)
Checks if a session section exist and is not empty.
at line 334
Iterator
getIterator()
deprecated
deprecated
No description
at line 385
Session
setOptions(array $options)
Sets session options.
at line 433
array
getOptions()
Returns all session options.
at line 489
Session
setExpiration(string|null $time)
Sets the amount of time (like '20 minutes') allowed between requests before the session will be terminated, null means "for a maximum of 3 hours or until the browser is closed".
at line 510
Session
setCookieParameters(string $path, string|null $domain = null, bool|null $secure = null, string|null $sameSite = null)
Sets the session cookie parameters.
at line 528
Session
setSavePath(string $path)
Sets path of the directory used to save session data.
at line 539
Session
setHandler(SessionHandlerInterface $handler)
Sets user session handler.
Traits
Strict class for better experience.