brainworxx/kreXX

<?php

/**
 * kreXX: Krumo eXXtended
 *
 * kreXX is a debugging tool, which displays structured information
 * about any PHP object. It is a nice replacement for print_r() or var_dump()
 * which are used by a lot of PHP developers.
 *
 * kreXX is a fork of Krumo, which was originally written by:
 * Kaloyan K. Tsvetkov <kaloyan@kaloyan.info>
 *
 * @author
 *   brainworXX GmbH <info@brainworxx.de>
 *
 * @license
 *   http://opensource.org/licenses/LGPL-2.1
 *
 *   GNU Lesser General Public License Version 2.1
 *
 *   kreXX Copyright (C) 2014-2024 Brainworxx GmbH
 *
 *   This library is free software; you can redistribute it and/or modify it
 *   under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation; either version 2.1 of the License, or (at
 *   your option) any later version.
 *   This library 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 Lesser General Public License
 *   for more details.
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with this library; if not, write to the Free Software Foundation,
 *   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

declare(strict_types=1);

namespace Brainworxx\Krexx\Service\Plugin;

/**
 * Plugin configuration interface.
 */
interface PluginConfigInterface
{
    /**
     * Event marker. Start marker of the callback.
     *
     * @var string
     */
    public const START_EVENT = '::callMe::start';

    /**
     * Event marker. End marker of the callback.
     *
     * @var string
     */
    public const END_EVENT = '::callMe::end';

    /**
     * Event marker. Somewhere-in-the-middle marker of the callback.
     *
     * @var string
     */
    public const START_PROCESS = '::process';

    /**
     * Get the name of the plugin.
     *
     * @return string
     */
    public function getName(): string;

    /**
     * Get the version of the plugin.
     *
     * @return string
     */
    public function getVersion(): string;

    /**
     * Registers all Overwrites
     */
    public function exec(): void;
}