1. class
  2. Nette
  3. \
  4. Http
  5. \
  6. SessionSection

SessionSection

class SessionSection implements IteratorAggregate, ArrayAccess

Session section.

Properties

$warnOnUndefined

Emits a warning when accessing an undefined variable in this section

Methods

__construct(Session $session, string $name)

Do not call directly. Use Session::getSection().

Iterator
getIterator()

Returns an iterator over all section variables.

void
set(string $name, mixed $value, string|null $expire = null)

Sets a variable in this session section. Passing null removes it.

mixed
get(string $name)

Gets a variable from this session section.

void
remove(string|array|null $name = null)

Removes a variable or a list of variables from this section. With no argument, removes the entire section.

void
__set(string $name, mixed $value) deprecated

Sets a variable in this session section.

mixed
__get(string $name) deprecated

Gets a variable from this session section.

bool
__isset(string $name) deprecated

Determines whether a variable in this session section is set.

void
__unset(string $name) deprecated

Unsets a variable in this session section.

void
offsetSet($name, $value) deprecated

Sets a variable in this session section.

mixed
offsetGet($name) deprecated

Gets a variable from this session section.

bool
offsetExists($name) deprecated

Determines whether a variable in this session section is set.

void
offsetUnset($name) deprecated

Unsets a variable in this session section.

SessionSection
setExpiration(string|null $expire, string|array|null $variables = null)

Sets the expiration time for the whole section or for specific variables.

void
removeExpiration(string|array|null $variables = null)

Removes the expiration from the whole section or from specific variables.

Details

at line 27
__construct(Session $session, string $name)

Do not call directly. Use Session::getSection().

Parameters

Session $session
string $name

at line 38
Iterator getIterator()

Returns an iterator over all section variables.

Return Value

Iterator

at line 49
void set(string $name, mixed $value, string|null $expire = null)

Sets a variable in this session section. Passing null removes it.

The optional $expire sets per-variable expiration as a time string (e.g. '30 seconds').

Parameters

string $name
mixed $value
string|null $expire

Return Value

void

at line 64
mixed get(string $name)

Gets a variable from this session section.

Parameters

string $name

Return Value

mixed

at line 79
void remove(string|array|null $name = null)

Removes a variable or a list of variables from this section. With no argument, removes the entire section.

Parameters

string|array|null $name

Return Value

void

at line 101
void __set(string $name, mixed $value) deprecated

deprecated use set() instead

Sets a variable in this session section.

Parameters

string $name
mixed $value

Return Value

void

at line 112
mixed __get(string $name) deprecated

deprecated use get() instead

Gets a variable from this session section.

Parameters

string $name

Return Value

mixed

at line 129
bool __isset(string $name) deprecated

deprecated use get() instead

Determines whether a variable in this session section is set.

Parameters

string $name

Return Value

bool

at line 140
void __unset(string $name) deprecated

deprecated use remove() instead

Unsets a variable in this session section.

Parameters

string $name

Return Value

void

at line 150
void offsetSet($name, $value) deprecated

deprecated use set() instead

Sets a variable in this session section.

Parameters

$name
$value

Return Value

void

at line 161
mixed offsetGet($name) deprecated

deprecated use get() instead

Gets a variable from this session section.

Parameters

$name

Return Value

mixed

at line 171
bool offsetExists($name) deprecated

deprecated use get() instead

Determines whether a variable in this session section is set.

Parameters

$name

Return Value

bool

at line 181
void offsetUnset($name) deprecated

deprecated use remove() instead

Unsets a variable in this session section.

Parameters

$name

Return Value

void

at line 192
SessionSection setExpiration(string|null $expire, string|array|null $variables = null)

Sets the expiration time for the whole section or for specific variables.

Pass null to clear the expiration.

Parameters

string|null $expire
string|array|null $variables

variable name(s) to apply the expiration to; null applies to the whole section

Return Value

SessionSection

at line 220
void removeExpiration(string|array|null $variables = null)

Removes the expiration from the whole section or from specific variables.

Parameters

string|array|null $variables

variable name(s) to clear expiration for; null applies to the whole section

Return Value

void