FastRoute\RouteCollector Class Reference

Inheritance diagram for FastRoute\RouteCollector:

Collaboration diagram for FastRoute\RouteCollector:

Public Member Functions
	__construct (RouteParser $routeParser, DataGenerator $dataGenerator)
	Constructs a route collector. More...
	addRoute ($httpMethod, $route, $handler)
	Adds a route to the collection. More...
	addGroup ($prefix, callable $callback)
	Create a route group with a common prefix. More...
	get ($route, $handler)
	Adds a GET route to the collection. More...
	post ($route, $handler)
	Adds a POST route to the collection. More...
	put ($route, $handler)
	Adds a PUT route to the collection. More...
	delete ($route, $handler)
	Adds a DELETE route to the collection. More...
	patch ($route, $handler)
	Adds a PATCH route to the collection. More...
	head ($route, $handler)
	Adds a HEAD route to the collection. More...
	getData ()
	Returns the collected route data, as provided by the data generator. More...

Protected Attributes
	$routeParser
	$dataGenerator
	$currentGroupPrefix

Detailed Description

Definition at line 5 of file RouteCollector.php.

Constructor & Destructor Documentation

__construct()

FastRoute\RouteCollector::__construct	(	RouteParser	$routeParser,
		DataGenerator	$dataGenerator
	)

Constructs a route collector.

Parameters

RouteParser	$routeParser
DataGenerator	$dataGenerator

Definition at line 22 of file RouteCollector.php.

    {
        $this->routeParser = $routeParser;
        $this->dataGenerator = $dataGenerator;
        $this->currentGroupPrefix = '';
    }

Member Function Documentation

addGroup()

FastRoute\RouteCollector::addGroup	(		$prefix,
		callable	$callback
	)

Create a route group with a common prefix.

All routes created in the passed callback will have the given group prefix prepended.

Parameters

string	$prefix
callable	$callback

Definition at line 57 of file RouteCollector.php.

Referenced by FastRoute\RouteCollectorTest\testGroups().

    {
        $previousGroupPrefix = $this->currentGroupPrefix;
        $this->currentGroupPrefix = $previousGroupPrefix . $prefix;
        $callback($this);
        $this->currentGroupPrefix = $previousGroupPrefix;
    }

Here is the caller graph for this function:

addRoute()

FastRoute\RouteCollector::addRoute	(		$httpMethod,
			$route,
			$handler
	)

Adds a route to the collection.

The syntax used in the $route string depends on the used route parser.

Parameters

	string|string[]	$httpMethod
string	$route
mixed	$handler

Definition at line 38 of file RouteCollector.php.

References $handler, and array.

Referenced by FastRoute\Dispatcher\DispatcherTest\testCapturing(), FastRoute\Dispatcher\DispatcherTest\testDuplicateStaticRoute(), FastRoute\Dispatcher\DispatcherTest\testDuplicateVariableNameError(), FastRoute\Dispatcher\DispatcherTest\testDuplicateVariableRoute(), and FastRoute\Dispatcher\DispatcherTest\testShadowedStaticRoute().

    {
        $route = $this->currentGroupPrefix . $route;
        $routeDatas = $this->routeParser->parse($route);
        foreach ((array) $httpMethod as $method) {
            foreach ($routeDatas as $routeData) {
                $this->dataGenerator->addRoute($method, $routeData, $handler);
            }
        }
    }

Here is the caller graph for this function:

delete()

FastRoute\RouteCollector::delete	(		$route,
			$handler
	)

Adds a DELETE route to the collection.

This is simply an alias of $this->addRoute('DELETE', $route, $handler)

Parameters

string	$route
mixed	$handler

Definition at line 112 of file RouteCollector.php.

References $handler.

Referenced by FastRoute\RouteCollectorTest\testGroups().

    {
        $this->addRoute('DELETE', $route, $handler);
    }

Here is the caller graph for this function:

get()

FastRoute\RouteCollector::get	(		$route,
			$handler
	)

Adds a GET route to the collection.

This is simply an alias of $this->addRoute('GET', $route, $handler)

Parameters

string	$route
mixed	$handler

Definition at line 73 of file RouteCollector.php.

References $handler.

Referenced by FastRoute\RouteCollectorTest\testGroups().

    {
        $this->addRoute('GET', $route, $handler);
    }

Here is the caller graph for this function:

getData()

FastRoute\RouteCollector::getData

(

)

Returns the collected route data, as provided by the data generator.

Returns

array

Definition at line 148 of file RouteCollector.php.

    {
        return $this->dataGenerator->getData();
    }

head()

FastRoute\RouteCollector::head	(		$route,
			$handler
	)

Adds a HEAD route to the collection.

This is simply an alias of $this->addRoute('HEAD', $route, $handler)

Parameters

string	$route
mixed	$handler

Definition at line 138 of file RouteCollector.php.

References $handler.

Referenced by FastRoute\RouteCollectorTest\testGroups().

    {
        $this->addRoute('HEAD', $route, $handler);
    }

Here is the caller graph for this function:

patch()

FastRoute\RouteCollector::patch	(		$route,
			$handler
	)

Adds a PATCH route to the collection.

This is simply an alias of $this->addRoute('PATCH', $route, $handler)

Parameters

string	$route
mixed	$handler

Definition at line 125 of file RouteCollector.php.

References $handler.

Referenced by FastRoute\RouteCollectorTest\testGroups().

    {
        $this->addRoute('PATCH', $route, $handler);
    }

Here is the caller graph for this function:

post()

FastRoute\RouteCollector::post	(		$route,
			$handler
	)

Adds a POST route to the collection.

This is simply an alias of $this->addRoute('POST', $route, $handler)

Parameters

string	$route
mixed	$handler

Definition at line 86 of file RouteCollector.php.

References $handler.

Referenced by FastRoute\RouteCollectorTest\testGroups().

    {
        $this->addRoute('POST', $route, $handler);
    }

Here is the caller graph for this function:

put()

FastRoute\RouteCollector::put	(		$route,
			$handler
	)

Adds a PUT route to the collection.

This is simply an alias of $this->addRoute('PUT', $route, $handler)

Parameters

string	$route
mixed	$handler

Definition at line 99 of file RouteCollector.php.

References $handler.

Referenced by FastRoute\RouteCollectorTest\testGroups().

    {
        $this->addRoute('PUT', $route, $handler);
    }

Here is the caller graph for this function:

Field Documentation

$currentGroupPrefix

FastRoute\RouteCollector::$currentGroupPrefix

protected

Definition at line 14 of file RouteCollector.php.

$dataGenerator

FastRoute\RouteCollector::$dataGenerator

protected

Definition at line 11 of file RouteCollector.php.

$routeParser

FastRoute\RouteCollector::$routeParser

protected

Definition at line 8 of file RouteCollector.php.

---

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

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