Interface SessionInterface

Interface for the session.

Direct known implementers

Symfony\Component\HttpFoundation\Session\Session

Namespace: Symfony\Component\HttpFoundation\Session
Author: Drak <drak@zikula.org>
Located at SessionInterface.php

Methods summary
`public boolean`	# `start( )` Starts the session storage. Starts the session storage. Returns `boolean` True if session started Throws `RuntimeException` If session fails to start.
`public string`	# `getId( )` Returns the session ID. Returns the session ID. Returns `string` The session ID
`public`	# `setId( string $id )` Sets the session ID. Sets the session ID. Parameters `$id` `string` $id
`public mixed`	# `getName( )` Returns the session name. Returns the session name. Returns `mixed` The session name
`public`	# `setName( string $name )` Sets the session name. Sets the session name. Parameters `$name` `string` $name
`public boolean`	# `invalidate( integer $lifetime = null )` Invalidates the current session. Invalidates the current session. Clears all session attributes and flashes and regenerates the session and deletes the old session from persistence. Parameters `$lifetime` `integer` $lifetime Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp. Returns `boolean` True if session invalidated, false if error
`public boolean`	# `migrate( boolean $destroy = false, integer $lifetime = null )` Migrates the current session to a new session id while maintaining all session attributes. Migrates the current session to a new session id while maintaining all session attributes. Parameters `$destroy` `boolean` $destroy Whether to delete the old session or leave it to garbage collection `$lifetime` `integer` $lifetime Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp. Returns `boolean` True if session migrated, false if error
`public`	# `save( )` Force the session to be saved and closed. Force the session to be saved and closed. This method is generally not required for real sessions as the session will be automatically saved at the end of code execution.
`public boolean`	# `has( string $name )` Checks if an attribute is defined. Checks if an attribute is defined. Parameters `$name` `string` $name The attribute name Returns `boolean` true if the attribute is defined, false otherwise
`public mixed`	# `get( string $name, mixed $default = null )` Returns an attribute. Returns an attribute. Parameters `$name` `string` $name The attribute name `$default` `mixed` $default The default value if not found Returns `mixed`
`public`	# `set( string $name, mixed $value )` Sets an attribute. Sets an attribute. Parameters `$name` `string` $name `$value` `mixed` $value
`public array`	# `all( )` Returns attributes. Returns attributes. Returns `array` Attributes
`public`	# `replace( array $attributes )` Sets attributes. Sets attributes. Parameters `$attributes` `array` $attributes Attributes
`public mixed`	# `remove( string $name )` Removes an attribute. Removes an attribute. Parameters `$name` `string` $name Returns `mixed` The removed value or null when it does not exist
`public`	# `clear( )` Clears all attributes. Clears all attributes.
`public boolean`	# `isStarted( )` Checks if the session was started. Checks if the session was started. Returns `boolean`
`public`	# `registerBag( Symfony\Component\HttpFoundation\Session\SessionBagInterface $bag )` Registers a SessionBagInterface with the session. Registers a SessionBagInterface with the session. Parameters `$bag` `Symfony\Component\HttpFoundation\Session\SessionBagInterface` $bag
`public Symfony\Component\HttpFoundation\Session\SessionBagInterface`	# `getBag( string $name )` Gets a bag instance by name. Gets a bag instance by name. Parameters `$name` `string` $name Returns `Symfony\Component\HttpFoundation\Session\SessionBagInterface`
`public Symfony\Component\HttpFoundation\Session\Storage\MetadataBag`	# `getMetadataBag( )` Gets session meta. Gets session meta. Returns `Symfony\Component\HttpFoundation\Session\Storage\MetadataBag`