Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe JoomlaStorage
+ Graphe d'héritage de JoomlaStorage:

Fonctions membres publiques

 __construct (Input $input, \SessionHandlerInterface $handler=null, array $options=[])
 
 all ()
 
 clear ()
 
 close ()
 
 get (string $name, $default)
 
 has (string $name)
 
 remove (string $name)
 
 set (string $name, $value=null)
 
 setOptions (array $options)
 
 start ()
 
- Fonctions membres publiques hérités de NativeStorage
 __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 ()
 

Fonctions membres protégées

 setCookieParams ()
 

Attributs privés

 $data
 
 $forceSSL = false
 
 $input
 

Description détaillée

Service provider for the application's session dependency

Depuis
4.0.0

Documentation des constructeurs et destructeur

◆ __construct()

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

Constructor

Paramètres
Input$inputInput object
\SessionHandlerInterface$handlerSession save handler
array$optionsSession options
Depuis
4.0.0

Références $input, $options, $this, Session\isActive(), et Session\setOptions().

Documentation des fonctions membres

◆ all()

all ( )

Retrieves all variables from the session store

Renvoie
array
Depuis
4.0.0

Implémente StorageInterface.

◆ clear()

clear ( )

Clears all variables from the session store

Renvoie
void
Depuis
4.0.0

Implémente StorageInterface.

Références $app, Factory\getApplication(), et Session\getName().

◆ close()

close ( )

Writes session data and ends session

Renvoie
void
Voir également
session_write_close()
Depuis
4.0.0

Implémente StorageInterface.

◆ get()

get ( string  $name,
  $default 
)

Get data from the session store

Paramètres
string$nameName of a variable
mixed$defaultDefault value of a variable if not set
Renvoie
mixed Value of a variable
Depuis
4.0.0

Implémente StorageInterface.

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

◆ has()

has ( string  $name)

Check whether data exists in the session store

Paramètres
string$nameName of variable
Renvoie
boolean True if the variable exists
Depuis
4.0.0

Implémente StorageInterface.

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

◆ remove()

remove ( string  $name)

Unset a variable from the session store

Paramètres
string$nameName of variable
Renvoie
mixed The value from session or NULL if not set
Depuis
4.0.0

Implémente StorageInterface.

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

◆ set()

set ( string  $name,
  $value = null 
)

Set data into the session store

Paramètres
string$nameName of a variable.
mixed$valueValue of a variable.
Renvoie
mixed Old value of a variable.
Depuis
4.0.0

Implémente StorageInterface.

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

◆ setCookieParams()

setCookieParams ( )
protected

Set session cookie parameters

Renvoie
void
Depuis
4.0.0

Références $app, Factory\getApplication(), et Session\isActive().

◆ setOptions()

setOptions ( array  $options)

Sets session options

Paramètres
array$optionsSession ini directives array(key => value).
Renvoie
$this
Voir également
http://php.net/session.configuration
Depuis
4.0.0

Références $options.

◆ start()

start ( )

Start a session

Renvoie
void
Depuis
4.0.0

Implémente StorageInterface.

Références Session\getName(), et Session\setId().

Documentation des champs

◆ $data

$data
private

◆ $forceSSL

$forceSSL = false
private

◆ $input

$input
private

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