Session
- Type
- Class
- Namespace
- craft\web
- Inherits
- craft\web\Session » yii\web\Session » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
- Since
- 3.0
Extends yii\web\Session to add support for setting the session folder and creating it if it doesn’t exist.
Public Properties
| Property | Description |
|---|---|
| allFlashes | array – Flash messages (key => message or key => [message1, message2]). |
| behaviors | yii\base\Behavior – List of behaviors attached to this component |
| cacheLimiter | string |
| cookieParams | array – The session cookie parameters. |
| count | integer – The number of session variables |
| flash | string – The key identifying the flash message. |
| flashParam | string – The name of the session variable that stores the flash message data. |
| gCProbability | float – The probability (percentage) that the GC (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance. |
| handler | SessionHandlerInterface, array – An object implementing the SessionHandlerInterface or a configuration array. |
| hasSessionId | boolean – Whether the current request has sent the session ID. |
| id | string – The current session ID |
| isActive | boolean – Whether the session has started |
| iterator | yii\web\SessionIterator – An iterator for traversing the session variables. |
| name | string – The current session name |
| savePath | string – The current session save path, defaults to '/tmp'. |
| timeout | integer – The number of seconds after which data will be seen as 'garbage' and cleaned up. |
| useCookies | boolean, null – The value indicating whether cookies should be used to store session IDs. |
| useCustomStorage | boolean – Whether to use custom storage. |
| useTransparentSessionID | boolean – Whether transparent sid support is enabled or not, defaults to false. |
allFlashes
- Type
- array
- Access
- Read-only
Flash messages (key => message or key => [message1, message2]).
Public Methods
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of an object property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets value of an object property. |
| __unset() | Sets an object property to null. |
| addFlash() | Adds a flash message. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| close() | Ends the current session and store session data. |
| count() | Returns the number of items in the session. |
| destroy() | Frees all session variables and destroys all data registered to a session. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| get() | Returns the session variable value with the session variable name. |
| getAllFlashes() | Returns all flash messages. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getCacheLimiter() | Returns current cache limiter |
| getCookieParams() | |
| getCount() | Returns the number of items in the session. |
| getFlash() | Returns a flash message. |
| getGCProbability() | |
| getHasSessionId() | Returns a value indicating whether the current request has sent the session ID. |
| getId() | Gets the session ID. |
| getIsActive() | |
| getIterator() | Returns an iterator for traversing the session variables. |
| getName() | Gets the name of the current session. |
| getSavePath() | Gets the current session save path. |
| getTimeout() | |
| getUseCookies() | Returns the value indicating whether cookies should be used to store session IDs. |
| getUseCustomStorage() | Returns a value indicating whether to use custom session storage. |
| getUseTransparentSessionID() | |
| has() | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasFlash() | Returns a value indicating whether there are flash messages associated with the specified key. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| offsetExists() | This method is required by the interface ArrayAccess. |
| offsetGet() | This method is required by the interface ArrayAccess. |
| offsetSet() | This method is required by the interface ArrayAccess. |
| offsetUnset() | This method is required by the interface ArrayAccess. |
| on() | Attaches an event handler to an event. |
| open() | Starts the session. |
| regenerateID() | Updates the current session ID with a newly generated one. |
| remove() | Removes a session variable. |
| removeAll() | Removes all session variables. |
| removeAllFlashes() | Removes all flash messages. |
| removeFlash() | Removes a flash message. |
| set() | Adds a session variable. |
| setCacheLimiter() | Set cache limiter |
| setCookieParams() | Sets the session cookie parameters. |
| setFlash() | Sets a flash message. |
| setGCProbability() | |
| setHasSessionId() | Sets the value indicating whether the current request has sent the session ID. |
| setId() | Sets the session ID. |
| setName() | Sets the name for the current session. |
| setSavePath() | Sets the current session save path. |
| setTimeout() | |
| setUseCookies() | Sets the value indicating whether cookies should be used to store session IDs. |
| setUseTransparentSessionID() | |
| trigger() | Triggers an event. |
behaviors()
Returns a list of behaviors that this component should behave as.
Child classes may override this method to specify the behaviors they want to behave as.
The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
Note that a behavior class must extend from \craft\web\Behavior. Behaviors can be attached using a name or anonymously.
When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior()
or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.
Behaviors declared in this method will be attached to the component automatically (on demand).
Returns
array – The behavior configurations.
getAllFlashes()
Returns all flash messages.
You may use this method to display all the flash messages in a view file:
<?php
foreach (Yii::$app->session->getAllFlashes() as $key => $message) {
echo '<div class="alert alert-' . $key . '">' . $message . '</div>';
} ?>
With the above code you can use the bootstrap alert classes such as success, info, danger
as the flash message key to influence the color of the div.
Note that if you use addFlash(), $message will be an array, and you will have to adjust the above code.
Arguments
$delete(boolean) – Whether to delete the flash messages right after this method is called. If false, the flash messages will be automatically deleted in the next request.
Returns
array – Flash messages (key => message or key => [message1, message2]).
Example
getFlash()
Returns a flash message.
Arguments
$key(string) – The key identifying the flash message$defaultValue(mixed) – Value to be returned if the flash message does not exist.$delete(boolean) – Whether to delete this flash message right after this method is called. If false, the flash message will be automatically deleted in the next request.
Returns
mixed – The flash message or an array of messages if addFlash was used
Example
hasFlash()
Returns a value indicating whether there are flash messages associated with the specified key.
Arguments
$key(string) – Key identifying the flash message type
Returns
boolean – Whether any flash messages exist under specified key
Example
Protected Methods
| Method | Description |
|---|---|
| freeze() | If session is started it's not possible to edit session ini settings. In PHP7.2+ it throws exception. |
| registerSessionHandler() | Registers session handler. |
| unfreeze() | Starts session and restores data from temporary variable |
| updateFlashCounters() | Updates the counters for flash messages and removes outdated flash messages. |