SuiteCRM-Core/core/backend/Module/LegacyHandler/ModuleNameMapperHandler.php

<?php
/**
 * SuiteCRM is a customer relationship management program developed by SalesAgility Ltd.
 * Copyright (C) 2021 SalesAgility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SALESAGILITY, SALESAGILITY DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program 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 Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Supercharged by SuiteCRM".
 */

namespace App\Module\LegacyHandler;

use App\Engine\LegacyHandler\LegacyHandler;
use App\Module\Service\ModuleNameMapperInterface;
use ModuleNameMapper;

/**
 * Class ModuleNameMapper
 * @package App\Legacy
 */
class ModuleNameMapperHandler extends LegacyHandler implements ModuleNameMapperInterface
{
    public const HANDLER_KEY = 'module-name-mapper';

    /**
     * Lazy initialized mapper
     * @var ModuleNameMapper
     */
    protected $mapper;

    /**
     * @inheritDoc
     */
    public function getHandlerKey(): string
    {
        return self::HANDLER_KEY;
    }

    /**
     * @inheritDoc
     */
    public function isValidModule(string $module): bool
    {
        $this->init();

        $mapper = $this->getMapper();

        $result = $mapper->isValidModule($module);

        $this->close();

        return $result;
    }

    /**
     * Get mapper. Initialize it if needed
     * @return ModuleNameMapper
     */
    protected function getMapper(): ModuleNameMapper
    {
        if ($this->mapper !== null) {
            return $this->mapper;
        }

        /* @noinspection PhpIncludeInspection */
        require_once 'include/portability/ModuleNameMapper.php';

        $this->mapper = new ModuleNameMapper();

        return $this->mapper;
    }

    /**
     * @inheritDoc
     */
    public function toFrontEnd(string $module): string
    {
        $this->init();

        $mapper = $this->getMapper();

        $result = $mapper->toFrontEnd($module);

        $this->close();

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function toCore(string $module): string
    {
        $this->init();

        $mapper = $this->getMapper();

        $result = $mapper->toCore($module);

        $this->close();

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function toLegacy(string $module): string
    {
        $this->init();

        $mapper = $this->getMapper();

        $result = $mapper->toLegacy($module);

        $this->close();

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function getLegacyToFrontendMap(): array
    {
        $this->init();

        $mapper = $this->getMapper();

        $result = $mapper->getLegacyToFrontendMap();

        $this->close();

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function getVisibleModules(): array
    {
        $this->init();

        $mapper = $this->getMapper();

        $result = $mapper->getVisibleModules();

        $this->close();

        return $result;
    }
}