Interface Symfony\Component\HttpFoundation\Session\SessionInterface


					
	public

start(): bool

Starts the session storage.

Throws

RuntimeException

if session fails to start

#


					
	public

getId(): string

Returns the session ID.

#


					
	public

setId(string $id): void

Sets the session ID.

#


					
	public

getName(): string

Returns the session name.

#


					
	public

setName(string $name): void

Sets the session name.

#


					
	public

invalidate(int|null $lifetime = null): bool

Invalidates the current session.

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

Parameters

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

#


					
	public

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

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

Parameters

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

#


					
	public

save(): void

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

has(string $name): bool

Checks if an attribute is defined.

#


					
	public

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

Returns an attribute.

#


					
	public

set(string $name, mixed $value): void

Sets an attribute.

#


					
	public

all(): array

Returns attributes.

#


					
	public

replace(array $attributes): void

Sets attributes.

#


					
	public

remove(string $name): mixed

Removes an attribute.

Returns

The removed value or null when it does not exist

#


					
	public

clear(): void

Clears all attributes.

#


					
	public

isStarted(): bool

Checks if the session was started.

#


					
	public

registerBag(SessionBagInterface $bag): void

Registers a SessionBagInterface with the session.

#


					
	public

getBag(string $name): SessionBagInterface

Gets a bag instance by name.

#


					
	public

getMetadataBag(): MetadataBag

Gets session meta.

#

Namespaces

Interfaces

Interface Symfony\Component\HttpFoundation\Session\SessionInterface

Throws

Parameters

Parameters

Returns