Référence de la classe RuntimeStorage

Graphe d'héritage de RuntimeStorage:

Fonctions membres publiques
	all ()
	clear ()
	close ()
	gc ()
	abort ()
	get (string $name, $default)
	getId ()
	getName ()
	has (string $name)
	isActive ()
	isStarted ()
	remove (string $name)
	regenerate (bool $destroy=false)
	set (string $name, $value=null)
	setId (string $id)
	setName (string $name)
	start ()

Fonctions membres privées
	generateId ()

Attributs privés
	$active = false
	$closed = false
	$data = []
	$id = ''
	$name = 'MockSession'
	$started = false

Description détaillée

Session storage object that stores objects in Runtime memory. This is designed for use in CLI Apps, including unit testing applications in PHPUnit.

Depuis

2.0.0

Documentation des fonctions membres

abort()

abort

(

)

Aborts the current session

Renvoie

boolean

Voir également

session_abort()

Depuis

2.0.0

Implémente StorageInterface.

all()

all

(

)

Retrieves all variables from the session store

Renvoie

array

Implémente StorageInterface.

Références RuntimeStorage\$data.

clear()

clear

(

)

Clears all variables from the session store

Renvoie

void

Depuis

2.0.0

Implémente StorageInterface.

close()

close

(

)

Writes session data and ends session

Renvoie

void

Voir également

session_write_close()

Depuis

2.0.0

Implémente StorageInterface.

gc()

gc

(

)

Perform session data garbage collection

Renvoie

integer|boolean Number of deleted sessions on success or boolean false on failure or if the function is unsupported

Voir également

session_gc()

Depuis

2.0.0

Implémente StorageInterface.

generateId()

generateId ( )

private

Generates a session ID

Renvoie

string

Depuis

2.0.0

Référencé par RuntimeStorage\regenerate(), et RuntimeStorage\start().

get()

get	(	string	$name,
			$default
	)

Get data from the session store

Paramètres

string	$name	Name of a variable
mixed	$default	Default value of a variable if not set

Renvoie

mixed Value of a variable

Depuis

2.0.0

Implémente StorageInterface.

Références $default, RuntimeStorage\$name, RuntimeStorage\isStarted(), et RuntimeStorage\start().

getId()

getId

(

)

Get the session ID

Renvoie

string The session ID

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\$id.

getName()

getName

(

)

Get the session name

Renvoie

string The session name

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\$name.

has()

has

(

string

$name

)

Check whether data exists in the session store

Paramètres

string

$name

Name of variable

Renvoie

boolean

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\$name, RuntimeStorage\isStarted(), et RuntimeStorage\start().

isActive()

isActive

(

)

Check if the session is active

Renvoie

boolean

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\$started.

Référencé par RuntimeStorage\regenerate(), RuntimeStorage\setId(), RuntimeStorage\setName(), et RuntimeStorage\start().

isStarted()

isStarted

(

)

Check if the session is started

Renvoie

boolean

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\$started.

Référencé par RuntimeStorage\get(), RuntimeStorage\has(), RuntimeStorage\remove(), RuntimeStorage\set(), et RuntimeStorage\start().

regenerate()

regenerate

(

bool

$destroy = false

)

Regenerates the session ID that represents this storage.

This method must invoke session_regenerate_id($destroy) unless this interface is used for a storage object designed for unit or functional testing where a real PHP session would interfere with testing.

Paramètres

boolean

$destroy

Destroy session when regenerating?

Renvoie

boolean True on success

Voir également

session_regenerate_id()

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\generateId(), et RuntimeStorage\isActive().

remove()

remove

(

string

$name

)

Unset a variable from the session store

Paramètres

string

$name

Name of variable

Renvoie

mixed The value from session or NULL if not set

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\$name, RuntimeStorage\isStarted(), null, et RuntimeStorage\start().

set()

set	(	string	$name,
			$value = null
	)

Set data into the session store

Paramètres

string	$name	Name of a variable
mixed	$value	Value of a variable

Renvoie

mixed Old value of a variable

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\$name, $value, RuntimeStorage\isStarted(), null, et RuntimeStorage\start().

setId()

setId

(

string

$id

)

Set the session ID

Paramètres

string

$id

The session ID

Renvoie

$this

Depuis

2.0.0

Exceptions

Implémente StorageInterface.

Références RuntimeStorage\$id, $this, et RuntimeStorage\isActive().

Référencé par RuntimeStorage\start().

setName()

setName

(

string

$name

)

Set the session name

Paramètres

string

$name

The session name

Renvoie

$this

Depuis

2.0.0

Exceptions

Implémente StorageInterface.

Références RuntimeStorage\$name, $this, RuntimeStorage\isActive(), et name.

start()

start

(

)

Start a session

Renvoie

void

Depuis

2.0.0

Implémente StorageInterface.

Références RuntimeStorage\generateId(), RuntimeStorage\isActive(), RuntimeStorage\isStarted(), et RuntimeStorage\setId().

Référencé par RuntimeStorage\get(), RuntimeStorage\has(), RuntimeStorage\remove(), et RuntimeStorage\set().

Documentation des champs

$active

$active = false

private

$closed

$closed = false

private

$data

$data = []

private

Référencé par RuntimeStorage\all().

$id

$id = ''

private

Référencé par RuntimeStorage\getId(), et RuntimeStorage\setId().

$name

$name = 'MockSession'

private

Référencé par RuntimeStorage\get(), RuntimeStorage\getName(), RuntimeStorage\has(), RuntimeStorage\remove(), RuntimeStorage\set(), et RuntimeStorage\setName().

$started

$started = false

private

Référencé par RuntimeStorage\isActive(), et RuntimeStorage\isStarted().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• RuntimeStorage.php