Session Class Reference

Public Member Functions
	__construct (?array $options=null)
	hasSession ()
	set (string $key, mixed $value)
	get (string $key)
	remove (string $key)
	has (string $key)
	destroy ()
	regenerate ()
	getId ()
	abort ()
	commit ()
	getName ()
	reset ()
	clear ()
	status ()

Data Fields
readonly FlashStore	$flash
readonly OldStore	$old
readonly ErrorStore	$error

Protected Member Functions
	init (array $options)
	start (array $options)

Protected Attributes
array	$defaults

Detailed Description

Classe principal para gerenciamento de sessões HTTP e sub-repositórios.

Definition at line 12 of file Session.php.

Constructor & Destructor Documentation

__construct()

__construct

(

?array

$options = null

)

Construtor da classe Session.

Parameters

array<string,mixed>|null

$options Opções personalizadas para inicializar a sessão.

Exceptions

RuntimeException

Se as sessões estiverem desabilitadas ou falharem ao iniciar.

Definition at line 47 of file Session.php.

Member Function Documentation

abort()

abort

(

)

Descarta as alterações no array da sessão e encerra a sessão.

Returns

bool Retorna true em caso de sucesso ou false em caso de falha.

Definition at line 221 of file Session.php.

clear()

clear

(

)

Limpa todas as variáveis de sessão registradas.

Returns

$this

Definition at line 271 of file Session.php.

commit()

commit

(

)

Salva os dados da sessão e encerra a sessão.

Returns

$this

Definition at line 232 of file Session.php.

destroy()

destroy

(

)

Destrói a sessão atual e apaga o cookie de sessão do cliente, se utilizado.

Returns

void

Definition at line 164 of file Session.php.

get()

get

(

string

$key

)

Recupera um valor armazenado na sessão por sua chave.

Parameters

string

$key

Chave do valor a ser buscado.

Returns

mixed O valor armazenado ou null caso não exista.

Definition at line 129 of file Session.php.

getId()

getId

(

)

Retorna o ID da sessão atual.

Returns

string O ID da sessão.

Definition at line 206 of file Session.php.

getName()

getName

(

)

Retorna o nome da sessão atual.

Returns

string O nome da sessão.

Definition at line 244 of file Session.php.

has()

has

(

string

$key

)

Verifica se uma determinada chave existe na sessão.

Parameters

string

$key

Chave a ser verificada.

Returns

bool Retorna true se a chave existir, false caso contrário.

Definition at line 153 of file Session.php.

hasSession()

hasSession

(

)

Verifica se a sessão está ativa.

Returns

bool Retorna true se a sessão estiver ativa, false caso contrário.

Definition at line 80 of file Session.php.

init()

init ( array $options )

protected

Inicializa a sessão com as configurações informadas.

Parameters

array<string,mixed>

$options Opções para session_start().

Returns

void

Exceptions

RuntimeException

Se as sessões estiverem desabilitadas ou ocorrer falha ao iniciar.

Definition at line 63 of file Session.php.

regenerate()

regenerate

(

)

Regenera o ID da sessão mantendo as informações existentes.

Returns

$this

Definition at line 194 of file Session.php.

remove()

remove

(

string

$key

)

Remove uma chave e seu respectivo valor da sessão.

Parameters

string

$key

Chave a ser removida.

Returns

void

Definition at line 141 of file Session.php.

reset()

reset

(

)

Reinicializa o array da sessão com os valores originalmente gravados.

Returns

$this

Definition at line 259 of file Session.php.

set()

set	(	string	$key,
		mixed	$value )

Armazena um valor na sessão sob uma determinada chave.

Parameters

string	$key	Chave de identificação.
mixed	$value	Valor a ser armazenado.

Returns

$this

Definition at line 116 of file Session.php.

start()

start ( array $options )

protected

Executa a função session_start() nativa com as opções fornecidas.

Parameters

array<string,mixed>

$options Opções passadas para a inicialização da sessão.

Returns

bool Retorna true se a sessão foi iniciada com sucesso, false caso contrário.

Definition at line 294 of file Session.php.

status()

status

(

)

Retorna o status atual da sessão PHP.

Returns

int O status da sessão (ex: PHP_SESSION_DISABLED, PHP_SESSION_NONE, PHP_SESSION_ACTIVE).

Definition at line 283 of file Session.php.

Field Documentation

$defaults

array $defaults

protected

Initial value:

                          = [
    'cookie_httponly' => 1,
    'cookie_secure' => 1,
    'cookie_samesite' => 'Lax',
    'use_strict_mode' => 1,
]

Definition at line 34 of file Session.php.

$error

readonly ErrorStore $error

Repositório de erros.

Definition at line 27 of file Session.php.

$flash

readonly FlashStore $flash

Repositório de dados temporários (flash).

Definition at line 17 of file Session.php.

$old

readonly OldStore $old

Repositório de dados antigos (formulários).

Definition at line 22 of file Session.php.

---

The documentation for this class was generated from the following file:

• src/Session.php