mirror of
https://github.com/nuxsmin/sysPass.git
synced 2026-03-03 07:04:07 +01:00
144 lines
3.5 KiB
PHP
144 lines
3.5 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\Common\Ports\Repository;
|
|
use SP\Domain\Core\Dtos\ItemSearchDto;
|
|
use SP\Domain\Core\Exceptions\ConstraintException;
|
|
use SP\Domain\Core\Exceptions\QueryException;
|
|
use SP\Domain\User\Models\UserGroup as UserGroupModel;
|
|
use SP\Infrastructure\Common\Repositories\DuplicatedItemException;
|
|
use SP\Infrastructure\Database\QueryResult;
|
|
|
|
/**
|
|
* Class UserGroupRepository
|
|
*
|
|
* @template T of UserGroupModel
|
|
*/
|
|
interface UserGroupRepository extends Repository
|
|
{
|
|
/**
|
|
* Returns the items that are using the given group id
|
|
*
|
|
* @param int $userGroupId
|
|
*
|
|
* @return QueryResult
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
*/
|
|
public function getUsage(int $userGroupId): QueryResult;
|
|
|
|
/**
|
|
* Returns the users that are using the given group id
|
|
*
|
|
* @param int $userGroupId
|
|
*
|
|
* @return QueryResult
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
*/
|
|
public function getUsageByUsers(int $userGroupId): QueryResult;
|
|
|
|
/**
|
|
* Returns the item for given name
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return QueryResult<T>
|
|
*/
|
|
public function getByName(string $name): QueryResult;
|
|
|
|
/**
|
|
* Returns the item for given id
|
|
*
|
|
* @param int $id
|
|
*
|
|
* @return QueryResult<T>
|
|
*/
|
|
public function getById(int $id): QueryResult;
|
|
|
|
/**
|
|
* Returns all the items
|
|
*
|
|
* @return QueryResult<T>
|
|
*/
|
|
public function getAll(): QueryResult;
|
|
|
|
/**
|
|
* Deletes all the items for given ids
|
|
*
|
|
* @param array<int> $ids
|
|
*
|
|
* @return QueryResult
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
*/
|
|
public function deleteByIdBatch(array $ids): QueryResult;
|
|
|
|
/**
|
|
* Searches for items by a given filter
|
|
*
|
|
* @param ItemSearchDto $itemSearchData
|
|
*
|
|
* @return QueryResult<T>
|
|
*/
|
|
public function search(ItemSearchDto $itemSearchData): QueryResult;
|
|
|
|
/**
|
|
* Creates an item
|
|
*
|
|
* @param UserGroupModel $userGroup
|
|
*
|
|
* @return QueryResult
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
* @throws DuplicatedItemException
|
|
*/
|
|
public function create(UserGroupModel $userGroup): QueryResult;
|
|
|
|
/**
|
|
* Updates an item
|
|
*
|
|
* @param UserGroupModel $userGroup
|
|
*
|
|
* @return int
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
* @throws DuplicatedItemException
|
|
*/
|
|
public function update(UserGroupModel $userGroup): int;
|
|
|
|
/**
|
|
* Deletes an item
|
|
*
|
|
* @param int $id
|
|
*
|
|
* @return QueryResult
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
*/
|
|
public function delete(int $id): QueryResult;
|
|
}
|