Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de l'interface StorageInterface
+ Graphe d'héritage de StorageInterface:

Fonctions membres publiques

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

Description détaillée

Interface defining a Joomla! session storage object

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émenté dans NativeStorage, et RuntimeStorage.

◆ all()

all ( )

Retrieves all variables from the session store

Renvoie
array
Depuis
2.0.0

Implémenté dans JoomlaStorage, NativeStorage, et RuntimeStorage.

◆ clear()

clear ( )

Clears all variables from the session store

Renvoie
void
Depuis
2.0.0

Implémenté dans JoomlaStorage, NativeStorage, et RuntimeStorage.

◆ close()

close ( )

Writes session data and ends session

Renvoie
void
Voir également
session_write_close()
Depuis
2.0.0

Implémenté dans JoomlaStorage, NativeStorage, et RuntimeStorage.

◆ 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émenté dans NativeStorage, et RuntimeStorage.

◆ 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
2.0.0

Implémenté dans NativeStorage, RuntimeStorage, et JoomlaStorage.

◆ getId()

getId ( )

Get the session ID

Renvoie
string The session ID
Depuis
2.0.0

Implémenté dans NativeStorage, et RuntimeStorage.

◆ getName()

getName ( )

Get the session name

Renvoie
string The session name
Depuis
2.0.0

Implémenté dans NativeStorage, et RuntimeStorage.

◆ has()

has ( string  $name)

Check whether data exists in the session store

Paramètres
string$nameName of variable
Renvoie
boolean
Depuis
2.0.0

Implémenté dans NativeStorage, RuntimeStorage, et JoomlaStorage.

◆ isActive()

isActive ( )

Check if the session is active

Renvoie
boolean
Depuis
2.0.0

Implémenté dans NativeStorage, et RuntimeStorage.

◆ isStarted()

isStarted ( )

Check if the session is started

Renvoie
boolean
Depuis
2.0.0

Implémenté dans NativeStorage, et RuntimeStorage.

◆ 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$destroyDestroy session when regenerating?
Renvoie
boolean True on success
Voir également
session_regenerate_id()
Depuis
2.0.0

Implémenté dans NativeStorage, et RuntimeStorage.

◆ 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
2.0.0

Implémenté dans NativeStorage, RuntimeStorage, et JoomlaStorage.

◆ set()

set ( string  $name,
  $value 
)

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
2.0.0

Implémenté dans NativeStorage, RuntimeStorage, et JoomlaStorage.

◆ setId()

setId ( string  $id)

Set the session ID

Paramètres
string$idThe session ID
Renvoie
$this
Depuis
2.0.0

Implémenté dans NativeStorage, et RuntimeStorage.

◆ setName()

setName ( string  $name)

Set the session name

Paramètres
string$nameThe session name
Renvoie
$this
Depuis
2.0.0

Implémenté dans NativeStorage, et RuntimeStorage.

◆ start()

start ( )

Start a session

Renvoie
void
Depuis
2.0.0

Implémenté dans NativeStorage, RuntimeStorage, et JoomlaStorage.


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