SessionInterface
in
Expected behavior of a session container used with CodeIgniter.
Table of Contents
Methods
- destroy() : void
- Destroys the current session.
- get() : mixed
- Get user data that has been set in the session.
- getFlashdata() : mixed
- Retrieve one or more items of flash data from the session.
- getFlashKeys() : array<int, string>
- Retrieve all of the keys for session data marked as flashdata.
- getTempdata() : mixed
- Returns either a single piece of tempdata, or all temp data currently in the session.
- getTempKeys() : array<int, string>
- Retrieve the keys of all session data that have been marked as temporary data.
- has() : bool
- Returns whether an index exists in the session array.
- keepFlashdata() : void
- Keeps a single piece of flash data alive for one more request.
- markAsFlashdata() : bool
- Mark a session property or properties as flashdata. This returns `false` if any of the properties were not already set.
- markAsTempdata() : bool
- Mark one of more pieces of data as being temporary, meaning that it has a set lifespan within the session.
- regenerate() : void
- Regenerates the session ID.
- remove() : void
- Remove one or more session properties.
- removeTempdata() : void
- Removes a single piece of temporary data from the session.
- set() : void
- Sets user data into the session.
- setFlashdata() : void
- Sets data into the session that will only last for a single request.
- setTempdata() : void
- Sets new data into the session, and marks it as temporary data with a set lifespan.
- unmarkFlashdata() : void
- Unmark data in the session as flashdata.
- unmarkTempdata() : void
- Unmarks temporary data in the session, effectively removing its lifespan and allowing it to live as long as the session does.
Methods
destroy()
Destroys the current session.
public
destroy() : void
get()
Get user data that has been set in the session.
public
get([string|null $key = null ]) : mixed
If the property exists as "normal", returns it. Otherwise, returns an array of any temp or flash data values with the property key.
Replaces the legacy method $session->userdata();
Parameters
- $key : string|null = null
-
Identifier of the session property to retrieve
getFlashdata()
Retrieve one or more items of flash data from the session.
public
getFlashdata([string|null $key = null ]) : mixed
If the item key is null, return all flashdata.
Parameters
- $key : string|null = null
-
Property identifier
getFlashKeys()
Retrieve all of the keys for session data marked as flashdata.
public
getFlashKeys() : array<int, string>
Return values
array<int, string>getTempdata()
Returns either a single piece of tempdata, or all temp data currently in the session.
public
getTempdata([string|null $key = null ]) : mixed
Parameters
- $key : string|null = null
-
Session data key
getTempKeys()
Retrieve the keys of all session data that have been marked as temporary data.
public
getTempKeys() : array<int, string>
Return values
array<int, string>has()
Returns whether an index exists in the session array.
public
has(string $key) : bool
Parameters
- $key : string
-
Identifier of the session property we are interested in.
Return values
boolkeepFlashdata()
Keeps a single piece of flash data alive for one more request.
public
keepFlashdata(array<int, string>|string $key) : void
Parameters
- $key : array<int, string>|string
-
Property identifier or array of them
markAsFlashdata()
Mark a session property or properties as flashdata. This returns `false` if any of the properties were not already set.
public
markAsFlashdata(array<int, string>|string $key) : bool
Parameters
- $key : array<int, string>|string
-
Property identifier or array of them
Return values
boolmarkAsTempdata()
Mark one of more pieces of data as being temporary, meaning that it has a set lifespan within the session.
public
markAsTempdata(array<string, mixed>|array<int, string>|string $key[, int $ttl = 300 ]) : bool
Returns false
if any of the properties were not set.
Parameters
- $key : array<string, mixed>|array<int, string>|string
-
Property identifier or array of them
- $ttl : int = 300
-
Time to live, in seconds
Return values
boolregenerate()
Regenerates the session ID.
public
regenerate([bool $destroy = false ]) : void
Parameters
- $destroy : bool = false
-
Should old session data be destroyed?
remove()
Remove one or more session properties.
public
remove(array<int, string>|string $key) : void
If $key is an array, it is interpreted as an array of string property identifiers to remove. Otherwise, it is interpreted as the identifier of a specific session property to remove.
Parameters
- $key : array<int, string>|string
-
Identifier of the session property or properties to remove.
removeTempdata()
Removes a single piece of temporary data from the session.
public
removeTempdata(string $key) : void
Parameters
- $key : string
-
Session data key
set()
Sets user data into the session.
public
set(array<string, mixed>|array<int, string>|string $data[, mixed $value = null ]) : void
If $data is a string, then it is interpreted as a session property key, and $value is expected to be non-null.
If $data is an array, it is expected to be an array of key/value pairs to be set as session properties.
Parameters
- $data : array<string, mixed>|array<int, string>|string
-
Property name or associative array of properties
- $value : mixed = null
-
Property value if single key provided
setFlashdata()
Sets data into the session that will only last for a single request.
public
setFlashdata(array<string, mixed>|string $data[, mixed $value = null ]) : void
Perfect for use with single-use status update messages.
If $data is an array, it is interpreted as an associative array of key/value pairs for flashdata properties. Otherwise, it is interpreted as the identifier of a specific flashdata property, with $value containing the property value.
Parameters
- $data : array<string, mixed>|string
-
Property identifier or associative array of properties
- $value : mixed = null
-
Property value if $data is a scalar
setTempdata()
Sets new data into the session, and marks it as temporary data with a set lifespan.
public
setTempdata(array<string, mixed>|array<int, string>|string $data[, mixed $value = null ][, int $ttl = 300 ]) : void
Parameters
- $data : array<string, mixed>|array<int, string>|string
-
Session data key or associative array of items
- $value : mixed = null
-
Value to store
- $ttl : int = 300
-
Time-to-live in seconds
unmarkFlashdata()
Unmark data in the session as flashdata.
public
unmarkFlashdata(array<int, string>|string $key) : void
Parameters
- $key : array<int, string>|string
-
Property identifier or array of them
unmarkTempdata()
Unmarks temporary data in the session, effectively removing its lifespan and allowing it to live as long as the session does.
public
unmarkTempdata(array<int, string>|string $key) : void
Parameters
- $key : array<int, string>|string
-
Property identifier or array of them