The Yaf_Session class

(Yaf >=1.0.0)

Introduction

Yaf_Session is a namespaced wrapper around PHP's native session support. It is accessed as a singleton through Yaf_Session::getInstance() and works directly on $_SESSION: session data written through one interface is visible in the other.

Session entries can be accessed and manipulated through property syntax, method calls (Yaf_Session::get(), Yaf_Session::set(), Yaf_Session::del(), Yaf_Session::has()), array access (ArrayAccess), iteration (Iterator) and count().

Class synopsis

class Yaf_Session implements Iterator, ArrayAccess, Countable {

/* Properties */

protected static $_instance;

protected $_session;

protected $_started;

/* Methods */

privatefunction __construct()

public function count(): int

public function current(): mixed

public function del(string $name): bool

public function get(string $name = NULL): mixed

public static function getInstance(): Yaf_Session

public function has(string $name): bool

public function __isset(string $name): bool

public function key(): mixed

public function next(): void

public function offsetExists(mixed $name): bool

public function offsetGet(mixed $name): mixed

public function offsetSet(mixed $name, mixed $value): void

public function offsetUnset(mixed $name): void

public function rewind(): void

public function set(string $name, mixed $value): bool

public function start(): Yaf_Session

public function __unset(string $name): void

public function valid(): bool

}

Properties

_instance
_session
_started

Yaf_Session::__construct — Constructor of Yaf_Session
Yaf_Session::count — Count session entries
Yaf_Session::current — Get current session entry value
Yaf_Session::del — Remove a session key
Yaf_Session::get — Get a session value
Yaf_Session::getInstance — Get the session singleton
Yaf_Session::has — Check if a session key exists
Yaf_Session::__isset — Check if a session key exists
Yaf_Session::key — Get current session entry key
Yaf_Session::next — Advance to next session entry
Yaf_Session::offsetExists — Check if a session key exists (ArrayAccess)
Yaf_Session::offsetGet — Get a session value (ArrayAccess)
Yaf_Session::offsetSet — Set a session value (ArrayAccess)
Yaf_Session::offsetUnset — Remove a session key (ArrayAccess)
Yaf_Session::rewind — Reset session iterator to first entry
Yaf_Session::set — Set a session value
Yaf_Session::start — Start the session
Yaf_Session::__unset — Remove a session key
Yaf_Session::valid — Check if current session position is valid

The Yaf_Session class

Introduction

Class synopsis

Properties

Table of Contents