$session = new Session;
$session->open();
$value1 = $session['name1'];  // get session variable 'name1'
$value2 = $session['name2'];  // get session variable 'name2'
foreach ($session as $name => $value) // traverse all session variables
$session['name3'] = $value3;  // set session variable 'name3'

public array getAllFlashes ( $delete = false )

public array getCookieParams ( )
public void setCookieParams ( array $value )

public integer getCount ( )

public void setFlash ( $key, $value = true, $removeAfterAccess = true )

public string $flashParam = '__flash'

public float getGCProbability ( )
public void setGCProbability ( $value )

public SessionHandlerInterface|array $handler = null

public boolean getHasSessionId ( )
public void setHasSessionId ( $value )

public string getId ( )
public void setId ( $value )

public boolean getIsActive ( )

public yii\web\SessionIterator getIterator ( )

public string getName ( )
public void setName ( $value )

public string getSavePath ( )
public void setSavePath ( $value )

public integer getTimeout ( )
public void setTimeout ( $value )

public boolean|null getUseCookies ( )
public void setUseCookies ( $value )

public boolean getUseCustomStorage ( )

public boolean getUseTransparentSessionID ( )
public void setUseTransparentSessionID ( $value )

addFlash() public method

Adds a flash message.

If there are existing flash messages with the same key, the new one will be appended to the existing message array.

See also:

• getFlash()
• setFlash()
• removeFlash()

close() public method

Ends the current session and store session data.

closeSession() public method

Session close handler.

This method should be overridden if $useCustomStorage returns true.

count() public method

Returns the number of items in the session.

This method is required by Countable interface.

destroy() public method

Frees all session variables and destroys all data registered to a session.

This method has no effect when session is not active. Make sure to call open() before calling it.

See also:

• open()
• $isActive

destroySession() public method

Session destroy handler.

This method should be overridden if $useCustomStorage returns true.

gcSession() public method

Session GC (garbage collection) handler.

This method should be overridden if $useCustomStorage returns true.

get() public method

Returns the session variable value with the session variable name.

If the session variable does not exist, the $defaultValue will be returned.

getAllFlashes() public method

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.

See also:

• setFlash()
• addFlash()
• getFlash()
• hasFlash()
• removeFlash()

getCookieParams() public method

See also http://php.net/manual/en/function.session-get-cookie-params.php.

getCount() public method

Returns the number of items in the session.

getFlash() public method

Returns a flash message.

See also:

• setFlash()
• addFlash()
• hasFlash()
• getAllFlashes()
• removeFlash()

getGCProbability() public method

getHasSessionId() public method

Returns a value indicating whether the current request has sent the session ID.

The default implementation will check cookie and $_GET using the session name. If you send session ID via other ways, you may need to override this method or call setHasSessionId() to explicitly set whether the session ID is sent.

getId() public method

Gets the session ID.

This is a wrapper for PHP session_id().

getIsActive() public method

getIterator() public method

Returns an iterator for traversing the session variables.

This method is required by the interface IteratorAggregate.

getName() public method

Gets the name of the current session.

This is a wrapper for PHP session_name().

getSavePath() public method

Gets the current session save path.

This is a wrapper for PHP session_save_path().

getTimeout() public method

getUseCookies() public method

Returns the value indicating whether cookies should be used to store session IDs.

See also setUseCookies().

getUseCustomStorage() public method

Returns a value indicating whether to use custom session storage.

This method should be overridden to return true by child classes that implement custom session storage. To implement custom session storage, override these methods: openSession(), closeSession(), readSession(), writeSession(), destroySession() and gcSession().

getUseTransparentSessionID() public method

has() public method

hasFlash() public method

Returns a value indicating whether there are flash messages associated with the specified key.

init() public method

Initializes the application component.

This method is required by IApplicationComponent and is invoked by application.

offsetExists() public method

This method is required by the interface ArrayAccess.

offsetGet() public method

This method is required by the interface ArrayAccess.

offsetSet() public method

This method is required by the interface ArrayAccess.

offsetUnset() public method

This method is required by the interface ArrayAccess.

open() public method

Starts the session.

openSession() public method

Session open handler.

This method should be overridden if $useCustomStorage returns true.

readSession() public method

Session read handler.

This method should be overridden if $useCustomStorage returns true.

regenerateID() public method

Updates the current session ID with a newly generated one.

Please refer to http://php.net/session_regenerate_id for more details.

This method has no effect when session is not active. Make sure to call open() before calling it.

See also:

• open()
• $isActive

registerSessionHandler() protected method

Registers session handler.

remove() public method

Removes a session variable.

removeAll() public method

Removes all session variables

removeAllFlashes() public method

Removes all flash messages.

Note that flash messages and normal session variables share the same name space. If you have a normal session variable using the same name, it will be removed by this method.

See also:

• getFlash()
• setFlash()
• addFlash()
• removeFlash()

removeFlash() public method

Removes a flash message.

See also:

• getFlash()
• setFlash()
• addFlash()
• removeAllFlashes()

set() public method

Adds a session variable.

If the specified name already exists, the old value will be overwritten.

setCookieParams() public method

Sets the session cookie parameters.

The cookie parameters passed to this method will be merged with the result of session_get_cookie_params().

See also http://us2.php.net/manual/en/function.session-set-cookie-params.php.

setFlash() public method

Sets a flash message.

A flash message will be automatically deleted after it is accessed in a request and the deletion will happen in the next request. If there is already an existing flash message with the same key, it will be overwritten by the new one.

See also:

• getFlash()
• addFlash()
• removeFlash()

setGCProbability() public method

setHasSessionId() public method

Sets the value indicating whether the current request has sent the session ID.

This method is provided so that you can override the default way of determining whether the session ID is sent.

setId() public method

Sets the session ID.

This is a wrapper for PHP session_id().

setName() public method

Sets the name for the current session.

This is a wrapper for PHP session_name().

setSavePath() public method

Sets the current session save path.

This is a wrapper for PHP session_save_path().

setTimeout() public method

setUseCookies() public method

Sets the value indicating whether cookies should be used to store session IDs.

Three states are possible:

• true: cookies and only cookies will be used to store session IDs.
• false: cookies will not be used to store session IDs.
• null: if possible, cookies will be used to store session IDs; if not, other mechanisms will be used (e.g. GET parameter)

setUseTransparentSessionID() public method

updateFlashCounters() protected method

Updates the counters for flash messages and removes outdated flash messages.

This method should only be called once in init().

writeSession() public method

Session write handler.

This method should be overridden if $useCustomStorage returns true.