mirror of
https://github.com/nuxsmin/sysPass.git
synced 2026-03-03 15:14:08 +01:00
120 lines
3.2 KiB
PHP
120 lines
3.2 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\Plugin\Ports;
|
|
|
|
use Defuse\Crypto\Exception\CryptoException;
|
|
use SP\Domain\Common\Services\ServiceException;
|
|
use SP\Domain\Core\Exceptions\ConstraintException;
|
|
use SP\Domain\Core\Exceptions\NoSuchPropertyException;
|
|
use SP\Domain\Core\Exceptions\QueryException;
|
|
use SP\Domain\Plugin\Models\PluginData as PluginDataModel;
|
|
use SP\Infrastructure\Common\Repositories\NoSuchItemException;
|
|
use SP\Infrastructure\Database\QueryResult;
|
|
|
|
/**
|
|
* Class PluginDataInterface
|
|
*
|
|
* @template T of PluginDataModel
|
|
*/
|
|
interface PluginDataService
|
|
{
|
|
/**
|
|
* Creates an item
|
|
*
|
|
* @throws CryptoException
|
|
* @throws ConstraintException
|
|
* @throws NoSuchPropertyException
|
|
* @throws QueryException
|
|
* @throws ServiceException
|
|
*/
|
|
public function create(PluginDataModel $pluginData): QueryResult;
|
|
|
|
/**
|
|
* Updates an item
|
|
*
|
|
* @throws CryptoException
|
|
* @throws ConstraintException
|
|
* @throws NoSuchPropertyException
|
|
* @throws QueryException
|
|
* @throws ServiceException
|
|
*/
|
|
public function update(PluginDataModel $pluginData): int;
|
|
|
|
/**
|
|
* Returns the item for given plugin and id
|
|
*
|
|
* @throws NoSuchItemException
|
|
* @throws CryptoException
|
|
* @throws ConstraintException
|
|
* @throws NoSuchPropertyException
|
|
* @throws QueryException
|
|
* @throws ServiceException
|
|
*/
|
|
public function getByItemId(string $name, int $id): PluginDataModel;
|
|
|
|
/**
|
|
* Returns the item for given id
|
|
*
|
|
* @return array<T>
|
|
* @throws CryptoException
|
|
* @throws ConstraintException
|
|
* @throws NoSuchPropertyException
|
|
* @throws QueryException
|
|
* @throws NoSuchItemException
|
|
* @throws ServiceException
|
|
*/
|
|
public function getByName(string $name): array;
|
|
|
|
/**
|
|
* Returns all the items
|
|
*
|
|
* @return array<T>
|
|
* @throws CryptoException
|
|
* @throws ConstraintException
|
|
* @throws NoSuchPropertyException
|
|
* @throws QueryException
|
|
* @throws ServiceException
|
|
*/
|
|
public function getAll(): array;
|
|
|
|
/**
|
|
* Deletes an item
|
|
*
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
* @throws NoSuchItemException
|
|
*/
|
|
public function delete(string $name): void;
|
|
|
|
/**
|
|
* Deletes an item
|
|
*
|
|
* @throws NoSuchItemException
|
|
* @throws ConstraintException
|
|
* @throws QueryException
|
|
*/
|
|
public function deleteByItemId(string $name, int $itemId): void;
|
|
}
|