Authentication/src/FuzeWorks/Authentication/SessionsModelDriverInterfac...

86 lines
2.8 KiB
PHP
Executable File

<?php
/**
* FuzeWorks Authentication Plugin.
*
* The FuzeWorks PHP FrameWork
*
* Copyright (C) 2013 - 2023 i15
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @author i15
* @copyright Copyright (C) 2013 - 2023, i15. (https://i15.nl)
* @license https://opensource.org/licenses/MIT MIT License
*
* @since Version 1.3.0
*
* @version Version 1.3.0
*/
namespace FuzeWorks\Authentication;
use FuzeWorks\Authentication\Model\Session;
use FuzeWorks\Authentication\Model\Users;
use FuzeWorks\DatabaseEngine\iDatabaseEngine;
interface SessionsModelDriverInterface
{
/**
* Initializes the Model.
*
* Should accept the Engine and UsersModel.
*
* @param iDatabaseEngine $engine
* @param Users $usersModel
*/
public function __construct(iDatabaseEngine $engine, Users $usersModel);
/**
* Add a new Session to the database using the provided Session object.
*
* @param Session $session
* @return bool
*/
public function createSession(Session $session): bool;
/**
* Return a list of Session[] from the database on the basis of the provided search filter.
*
* @param array $filter
* @return Session[]
*/
public function readSessions(array $filter): array;
/**
* Update a list of Session[] in the database on the basis of the provided Session[] objects.
*
* @param Session[] $sessions
* @return bool
*/
public function updateSessions(array $sessions): bool;
/**
* Delete the provided Session[] objects from the database.
*
* @param Session[] $sessions
* @return bool
*/
public function deleteSessions(array $sessions): bool;
}