mirror of
https://github.com/nuxsmin/sysPass.git
synced 2026-03-12 03:16:54 +01:00
refactor: [WIP] Use hexagonal architecture and implement interfaces for services and repositories.
Controllers are being splited into commands to better dependency management. Signed-off-by: Rubén D <nuxsmin@syspass.org>
This commit is contained in:
119
lib/SP/Domain/Plugin/PluginDataServiceInterface.php
Normal file
119
lib/SP/Domain/Plugin/PluginDataServiceInterface.php
Normal file
@@ -0,0 +1,119 @@
|
||||
<?php
|
||||
/*
|
||||
* sysPass
|
||||
*
|
||||
* @author nuxsmin
|
||||
* @link https://syspass.org
|
||||
* @copyright 2012-2022, 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\Plugin;
|
||||
|
||||
|
||||
use Defuse\Crypto\Exception\CryptoException;
|
||||
use SP\Core\Exceptions\ConstraintException;
|
||||
use SP\Core\Exceptions\NoSuchPropertyException;
|
||||
use SP\Core\Exceptions\QueryException;
|
||||
use SP\Infrastructure\Common\Repositories\NoSuchItemException;
|
||||
use SP\Infrastructure\Database\QueryResult;
|
||||
use SP\Infrastructure\Plugin\Repositories\PluginDataModel;
|
||||
|
||||
/**
|
||||
* Class PluginDataService
|
||||
*
|
||||
* @package SP\Domain\Plugin\Services
|
||||
*/
|
||||
interface PluginDataServiceInterface
|
||||
{
|
||||
/**
|
||||
* Creates an item
|
||||
*
|
||||
* @throws CryptoException
|
||||
* @throws ConstraintException
|
||||
* @throws NoSuchPropertyException
|
||||
* @throws QueryException
|
||||
* @throws \SP\Domain\Common\Services\ServiceException
|
||||
*/
|
||||
public function create(PluginDataModel $itemData): QueryResult;
|
||||
|
||||
/**
|
||||
* Updates an item
|
||||
*
|
||||
* @throws CryptoException
|
||||
* @throws ConstraintException
|
||||
* @throws NoSuchPropertyException
|
||||
* @throws QueryException
|
||||
* @throws \SP\Domain\Common\Services\ServiceException
|
||||
*/
|
||||
public function update(PluginDataModel $itemData): int;
|
||||
|
||||
/**
|
||||
* Returns the item for given plugin and id
|
||||
*
|
||||
* @throws NoSuchItemException
|
||||
* @throws CryptoException
|
||||
* @throws ConstraintException
|
||||
* @throws NoSuchPropertyException
|
||||
* @throws QueryException
|
||||
* @throws \SP\Domain\Common\Services\ServiceException
|
||||
*/
|
||||
public function getByItemId(string $name, int $id): PluginDataModel;
|
||||
|
||||
/**
|
||||
* Returns the item for given id
|
||||
*
|
||||
* @return PluginDataModel[]
|
||||
* @throws \Defuse\Crypto\Exception\CryptoException
|
||||
* @throws \SP\Core\Exceptions\ConstraintException
|
||||
* @throws \SP\Core\Exceptions\NoSuchPropertyException
|
||||
* @throws \SP\Core\Exceptions\QueryException
|
||||
* @throws \SP\Infrastructure\Common\Repositories\NoSuchItemException
|
||||
* @throws \SP\Domain\Common\Services\ServiceException
|
||||
*/
|
||||
public function getById(string $id): array;
|
||||
|
||||
/**
|
||||
* Returns all the items
|
||||
*
|
||||
* @return PluginDataModel[]
|
||||
* @throws \Defuse\Crypto\Exception\CryptoException
|
||||
* @throws \SP\Core\Exceptions\ConstraintException
|
||||
* @throws \SP\Core\Exceptions\NoSuchPropertyException
|
||||
* @throws \SP\Core\Exceptions\QueryException
|
||||
* @throws \SP\Domain\Common\Services\ServiceException
|
||||
*/
|
||||
public function getAll(): array;
|
||||
|
||||
/**
|
||||
* Deletes an item
|
||||
*
|
||||
* @throws \SP\Core\Exceptions\ConstraintException
|
||||
* @throws \SP\Core\Exceptions\QueryException
|
||||
* @throws \SP\Infrastructure\Common\Repositories\NoSuchItemException
|
||||
*/
|
||||
public function delete(string $id): void;
|
||||
|
||||
/**
|
||||
* Deletes an item
|
||||
*
|
||||
* @throws NoSuchItemException
|
||||
* @throws ConstraintException
|
||||
* @throws QueryException
|
||||
*/
|
||||
public function deleteByItemId(string $name, int $itemId): void;
|
||||
}
|
||||
Reference in New Issue
Block a user