Référence de la classe MetadataManager

Fonctions membres publiques
	__construct (AbstractApplication $app, DatabaseInterface $db)
	createRecordIfNonExisting (SessionInterface $session, User $user)
	createOrUpdateRecord (SessionInterface $session, User $user)
	deletePriorTo ($time)

Fonctions membres privées
	checkSessionRecordExists (string $sessionId)
	createSessionRecord (SessionInterface $session, User $user)
	updateSessionRecord (SessionInterface $session, User $user)

Attributs privés
	$app
	$db

Attributs privés statiques
static	$sessionRecordExists = 1
static	$sessionRecordDoesNotExist = 0
static	$sessionRecordUnknown = -1

Description détaillée

Manager for optional session metadata.

Depuis

3.8.6

Documentation des constructeurs et destructeur

__construct()

__construct	(	AbstractApplication	$app,
		DatabaseInterface	$db
	)

MetadataManager constructor.

Paramètres

AbstractApplication	$app	Application object.
DatabaseInterface	$db	Database driver.

Depuis

3.8.6

Références $app, et $db.

Documentation des fonctions membres

checkSessionRecordExists()

checkSessionRecordExists ( string  $sessionId )

private

Check if the session record exists

Paramètres

string

$sessionId

The session ID to check

Renvoie

integer Status value for record presence

Depuis

4.0.0

Références $query.

createOrUpdateRecord()

createOrUpdateRecord	(	SessionInterface	$session,
		User	$user
	)

Create the metadata record if it does not exist.

Paramètres

SessionInterface	$session	The session to create or update the metadata record for.
User	$user	The user to associate with the record.

Renvoie

void

Depuis

4.0.0

Exceptions

Références $user, et SessionInterface\getId().

createRecordIfNonExisting()

createRecordIfNonExisting	(	SessionInterface	$session,
		User	$user
	)

Create the metadata record if it does not exist.

Paramètres

SessionInterface	$session	The session to create the metadata record for.
User	$user	The user to associate with the record.

Renvoie

void

Depuis

3.8.6

Exceptions

Références $user, et SessionInterface\getId().

createSessionRecord()

createSessionRecord ( SessionInterface  $session, User  $user  )

private

Create the session record

Paramètres

SessionInterface	$session	The session to create the metadata record for.
User	$user	The user to associate with the record.

Renvoie

void

Depuis

4.0.0

Références $clientId, $columns, $query, $user, $userId, SessionInterface\get(), AbstractApplication\get(), SessionInterface\getId(), ParameterType\INTEGER, SessionInterface\isNew(), et null.

deletePriorTo()

deletePriorTo

(

$time

)

Delete records with a timestamp prior to the given time.

Paramètres

integer

$time

The time records should be deleted if expired before.

Renvoie

void

Depuis

3.8.6

Références $query, et ParameterType\INTEGER.

updateSessionRecord()

updateSessionRecord ( SessionInterface  $session, User  $user  )

private

Update the session record

Paramètres

SessionInterface	$session	The session to update the metadata record for.
User	$user	The user to associate with the record.

Renvoie

void

Depuis

4.0.0

Références $clientId, $query, $user, $userId, AbstractApplication\get(), SessionInterface\getId(), ParameterType\INTEGER, et null.

Documentation des champs

$app

$app

private

$db

$db

private

$sessionRecordDoesNotExist

$sessionRecordDoesNotExist = 0

staticprivate

$sessionRecordExists

$sessionRecordExists = 1

staticprivate

$sessionRecordUnknown

$sessionRecordUnknown = -1

staticprivate

---

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

• MetadataManager.php