$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()

public void addFlash ( $key, $value = true, $removeAfterAccess = true )
$key	string	The key identifying the flash message.
$value	mixed	Flash message
$removeAfterAccess	boolean	Whether the flash message should be automatically removed only if it is accessed. If false, the flash message will be automatically removed after the next request, regardless if it is accessed or not. If true (default value), the flash message will remain until after it is accessed.

close() public method

Ends the current session and store session data.

public void close ( )

closeSession() public method

Session close handler.

This method should be overridden if $useCustomStorage returns true.

public boolean closeSession ( )
return	boolean	Whether session is closed successfully

count() public method

Returns the number of items in the session.

This method is required by Countable interface.

public integer count ( )
return	integer	Number of items in the session.

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

public void destroy ( )

destroySession() public method

Session destroy handler.

This method should be overridden if $useCustomStorage returns true.

public boolean destroySession ( $id )
$id	string	Session ID
return	boolean	Whether session is destroyed successfully

gcSession() public method

Session GC (garbage collection) handler.

This method should be overridden if $useCustomStorage returns true.

public boolean gcSession ( $maxLifetime )
$maxLifetime	integer	The number of seconds after which data will be seen as 'garbage' and cleaned up.
return	boolean	Whether session is GCed successfully

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.

public mixed get ( $key, $defaultValue = null )
$key	string	The session variable name
$defaultValue	mixed	The default value to be returned when the session variable does not exist.
return	mixed	The session variable value, or $defaultValue if the session variable does not exist.

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()

public array getAllFlashes ( $delete = false )
$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.
return	array	Flash messages (key => message or key => [message1, message2]).

getCookieParams() public method

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

public array getCookieParams ( )
return	array	The session cookie parameters.

getCount() public method

Returns the number of items in the session.

public integer getCount ( )
return	integer	The number of session variables

getFlash() public method

Returns a flash message.

See also:

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

public mixed getFlash ( $key, $defaultValue = null, $delete = false )
$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.
return	mixed	The flash message or an array of messages if addFlash was used

getGCProbability() public method

