Reference

Search

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Blocks
Icons
Samples

Objects

$asset
$block
$blocks
$file
$files
$kirby
$language
$languages
$layout
$layoutcolumn
$layouts
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit
Panel internals

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

A
Cookie
Data
Dir
Escape
F
Header
Html
I18n
Mime
$query
Server
Str
Tpl
Url
V
Xml

Advanced

All classes
Aliases

new Session()
Creates a new Session instance
$session->commit()
Writes all changes to the session to the session store
$session->data()
Returns the session data object
$session->destroy()
Entirely destroys the session
$session->duration()
Gets or sets the session duration Setting the duration also updates the expiry time and regenerates the session token
$session->ensureToken()
Initially generates the token for new sessions Used internally
$session->expiryTime()
Gets or sets the session expiry time Setting the expiry time also updates the duration and regenerates the session token
$session->mode()
Gets or sets the transmission mode Setting only works for new sessions that haven't been transmitted yet
$session->needsRetransmission()
Returns whether the session token needs to be retransmitted to the client Only relevant in header and manual modes
$session->prepareForWriting()
Puts the session into write mode by acquiring a lock and reloading the data Used internally
$session->regenerateToken()
Regenerates the session token The old token will keep its validity for a 30 second grace period
$session->renew()
Renews the session with the same session duration Renewing also regenerates the session token
$session->renewable()
Gets or sets the renewable flag Automatically renews the session if renewing gets enabled
$session->startTime()
Gets the session start time
$session->timeout()
Gets or sets the session timeout
$session->token()
Gets the session token or null if the session doesn't have a token yet

$session->data()

Returns the session data object

$session->data(): Kirby\Session\SessionData

Return type

Kirby\Session\SessionData

Source code

kirby/src/Session/Session.php#L305