AOEpeople / TYPO3_Restler

Classes/System/RestlerBuilderAware.php

<?php

namespace Aoe\Restler\System;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2015 AOE GmbH <dev@aoe.com>
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project 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.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script 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.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use Aoe\Restler\Configuration\ExtensionConfiguration;
use Aoe\Restler\System\Restler\Builder;
use TYPO3\CMS\Core\Utility\GeneralUtility;

abstract class RestlerBuilderAware
{
    /**
     * @var string
     */
    private const API_PREFIX = '/api';

    private ?Builder $restlerBuilder = null;

    private ExtensionConfiguration $extensionConfiguration;

    public function __construct(ExtensionConfiguration $extensionConfiguration)
    {
        $this->extensionConfiguration = $extensionConfiguration;
    }

    /**
     * Get restlerBuilder on demand.
     */
    protected function getRestlerBuilder(): Builder
    {
        if ($this->restlerBuilder === null) {
            $this->restlerBuilder = GeneralUtility::makeInstance(Builder::class);
        }

        return $this->restlerBuilder;

The expression return $this->restlerBuilder could return the type null which is incompatible with the type-hinted return Aoe\Restler\System\Restler\Builder. Consider adding an additional type-check to rule them out.

    }

    protected function isRestlerPrefix(string $prefixedUrlPath): bool
    {
        if ($this->isRestlerApiUrl($prefixedUrlPath)) {
            return true;
        }

        return $this->isRestlerApiExplorerUrl($prefixedUrlPath);
    }

    protected function isRestlerApiUrl(string $prefixedUrlPath): bool
    {
        return $prefixedUrlPath === self::API_PREFIX || str_starts_with($prefixedUrlPath, self::API_PREFIX . '/');
    }

    protected function isRestlerApiExplorerUrl(string $prefixedUrlPath): bool
    {
        $apiExplorerPrefix = '/' . $this->extensionConfiguration->getPathOfOnlineDocumentation();
        return $this->extensionConfiguration->isOnlineDocumentationEnabled() && ($prefixedUrlPath === $apiExplorerPrefix || str_starts_with(
            $prefixedUrlPath,
            $apiExplorerPrefix . '/'
        ));
    }
}