mirror of
https://github.com/nuxsmin/sysPass.git
synced 2026-03-03 15:14:08 +01:00
103 lines
2.5 KiB
PHP
103 lines
2.5 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
/*
|
|
* 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\User\Models\UserToUserGroup as UserToUserGroupModel;
|
|
use SP\Infrastructure\Database\QueryResult;
|
|
|
|
/**
|
|
* Class UserToUserGroupRepository
|
|
*
|
|
* @template T of UserToUserGroupModel
|
|
*/
|
|
interface UserToUserGroupRepository
|
|
{
|
|
/**
|
|
* Checks whether the user is included in the group
|
|
*
|
|
* @param int $groupId
|
|
* @param int $userId
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function checkUserInGroup(int $groupId, int $userId): bool;
|
|
|
|
/**
|
|
* Returns the groups which the user belongs to
|
|
*
|
|
* @param int $userId
|
|
*
|
|
* @return QueryResult<T>
|
|
*/
|
|
public function getGroupsForUser(int $userId): QueryResult;
|
|
|
|
/**
|
|
* Updates users from a group
|
|
*
|
|
* @param int $id
|
|
* @param array $users
|
|
*
|
|
* @return QueryResult
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
*/
|
|
public function update(int $id, array $users): QueryResult;
|
|
|
|
/**
|
|
* Deletes users from a group
|
|
*
|
|
* @param $id int
|
|
*
|
|
* @return QueryResult
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
*/
|
|
public function delete(int $id): QueryResult;
|
|
|
|
/**
|
|
* Adds users to a group
|
|
*
|
|
* @param int $groupId
|
|
* @param array $users
|
|
*
|
|
* @return QueryResult
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
*/
|
|
public function add(int $groupId, array $users): QueryResult;
|
|
|
|
/**
|
|
* Returns users from a group by group id
|
|
*
|
|
* @param $id int
|
|
*
|
|
* @return QueryResult<T>
|
|
*/
|
|
public function getById(int $id): QueryResult;
|
|
}
|