Référence de la classe NativeStorage

Graphe d'héritage de NativeStorage:

Fonctions membres publiques
	__construct (?\SessionHandlerInterface $handler=null, array $options=[])
	all ()
	clear ()
	close ()
	gc ()
	abort ()
	get (string $name, $default)
	getHandler ()
	getId ()
	getName ()
	has (string $name)
	isActive ()
	isStarted ()
	remove (string $name)
	regenerate (bool $destroy=false)
	set (string $name, $value=null)
	setHandler (?\SessionHandlerInterface $handler=null)
	setId (string $id)
	setName (string $name)
	setOptions (array $options)
	start ()

Attributs privés
	$active = false
	$closed = false
	$handler
	$started = false

Description détaillée

Base class providing a session store

Depuis

2.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	?\SessionHandlerInterface	$handler = null,
		array	$options = []
	)

Constructor

Paramètres

\SessionHandlerInterface	$handler	Session save handler
array	$options	Session options

Depuis

1.0

Références NativeStorage\$handler, $options, NativeStorage\setHandler(), et NativeStorage\setOptions().

Documentation des fonctions membres

abort()

abort

(

)

Aborts the current session

Renvoie

boolean

Voir également

session_abort()

Depuis

2.0.0

Implémente StorageInterface.

Références NativeStorage\isStarted().

all()

all

(

)

Retrieves all variables from the session store

Renvoie

array

Depuis

2.0.0

Implémente StorageInterface.

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.

Références NativeStorage\isStarted(), et NativeStorage\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, $name, NativeStorage\isStarted(), et NativeStorage\start().

getHandler()

getHandler

(

)

Gets the save handler instance

Renvoie

|null

Depuis

2.0.0

Références NativeStorage\$handler.

getId()

getId

(

)

Get the session ID

Renvoie

string The session ID

Depuis

2.0.0

Implémente StorageInterface.

getName()

getName

(

)

Get the session name

Renvoie

string The session name

Depuis

2.0.0

Implémente StorageInterface.

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 $name, NativeStorage\isStarted(), et NativeStorage\start().

isActive()

isActive

(

)

Check if the session is active

Renvoie

boolean

Depuis

2.0.0

Implémente StorageInterface.

Référencé par NativeStorage\regenerate(), NativeStorage\setHandler(), NativeStorage\setId(), NativeStorage\setName(), NativeStorage\setOptions(), et NativeStorage\start().

isStarted()

isStarted

(

)

Check if the session is started

Renvoie

boolean

Depuis

2.0.0

Implémente StorageInterface.

Références NativeStorage\$started.

Référencé par NativeStorage\abort(), NativeStorage\gc(), NativeStorage\get(), NativeStorage\has(), NativeStorage\remove(), NativeStorage\set(), et NativeStorage\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 NativeStorage\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 $name, NativeStorage\isStarted(), null, et NativeStorage\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 $name, $value, NativeStorage\isStarted(), null, et NativeStorage\start().

setHandler()

setHandler

(

?\SessionHandlerInterface

$handler = null

)

Registers session save handler as a PHP session handler

Paramètres

\SessionHandlerInterface

$handler

The save handler to use

Renvoie

$this

Depuis

2.0.0

Exceptions

Références NativeStorage\$handler, $this, et NativeStorage\isActive().

Référencé par NativeStorage\__construct().

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 $id, $this, et NativeStorage\isActive().

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 $name, $this, et NativeStorage\isActive().

setOptions()

setOptions

(

array

$options

)

Sets session.* ini variables.

For convenience we omit 'session.' from the beginning of the keys. Explicitly ignores other ini keys.

Paramètres

array

$options

Session ini directives array(key => value).

Renvoie

$this

Note

Based on ::setOptions()

Voir également

http://php.net/session.configuration

Depuis

2.0.0

Références $key, $options, $this, $value, et NativeStorage\isActive().

Référencé par NativeStorage\__construct().

start()

start

(

)

Start a session

Renvoie

void

Depuis

2.0.0

Implémente StorageInterface.

Références NativeStorage\isActive(), et NativeStorage\isStarted().

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

Documentation des champs

$active

$active = false

private

$closed

$closed = false

private

$handler

$handler

private

Référencé par NativeStorage\__construct(), NativeStorage\getHandler(), et NativeStorage\setHandler().

$started

$started = false

private

Référencé par NativeStorage\isStarted().

---

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

• NativeStorage.php