Files
sysPass/lib/SP/Domain/User/Ports/UserPassRecoverRepository.php
2024-04-01 17:28:38 +02:00

85 lines
2.3 KiB
PHP

<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2024, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Domain\User\Ports;
use SP\Domain\Core\Exceptions\ConstraintException;
use SP\Domain\Core\Exceptions\QueryException;
use SP\Domain\Core\Exceptions\SPException;
use SP\Domain\User\Models\UserPassRecover as UserPassRecoverModel;
use SP\Infrastructure\Database\QueryResult;
/**
* Class UserPassRecoverRepository
*
* @template T of UserPassRecoverModel
*/
interface UserPassRecoverRepository
{
/**
* Checks recovery limit attempts by user's id and time
*
* @param int $userId
* @param int $time
*
* @return int
* @throws ConstraintException
* @throws QueryException
*/
public function getAttemptsByUserId(int $userId, int $time): int;
/**
* Adds a hash for a user's id
*
* @param int $userId
* @param string $hash
*
* @return QueryResult
* @throws ConstraintException
* @throws QueryException
*/
public function add(int $userId, string $hash): QueryResult;
/**
* Toggles a hash used
*
* @param string $hash
* @param int $time
*
* @return int The updated rows. If no rows are updated, it means that the hash doesn't exist or it's expired
* @throws SPException
*/
public function toggleUsedByHash(string $hash, int $time): int;
/**
* Comprobar el hash de recuperación de clave.
*
* @param string $hash
* @param int $time
*
* @return QueryResult<UserPassRecoverModel>
*/
public function getUserIdForHash(string $hash, int $time): QueryResult;
}