<?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\Plugin\Ports;

use SP\Domain\Core\Events\EventReceiver;

/**
 * Interface PluginInterface
 */
interface Plugin extends EventReceiver
{
    /**
     * Devuelve el directorio base del plugin
     *
     * @return string|null
     */
    public function getBase(): ?string;

    /**
     * Devuelve el directorio del tema usado
     *
     * @return string|null
     */
    public function getThemeDir(): ?string;

    /**
     * Devuelve el autor del plugin
     *
     * @return string|null
     */
    public function getAuthor(): ?string;

    /**
     * Devuelve la versión del plugin
     *
     * @return array|null
     */
    public function getVersion(): ?array;

    /**
     * Devuelve la versión compatible de sysPass
     *
     * @return array|null
     */
    public function getCompatibleVersion(): ?array;

    public function getName(): ?string;

    public function getData(): mixed;

    public function saveData(int $id, mixed $data): void;

    public function onLoad();

    public function onUpgrade(string $version);
}