SessionBackendInterface.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Core\Session\Backend;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Session\Backend\Exception\SessionNotCreatedException;
use TYPO3\CMS\Core\Session\Backend\Exception\SessionNotFoundException;
use TYPO3\CMS\Core\Session\Backend\Exception\SessionNotUpdatedException;

interface SessionBackendInterface
{
    public function initialize(string $identifier, array $configuration);

    public function validateConfiguration();

    public function getAll(): array;

    public function get(string $sessionId): array;

    public function remove(string $sessionId): bool;

    public function set(string $sessionId, array $sessionData): array;

    public function update(string $sessionId, array $sessionData): array;

    public function collectGarbage(int $maximumLifetime, int $maximumAnonymousLifetime = 0);
}