Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class MetadataManager - list of methods

Manager for optional session metadata.
Package: Joomla\CMS\Session
Copyright: (C) 2018 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Session/MetadataManager.php
Project: Joomla

Method Summary

public
__construct
(\Joomla\Application\AbstractApplication $app, \Joomla\Database\DatabaseInterface $db)

MetadataManager constructor.
Parameters
  • \Joomla\Application\AbstractApplication $app Application object.
  • \Joomla\Database\DatabaseInterface $db Database driver.
Since
  • 3.8.6
Show source code of this method: __construct Source Code

public void
(\Joomla\Session\SessionInterface $session, \Joomla\CMS\User\User $user)

Create the metadata record if it does not exist.
Parameters
  • \Joomla\Session\SessionInterface $session The session to create the metadata record for.
  • \Joomla\CMS\User\User $user The user to associate with the record.
Returns
  • void
Since
  • 3.8.6
-
  • \RuntimeException
Show source code of this method: createRecordIfNonExisting Source Code

public void
(\Joomla\Session\SessionInterface $session, \Joomla\CMS\User\User $user)

Create the metadata record if it does not exist.
Parameters
  • \Joomla\Session\SessionInterface $session The session to create or update the metadata record for.
  • \Joomla\CMS\User\User $user The user to associate with the record.
Returns
  • void
Since
  • 4.0.0
-
  • \RuntimeException
Show source code of this method: createOrUpdateRecord Source Code

public void
(mixed $time)

Delete records with a timestamp prior to the given time.
Parameters
  • int $time The time records should be deleted if expired before.
Returns
  • void
Since
  • 3.8.6
Show source code of this method: deletePriorTo Source Code

private int
(string $sessionId)

Check if the session record exists
Parameters
  • string $sessionId The session ID to check
Returns
  • int Status value for record presence
Since
  • 4.0.0
Show source code of this method: checkSessionRecordExists Source Code

private void
(\Joomla\Session\SessionInterface $session, \Joomla\CMS\User\User $user)

Create the session record
Parameters
  • \Joomla\Session\SessionInterface $session The session to create the metadata record for.
  • \Joomla\CMS\User\User $user The user to associate with the record.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: createSessionRecord Source Code

private void
(\Joomla\Session\SessionInterface $session, \Joomla\CMS\User\User $user)

Update the session record
Parameters
  • \Joomla\Session\SessionInterface $session The session to update the metadata record for.
  • \Joomla\CMS\User\User $user The user to associate with the record.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: updateSessionRecord Source Code

Properties Summary

private static int
$sessionRecordExists
Internal variable indicating a session record exists.
Since
  • 4.0.0
-
  • int
private static int
$sessionRecordDoesNotExist
Internal variable indicating a session record does not exist.
Since
  • 4.0.0
-
  • int
private static int
$sessionRecordUnknown
Internal variable indicating an unknown session record statue.
Since
  • 4.0.0
-
  • int
private \Joomla\Application\AbstractApplication
$app
Application object.
Since
  • 3.8.6
private \Joomla\Database\DatabaseInterface
$db
Database driver.
Since
  • 3.8.6

Tags Summary

Since
3.8.6