public float getGCProbability ( )
return	float	The probability (percentage) that the GC (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance.

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.

public boolean getHasSessionId ( )
return	boolean	Whether the current request has sent the session ID.

getId() public method

Gets the session ID.

This is a wrapper for PHP session_id().

public string getId ( )
return	string	The current session ID

getIsActive() public method

public boolean getIsActive ( )
return	boolean	Whether the session has started

getIterator() public method

Returns an iterator for traversing the session variables.

This method is required by the interface IteratorAggregate.

public yii\web\SessionIterator getIterator ( )
return	yii\web\SessionIterator	An iterator for traversing the session variables.

getName() public method

Gets the name of the current session.

This is a wrapper for PHP session_name().

public string getName ( )
return	string	The current session name

getSavePath() public method

Gets the current session save path.

This is a wrapper for PHP session_save_path().

public string getSavePath ( )
return	string	The current session save path, defaults to '/tmp'.

getTimeout() public method

public integer getTimeout ( )
return	integer	The number of seconds after which data will be seen as 'garbage' and cleaned up. The default value is 1440 seconds (or the value of "session.gc_maxlifetime" set in php.ini).

getUseCookies() public method

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

See also setUseCookies().

public boolean|null getUseCookies ( )
return	boolean|null	The value indicating whether cookies should be used to store session IDs.

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().

public boolean getUseCustomStorage ( )
return	boolean	Whether to use custom storage.

getUseTransparentSessionID() public method

public boolean getUseTransparentSessionID ( )
return	boolean	Whether transparent sid support is enabled or not, defaults to false.

has() public method

public boolean has ( $key )
$key	mixed	Session variable name
return	boolean	Whether there is the named session variable

hasFlash() public method

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

public boolean hasFlash ( $key )
$key	string	Key identifying the flash message type
return	boolean	Whether any flash messages exist under specified key

init() public method

Initializes the application component.

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

public void init ( )

offsetExists() public method

This method is required by the interface ArrayAccess.

public boolean offsetExists ( $offset )
$offset	mixed	The offset to check on

offsetGet() public method

This method is required by the interface ArrayAccess.

public mixed offsetGet ( $offset )
$offset	integer	The offset to retrieve element.
return	mixed	The element at the offset, null if no element is found at the offset

offsetSet() public method

This method is required by the interface ArrayAccess.

public void offsetSet ( $offset, $item )
$offset	integer	The offset to set element
$item	mixed	The element value

offsetUnset() public method

This method is required by the interface ArrayAccess.

public void offsetUnset ( $offset )
$offset	mixed	The offset to unset element

open() public method

Starts the session.

public void open ( )

openSession() public method

Session open handler.

This method should be overridden if $useCustomStorage returns true.

public boolean openSession ( $savePath, $sessionName )
$savePath	string	Session save path
$sessionName	string	Session name
return	boolean	Whether session is opened successfully

readSession() public method

Session read handler.

This method should be overridden if $useCustomStorage returns true.

public string readSession ( $id )
$id	string	Session ID
return	string	The session data

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

public void regenerateID ( $deleteOldSession = false )
$deleteOldSession	boolean	Whether to delete the old associated session file or not.

registerSessionHandler() protected method

Registers session handler.

protected void registerSessionHandler ( )
throws	yii\base\InvalidConfigException

remove() public method

Removes a session variable.

public mixed remove ( $key )
$key	string	The name of the session variable to be removed
return	mixed	The removed value, null if no such session variable.

removeAll() public method

Removes all session variables

public void removeAll ( )

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()

public void removeAllFlashes ( )

removeFlash() public method

Removes a flash message.

See also:

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

public mixed removeFlash ( $key )
$key	string	The key identifying the flash message. 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.
return	mixed	The removed flash message. Null if the flash message does not exist.

set() public method

Adds a session variable.

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

public void set ( $key, $value )
$key	string	Session variable name
$value	mixed	Session variable value

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.

public void setCookieParams ( array $value )
$value	array	Cookie parameters, valid keys include: lifetime, path, domain, secure and httponly.
throws	yii\base\InvalidParamException	if the parameters are incomplete.

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()

public void setFlash ( $key, $value = true, $removeAfterAccess = true )
$key	string	The key identifying the flash message. Note that flash messages and normal session variables share the same name space. If you have a normal session variable using the same name, its value will be overwritten by this method.
$value	mixed	Flash message
$removeAfterAccess	boolean	Whether the flash message should be automatically removed only if it is accessed. If false, the flash message will be automatically removed after the next request, regardless if it is accessed or not. If true (default value), the flash message will remain until after it is accessed.

setGCProbability() public method

public void setGCProbability ( $value )
$value	float	The probability (percentage) that the GC (garbage collection) process is started on every session initialization.
throws	yii\base\InvalidParamException	if the value is not between 0 and 100.

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.

public void setHasSessionId ( $value )
$value	boolean	Whether the current request has sent the session ID.

setId() public method

Sets the session ID.

This is a wrapper for PHP session_id().

public void setId ( $value )
$value	string	The session ID for the current session

setName() public method

Sets the name for the current session.

This is a wrapper for PHP session_name().

public void setName ( $value )
$value	string	The session name for the current session, must be an alphanumeric string. It defaults to "PHPSESSID".

setSavePath() public method

Sets the current session save path.

This is a wrapper for PHP session_save_path().

public void setSavePath ( $value )
$value	string	The current session save path. This can be either a directory name or a path alias.
throws	yii\base\InvalidParamException	if the path is not a valid directory

setTimeout() public method

public void setTimeout ( $value )
$value	integer	The number of seconds after which data will be seen as 'garbage' and cleaned up

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)

public void setUseCookies ( $value )
$value	boolean|null	The value indicating whether cookies should be used to store session IDs.

setUseTransparentSessionID() public method

public void setUseTransparentSessionID ( $value )
$value	boolean	Whether transparent sid support is enabled or not.

updateFlashCounters() protected method

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

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

protected void updateFlashCounters ( )

writeSession() public method

Session write handler.

This method should be overridden if $useCustomStorage returns true.

public boolean writeSession ( $id, $data )
$id	string	Session ID
$data	string	Session data
return	boolean	Whether session write is successful