FastRoute\Dispatcher\RegexBasedAbstract Class Reference

Inheritance diagram for FastRoute\Dispatcher\RegexBasedAbstract:

Collaboration diagram for FastRoute\Dispatcher\RegexBasedAbstract:

Public Member Functions
	dispatch ($httpMethod, $uri)
	Dispatches against the provided HTTP method verb and URI. More...

Protected Member Functions
	dispatchVariableRoute ($routeData, $uri)

Protected Attributes
	$staticRouteMap = []
	$variableRouteData = []

Additional Inherited Members
Data Fields inherited from FastRoute\Dispatcher
const	NOT_FOUND = 0
const	FOUND = 1
const	METHOD_NOT_ALLOWED = 2

Detailed Description

Definition at line 7 of file RegexBasedAbstract.php.

Member Function Documentation

dispatch()

FastRoute\Dispatcher\RegexBasedAbstract::dispatch	(		$httpMethod,
			$uri
	)

Dispatches against the provided HTTP method verb and URI.

Returns array with one of the following formats:

[self::NOT_FOUND]
[self::METHOD_NOT_ALLOWED, ['GET', 'OTHER_ALLOWED_METHODS']]
[self::FOUND, $handler, ['varName' => 'value', ...]]

Parameters

string	$httpMethod
string	$uri

Returns

array

Implements FastRoute\Dispatcher.

Definition at line 20 of file RegexBasedAbstract.php.

References $handler, $result, FastRoute\Dispatcher\RegexBasedAbstract\$variableRouteData, and FastRoute\Dispatcher\RegexBasedAbstract\dispatchVariableRoute().

    {
        if (isset($this->staticRouteMap[$httpMethod][$uri])) {
            $handler = $this->staticRouteMap[$httpMethod][$uri];
            return [self::FOUND, $handler, []];
        }

        $varRouteData = $this->variableRouteData;
        if (isset($varRouteData[$httpMethod])) {
            $result = $this->dispatchVariableRoute($varRouteData[$httpMethod], $uri);
            if ($result[0] === self::FOUND) {
                return $result;
            }
        }

        // For HEAD requests, attempt fallback to GET
        if ($httpMethod === 'HEAD') {
            if (isset($this->staticRouteMap['GET'][$uri])) {
                $handler = $this->staticRouteMap['GET'][$uri];
                return [self::FOUND, $handler, []];
            }
            if (isset($varRouteData['GET'])) {
                $result = $this->dispatchVariableRoute($varRouteData['GET'], $uri);
                if ($result[0] === self::FOUND) {
                    return $result;
                }
            }
        }

        // If nothing else matches, try fallback routes
        if (isset($this->staticRouteMap['*'][$uri])) {
            $handler = $this->staticRouteMap['*'][$uri];
            return [self::FOUND, $handler, []];
        }
        if (isset($varRouteData['*'])) {
            $result = $this->dispatchVariableRoute($varRouteData['*'], $uri);
            if ($result[0] === self::FOUND) {
                return $result;
            }
        }

        // Find allowed methods for this URI by matching against all other HTTP methods as well
        $allowedMethods = [];

        foreach ($this->staticRouteMap as $method => $uriMap) {
            if ($method !== $httpMethod && isset($uriMap[$uri])) {
                $allowedMethods[] = $method;
            }
        }

        foreach ($varRouteData as $method => $routeData) {
            if ($method === $httpMethod) {
                continue;
            }

            $result = $this->dispatchVariableRoute($routeData, $uri);
            if ($result[0] === self::FOUND) {
                $allowedMethods[] = $method;
            }
        }

        // If there are no allowed methods the route simply does not exist
        if ($allowedMethods) {
            return [self::METHOD_NOT_ALLOWED, $allowedMethods];
        }

        return [self::NOT_FOUND];
    }

Here is the call graph for this function:

dispatchVariableRoute()

FastRoute\Dispatcher\RegexBasedAbstract::dispatchVariableRoute (   $routeData,   $uri  )

abstractprotected

Returns

mixed[]

Referenced by FastRoute\Dispatcher\RegexBasedAbstract\dispatch().

Here is the caller graph for this function:

Field Documentation

$staticRouteMap

FastRoute\Dispatcher\RegexBasedAbstract::$staticRouteMap = []

protected

Definition at line 10 of file RegexBasedAbstract.php.

$variableRouteData

FastRoute\Dispatcher\RegexBasedAbstract::$variableRouteData = []

protected

Definition at line 13 of file RegexBasedAbstract.php.

Referenced by FastRoute\Dispatcher\RegexBasedAbstract\dispatch().

---

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

• libs/composer/vendor/nikic/fast-route/src/Dispatcher/RegexBasedAbstract.php