FastRoute\RouteParser\Std Class Reference

Parses route strings of the following form: More...

Inheritance diagram for FastRoute\RouteParser\Std:

Collaboration diagram for FastRoute\RouteParser\Std:

Public Member Functions
	parse ($route)
	Parses a route string into multiple route data arrays. More...

Data Fields
const	VARIABLE_REGEX
const	DEFAULT_DISPATCH_REGEX = '[^/]+'

Private Member Functions
	parsePlaceholders ($route)
	Parses a route string that does not contain optional segments. More...

Detailed Description

Parses route strings of the following form:

"/user/{name}[/{id:[0-9]+}]"

Definition at line 13 of file Std.php.

Member Function Documentation

parse()

FastRoute\RouteParser\Std::parse

(

$route

)

Parses a route string into multiple route data arrays.

The expected output is defined using an example:

For the route string "/fixedRoutePart/{varName}[/moreFixed/{varName2:\d+}]", if {varName} is interpreted as a placeholder and [...] is interpreted as an optional route part, the expected result is:

[ // first route: without optional part [ "/fixedRoutePart/", ["varName", "[^/]+"], ], // second route: with optional part [ "/fixedRoutePart/", ["varName", "[^/]+"], "/moreFixed/", ["varName2", [0-9]+"], ], ]

Here one route string was converted into two route data arrays.

Parameters

string

$route

Route string to parse

Returns

mixed[][] Array of route data arrays

Implements FastRoute\RouteParser.

Definition at line 25 of file Std.php.

References $n, and FastRoute\RouteParser\Std\parsePlaceholders().

    {
        $routeWithoutClosingOptionals = rtrim($route, ']');
        $numOptionals = strlen($route) - strlen($routeWithoutClosingOptionals);

        // Split on [ while skipping placeholders
        $segments = preg_split('~' . self::VARIABLE_REGEX . '(*SKIP)(*F) | \[~x', $routeWithoutClosingOptionals);
        if ($numOptionals !== count($segments) - 1) {
            // If there are any ] in the middle of the route, throw a more specific error message
            if (preg_match('~' . self::VARIABLE_REGEX . '(*SKIP)(*F) | \]~x', $routeWithoutClosingOptionals)) {
                throw new BadRouteException('Optional segments can only occur at the end of a route');
            }
            throw new BadRouteException("Number of opening '[' and closing ']' does not match");
        }

        $currentRoute = '';
        $routeDatas = [];
        foreach ($segments as $n => $segment) {
            if ($segment === '' && $n !== 0) {
                throw new BadRouteException('Empty optional part');
            }

            $currentRoute .= $segment;
            $routeDatas[] = $this->parsePlaceholders($currentRoute);
        }
        return $routeDatas;
    }

Here is the call graph for this function:

parsePlaceholders()

FastRoute\RouteParser\Std::parsePlaceholders (   $route )

private

Parses a route string that does not contain optional segments.

Parameters

string

Returns

mixed[]

Definition at line 59 of file Std.php.

Referenced by FastRoute\RouteParser\Std\parse().

    {
        if (!preg_match_all(
            '~' . self::VARIABLE_REGEX . '~x', $route, $matches,
            PREG_OFFSET_CAPTURE | PREG_SET_ORDER
        )) {
            return [$route];
        }

        $offset = 0;
        $routeData = [];
        foreach ($matches as $set) {
            if ($set[0][1] > $offset) {
                $routeData[] = substr($route, $offset, $set[0][1] - $offset);
            }
            $routeData[] = [
                $set[1][0],
                isset($set[2]) ? trim($set[2][0]) : self::DEFAULT_DISPATCH_REGEX
            ];
            $offset = $set[0][1] + strlen($set[0][0]);
        }

        if ($offset !== strlen($route)) {
            $routeData[] = substr($route, $offset);
        }

        return $routeData;
    }

Here is the caller graph for this function:

Field Documentation

DEFAULT_DISPATCH_REGEX

const FastRoute\RouteParser\Std::DEFAULT_DISPATCH_REGEX = '[^/]+'

Definition at line 23 of file Std.php.

VARIABLE_REGEX

const FastRoute\RouteParser\Std::VARIABLE_REGEX

Initial value:

= <<<'REGEX'
\{
    \s* ([a-zA-Z_][a-zA-Z0-9_-]*) \s*
    (?:
        : \s* ([^{}]*(?:\{(?-1)\}[^{}]*)*)
    )?
\}
REGEX

Definition at line 15 of file Std.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/nikic/fast-route/src/RouteParser/Std.php