PathInfo.php 2.13 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Framework\App\Request;

/**
 * Computes path info and query string from request
 */
class PathInfo
{
    /**
     * Get path info using from the request URI and base URL
     *
     * @param string $requestUri
     * @param string $baseUrl
     * @return string
     */
    public function getPathInfo(string $requestUri, string $baseUrl) : string
    {
        if ($requestUri === '/') {
            return '';
        }

        $requestUri = $this->removeRepeatedSlashes($requestUri);
        $parsedRequestUri = explode('?', $requestUri, 2);
        $pathInfo = (string)substr(current($parsedRequestUri), (int)strlen($baseUrl));

        if ($this->isNoRouteUri($baseUrl, $pathInfo)) {
            $pathInfo = \Magento\Framework\App\Router\Base::NO_ROUTE;
        }
        return $pathInfo;
    }

    /**
     * Get query string using from the request URI
     *
     * @param string $requestUri
     * @return string
     */
    public function getQueryString(string $requestUri) : string
    {
        $requestUri = $this->removeRepeatedSlashes($requestUri);
        $parsedRequestUri = explode('?', $requestUri, 2);
        $queryString = !isset($parsedRequestUri[1]) ? '' : '?' . $parsedRequestUri[1];
        return $queryString;
    }

    /**
     * Remove repeated slashes from the start of the path.
     *
     * @param string $pathInfo
     * @return string
     */
    private function removeRepeatedSlashes($pathInfo) : string
    {
        $firstChar = (string)substr($pathInfo, 0, 1);
        if ($firstChar == '/') {
            $pathInfo = '/' . ltrim($pathInfo, '/');
        }

        return $pathInfo;
    }

    /**
     * Check is URI should be marked as no route, helps route to 404 URI like `index.phpadmin`.
     *
     * @param string $baseUrl
     * @param string $pathInfo
     * @return bool
     */
    private function isNoRouteUri($baseUrl, $pathInfo) : bool
    {
        $firstChar = (string)substr($pathInfo, 0, 1);
        return $baseUrl !== '' && !in_array($firstChar, ['/', '']);
    }
}