SessionInterface

interface SessionInterface

Interface for the session.

Methods

bool	start() Starts the session storage.
string	getId() Returns the session ID.
	setId(string $id) Sets the session ID.
mixed	getName() Returns the session name.
	setName(string $name) Sets the session name.
bool	invalidate(int $lifetime = null) Invalidates the current session.
bool	migrate(bool $destroy = false, int $lifetime = null) Migrates the current session to a new session id while maintaining all session attributes.
	save() Force the session to be saved and closed.
bool	has(string $name) Checks if an attribute is defined.
mixed	get(string $name, mixed $default = null) Returns an attribute.
	set(string $name, mixed $value) Sets an attribute.
array	all() Returns attributes.
	replace(array $attributes) Sets attributes.
mixed	remove(string $name) Removes an attribute.
	clear() Clears all attributes.
bool	isStarted() Checks if the session was started.
	registerBag(SessionBagInterface $bag) Registers a SessionBagInterface with the session.
SessionBagInterface	getBag(string $name) Gets a bag instance by name.
MetadataBag	getMetadataBag() Gets session meta.

Details

bool start()

Starts the session storage.

Return Value

bool	True if session started

Exceptions

RuntimeException

If session fails to start.

string getId()

Returns the session ID.

Return Value

string

The session ID

setId(string $id)

Sets the session ID.

Parameters

string

$id

mixed getName()

Returns the session name.

Return Value

mixed

The session name

setName(string $name)

Sets the session name.

Parameters

string

$name

bool invalidate(int $lifetime = null)

Invalidates the current session.

Clears all session attributes and flashes and regenerates the session and deletes the old session from persistence.

Parameters

int

$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.

Return Value

bool	True if session invalidated, false if error

bool migrate(bool $destroy = false, int $lifetime = null)

Migrates the current session to a new session id while maintaining all session attributes.

Parameters

bool	$destroy	Whether to delete the old session or leave it to garbage collection
int	$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.

Return Value

bool	True if session migrated, false if error

save()

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.

bool has(string $name)

Checks if an attribute is defined.

Parameters

string

$name

The attribute name

Return Value

bool	true if the attribute is defined, false otherwise

mixed get(string $name, mixed $default = null)

Returns an attribute.

Parameters

string	$name	The attribute name
mixed	$default	The default value if not found

Return Value

mixed

set(string $name, mixed $value)

Sets an attribute.

Parameters

string	$name
mixed	$value

array all()

Returns attributes.

Return Value

array

Attributes

replace(array $attributes)

Sets attributes.

Parameters

array

$attributes

Attributes

mixed remove(string $name)

Removes an attribute.

Parameters

string

$name

Return Value

mixed

The removed value or null when it does not exist

clear()

Clears all attributes.

bool isStarted()

Checks if the session was started.

Return Value

bool

registerBag(SessionBagInterface $bag)

Registers a SessionBagInterface with the session.

Parameters

SessionBagInterface

$bag

SessionBagInterface getBag(string $name)

Gets a bag instance by name.

Parameters

string

$name

Return Value

SessionBagInterface

MetadataBag getMetadataBag()

Gets session meta.

Return Value

MetadataBag

Links:

http://api.symfony.com/master/Symfony/Component/HttpFoundation/Session/SessionInterface.html

doc_Symfony

2016-10-28 06:32:20

Comments