Files
sysPass/lib/SP/Domain/Common/Models/HydratableModel.php
Rubén D 10dedaa03f chore: Refactor upgrade subsystem
Use attributes to detect and load upgrade handlers.

Signed-off-by: Rubén D <nuxsmin@syspass.org>
2024-05-03 22:24:13 +02:00

56 lines
1.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\Common\Models;
use SP\Domain\Core\Exceptions\SPException;
/**
* Interface HydratableModel
*/
interface HydratableModel
{
/**
* Deserialize the hydratable property and returns the object.
*
* @template THydrate
* @param class-string<THydrate> $class
*
* @return THydrate|null
* @throws SPException
*/
public function hydrate(string $class): ?object;
/**
* Serialize the object in the hydratable property
*
* @param object $object
* @return static|null A new instance of the model with the serialized property or null if the property
* couldn't be serialized
*/
public function dehydrate(object $object): static|null;
}