plugins/webservices/modules/src/Extension/Modules.php - 5.4-dev - githubmirror/joomla-cms

plugins/webservices/modules/src/Extension/Modules.php
87 строк2 KB
Martina Scholz
Joomla! 5.1.0 Beta 1
04 мар 2024, 17:46
04 мар 2024, 17:467c94640
<?php

/**
 * @package     Joomla.Modules
 * @subpackage  Webservices.modules
 *
 * @copyright   (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\Plugin\WebServices\Modules\Extension;

use Joomla\CMS\Event\Application\BeforeApiRouteEvent;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\Event\SubscriberInterface;
use Joomla\Router\Route;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Web Services adapter for com_modules.
 *
 * @since  4.0.0
 */
final class Modules extends CMSPlugin implements SubscriberInterface
{
    /**
     * Returns an array of events this subscriber will listen to.
     *
     * @return  array
     *
     * @since   5.1.0
     */
    public static function getSubscribedEvents(): array
    {
        return [
            'onBeforeApiRoute' => 'onBeforeApiRoute',
        ];
    }

    /**
     * Registers com_modules's API's routes in the application
     *
     * @param   BeforeApiRouteEvent  $event  The event object
     *
     * @return  void
     *
     * @since   4.0.0
     */
    public function onBeforeApiRoute(BeforeApiRouteEvent $event): void
    {
        $router = $event->getRouter();

        $routes = [
            new Route(
                ['GET'],
                'v1/modules/types/site',
                'modules.getTypes',
                [],
                ['public' => false, 'component' => 'com_modules', 'client_id' => 0]
            ),
            new Route(
                ['GET'],
                'v1/modules/types/administrator',
                'modules.getTypes',
                [],
                ['public' => false, 'component' => 'com_modules', 'client_id' => 1]
            ),
        ];

        $router->addRoutes($routes);

        $router->createCRUDRoutes(
            'v1/modules/site',
            'modules',
            ['component' => 'com_modules', 'client_id' => 0]
        );

        $router->createCRUDRoutes(
            'v1/modules/administrator',
            'modules',
            ['component' => 'com_modules', 'client_id' => 1]
        );
    }
}