Inheritance diagram for Slim\Router:

Collaboration diagram for Slim\Router:

Public Member Functions
	__construct (RouteParser $parser=null)
	Create new router. More...

	setBasePath ($basePath)
	Set the base path used in pathFor() More...

	setCacheFile ($cacheFile)
	Set path to fast route cache file. More...

	setContainer (ContainerInterface $container)

	map ($methods, $pattern, $handler)
	Add route. More...

	dispatch (ServerRequestInterface $request)
	Dispatch router for HTTP request. More...

	setDispatcher (Dispatcher $dispatcher)

	getRoutes ()
	Get route objects. More...

	getNamedRoute ($name)
	Get named route object. More...

	removeNamedRoute ($name)
	Remove named route. More...

	pushGroup ($pattern, $callable)
	Add a route group to the array. More...

	popGroup ()
	Removes the last route group from the array. More...

	lookupRoute ($identifier)

	relativePathFor ($name, array $data=[], array $queryParams=[])
	Build the path for a named route excluding the base path. More...

	pathFor ($name, array $data=[], array $queryParams=[])
	Build the path for a named route including the base path. More...

	urlFor ($name, array $data=[], array $queryParams=[])
	Build the path for a named route. More...

	map ($methods, $pattern, $handler)
	Add route. More...

	dispatch (ServerRequestInterface $request)
	Dispatch router for HTTP request. More...

	pushGroup ($pattern, $callable)
	Add a route group to the array. More...

	popGroup ()
	Removes the last route group from the array. More...

	getNamedRoute ($name)
	Get named route object. More...

	lookupRoute ($identifier)

	relativePathFor ($name, array $data=[], array $queryParams=[])
	Build the path for a named route excluding the base path. More...

	pathFor ($name, array $data=[], array $queryParams=[])
	Build the path for a named route including the base path. More...

Protected Member Functions
	createRoute ($methods, $pattern, $callable)
	Create a new Route object. More...

	createDispatcher ()

	processGroups ()
	Process route groups. More...

Protected Attributes
	$container

	$routeParser

	$basePath = ''

	$cacheFile = false

	$routes = []

	$routeCounter = 0

	$routeGroups = []

	$dispatcher

Additional Inherited Members
Data Fields inherited from Slim\Interfaces\RouterInterface
const	DISPATCH_STATUS = 0

const	ALLOWED_METHODS = 1

Detailed Description

Router.

This class organizes Slim application route objects. It is responsible for registering route objects, assigning names to route objects, finding routes that match the current HTTP request, and creating URLs for a named route.

Definition at line 31 of file Router.php.

Constructor & Destructor Documentation

◆ __construct()

Slim\Router::__construct ( RouteParser $parser = null )

Create new router.

Parameters

RouteParser $parser

Definition at line 91 of file Router.php.

    {
        $this->routeParser = $parser ?: new StdParser;
    }

References $parser.

Member Function Documentation

◆ createDispatcher()

Slim\Router::createDispatcher ( )

protected

Returns: \FastRoute\Dispatcher

Definition at line 219 of file Router.php.

    {
        if ($this->dispatcher) {
            return $this->dispatcher;
        }
 
        $routeDefinitionCallback = function (RouteCollector $r) {
            foreach ($this->getRoutes() as $route) {
                $r->addRoute($route->getMethods(), $route->getPattern(), $route->getIdentifier());
            }
        };
 
        if ($this->cacheFile) {
            $this->dispatcher = \FastRoute\cachedDispatcher($routeDefinitionCallback, [
                'routeParser' => $this->routeParser,
                'cacheFile' => $this->cacheFile,
            ]);
        } else {
            $this->dispatcher = \FastRoute\simpleDispatcher($routeDefinitionCallback, [
                'routeParser' => $this->routeParser,
            ]);
        }
 
        return $this->dispatcher;
    }

References $r.

◆ createRoute()

Slim\Router::createRoute	(	$methods,
		$pattern,
		$callable
	)

protected

Create a new Route object.

Parameters

string[]	$methods	Array of HTTP methods
string	$pattern	The route pattern
callable	$callable	The route callable

Returns: \Slim\Interfaces\RouteInterface

Definition at line 206 of file Router.php.

    {
        $route = new Route($methods, $pattern, $callable, $this->routeGroups, $this->routeCounter);
        if (!empty($this->container)) {
            $route->setContainer($this->container);
        }
 
        return $route;
    }

◆ dispatch()

Slim\Router::dispatch ( ServerRequestInterface $request )

Dispatch router for HTTP request.

Parameters

ServerRequestInterface $request The current HTTP request object

Returns: array

https://github.com/nikic/FastRoute/blob/master/src/Dispatcher.php

Implements Slim\Interfaces\RouterInterface.

Definition at line 187 of file Router.php.

    {
        $uri = '/' . ltrim($request->getUri()->getPath(), '/');
 
        return $this->createDispatcher()->dispatch(
            $request->getMethod(),
            $uri
        );
    }

References Psr\Http\Message\RequestInterface\getMethod(), and Psr\Http\Message\RequestInterface\getUri().

Here is the call graph for this function:

◆ getNamedRoute()

Slim\Router::getNamedRoute ( $name )

Get named route object.

Parameters

string $name Route name

Returns: Route

Exceptions

RuntimeException If named route does not exist

Implements Slim\Interfaces\RouterInterface.

Definition at line 272 of file Router.php.

    {
        foreach ($this->routes as $route) {
            if ($name == $route->getName()) {
                return $route;
            }
        }
        throw new RuntimeException('Named route does not exist for name: ' . $name);
    }

References $name.

◆ getRoutes()

Slim\Router::getRoutes ( )

Get route objects.

Returns: Route[]

Definition at line 258 of file Router.php.

    {
        return $this->routes;
    }

◆ lookupRoute()

Slim\Router::lookupRoute ( $identifier )

Parameters

$identifier

Returns: \Slim\Interfaces\RouteInterface

Implements Slim\Interfaces\RouterInterface.

Definition at line 341 of file Router.php.

    {
        if (!isset($this->routes[$identifier])) {
            throw new RuntimeException('Route not found, looks like your route cache is stale.');
        }
        return $this->routes[$identifier];
    }

◆ map()

Slim\Router::map	(	$methods,
		$pattern,
		$handler
	)

Add route.

Parameters

string[]	$methods	Array of HTTP methods
string	$pattern	The route pattern
callable	$handler	The route callable

Returns: RouteInterface

Exceptions

InvalidArgumentException if the route pattern isn't a string

Implements Slim\Interfaces\RouterInterface.

Definition at line 156 of file Router.php.

    {
        if (!is_string($pattern)) {
            throw new InvalidArgumentException('Route pattern must be a string');
        }
 
        // Prepend parent group pattern(s)
        if ($this->routeGroups) {
            $pattern = $this->processGroups() . $pattern;
        }
 
        // According to RFC methods are defined in uppercase (See RFC 7231)
        $methods = array_map("strtoupper", $methods);
 
        // Add route
        $route = $this->createRoute($methods, $pattern, $handler);
        $this->routes[$route->getIdentifier()] = $route;
        $this->routeCounter++;
 
        return $route;
    }

References $handler.

◆ pathFor()

Slim\Router::pathFor	(		$name,
		array	$data = `[]`,
		array	$queryParams = `[]`
	)

Build the path for a named route including the base path.

Parameters

string	$name	Route name
array	$data	Named argument replacement data
array	$queryParams	Optional query string parameters

Returns: string

Exceptions

RuntimeException	If named route does not exist
InvalidArgumentException	If required data not provided

Implements Slim\Interfaces\RouterInterface.

Definition at line 425 of file Router.php.

    {
        $url = $this->relativePathFor($name, $data, $queryParams);
 
        if ($this->basePath) {
            $url = $this->basePath . $url;
        }
 
        return $url;
    }

References $data, $name, and $url.

◆ popGroup()

Slim\Router::popGroup ( )

Removes the last route group from the array.

Returns: RouteGroup|bool The RouteGroup if successful, else False

Implements Slim\Interfaces\RouterInterface.

Definition at line 331 of file Router.php.

    {
        $group = array_pop($this->routeGroups);
        return $group instanceof RouteGroup ? $group : false;
    }

◆ processGroups()

Slim\Router::processGroups ( )

protected

Process route groups.

Returns: string A group pattern to prefix routes with

Definition at line 302 of file Router.php.

    {
        $pattern = "";
        foreach ($this->routeGroups as $group) {
            $pattern .= $group->getPattern();
        }
        return $pattern;
    }

◆ pushGroup()

Slim\Router::pushGroup	(	$pattern,
		$callable
	)

Add a route group to the array.

Parameters

string	$pattern
callable	$callable

Returns: RouteGroupInterface

Implements Slim\Interfaces\RouterInterface.

Definition at line 319 of file Router.php.

    {
        $group = new RouteGroup($pattern, $callable);
        array_push($this->routeGroups, $group);
        return $group;
    }

◆ relativePathFor()

Slim\Router::relativePathFor	(		$name,
		array	$data = `[]`,
		array	$queryParams = `[]`
	)

Build the path for a named route excluding the base path.

Parameters

string	$name	Route name
array	$data	Named argument replacement data
array	$queryParams	Optional query string parameters

Returns: string

Exceptions

RuntimeException	If named route does not exist
InvalidArgumentException	If required data not provided

Implements Slim\Interfaces\RouterInterface.

Definition at line 361 of file Router.php.

    {
        $route = $this->getNamedRoute($name);
        $pattern = $route->getPattern();
 
        $routeDatas = $this->routeParser->parse($pattern);
        // $routeDatas is an array of all possible routes that can be made. There is
        // one routedata for each optional parameter plus one for no optional parameters.
        //
        // The most specific is last, so we look for that first.
        $routeDatas = array_reverse($routeDatas);
 
        $segments = [];
        foreach ($routeDatas as $routeData) {
            foreach ($routeData as $item) {
                if (is_string($item)) {
                    // this segment is a static string
                    $segments[] = $item;
                    continue;
                }
 
                // This segment has a parameter: first element is the name
                if (!array_key_exists($item[0], $data)) {
                    // we don't have a data element for this segment: cancel
                    // testing this routeData item, so that we can try a less
                    // specific routeData item.
                    $segments = [];
                    $segmentName = $item[0];
                    break;
                }
                $segments[] = $data[$item[0]];
            }
            if (!empty($segments)) {
                // we found all the parameters for this route data, no need to check
                // less specific ones
                break;
            }
        }
 
        if (empty($segments)) {
            throw new InvalidArgumentException('Missing data for URL segment: ' . $segmentName);
        }
        $url = implode('', $segments);
 
        if ($queryParams) {
            $url .= '?' . http_build_query($queryParams);
        }
 
        return $url;
    }

References $data, $name, and $url.

◆ removeNamedRoute()

Slim\Router::removeNamedRoute ( $name )

Remove named route.

Parameters

string $name Route name

Exceptions

RuntimeException If named route does not exist

Definition at line 289 of file Router.php.

    {
        $route = $this->getNamedRoute($name);
 
        // no exception, route exists, now remove by id
        unset($this->routes[$route->getIdentifier()]);
    }

References $name.

◆ setBasePath()

Slim\Router::setBasePath ( $basePath )

Set the base path used in pathFor()

Parameters

string $basePath

Returns: self

Definition at line 103 of file Router.php.

    {
        if (!is_string($basePath)) {
            throw new InvalidArgumentException('Router basePath must be a string');
        }
 
        $this->basePath = $basePath;
 
        return $this;
    }

◆ setCacheFile()

Slim\Router::setCacheFile ( $cacheFile )

Set path to fast route cache file.

If this is false then route caching is disabled.

Parameters

string | false $cacheFile

Returns: self

Definition at line 121 of file Router.php.

    {
        if (!is_string($cacheFile) && $cacheFile !== false) {
            throw new InvalidArgumentException('Router cacheFile must be a string or false');
        }
 
        $this->cacheFile = $cacheFile;
 
        if ($cacheFile !== false && !is_writable(dirname($cacheFile))) {
            throw new RuntimeException('Router cacheFile directory must be writable');
        }
 
 
        return $this;
    }

◆ setContainer()

Slim\Router::setContainer ( ContainerInterface $container )

Parameters

ContainerInterface $container

Definition at line 140 of file Router.php.

    {
        $this->container = $container;
    }

References $container.

◆ setDispatcher()

Slim\Router::setDispatcher ( Dispatcher $dispatcher )

Parameters

\FastRoute\Dispatcher $dispatcher

Definition at line 248 of file Router.php.

    {
        $this->dispatcher = $dispatcher;
    }

◆ urlFor()

Slim\Router::urlFor	(		$name,
		array	$data = `[]`,
		array	$queryParams = `[]`
	)

Build the path for a named route.

This method is deprecated. Use pathFor() from now on.

Parameters

string	$name	Route name
array	$data	Named argument replacement data
array	$queryParams	Optional query string parameters

Returns: string

Exceptions

RuntimeException	If named route does not exist
InvalidArgumentException	If required data not provided

Definition at line 450 of file Router.php.

    {
        trigger_error('urlFor() is deprecated. Use pathFor() instead.', E_USER_DEPRECATED);
        return $this->pathFor($name, $data, $queryParams);
    }

References $data, and $name.

Field Documentation

◆ $basePath

Slim\Router::$basePath = ''

protected

Definition at line 52 of file Router.php.

◆ $cacheFile

Slim\Router::$cacheFile = false

protected

Definition at line 59 of file Router.php.

◆ $container

Slim\Router::$container

protected

Definition at line 38 of file Router.php.

◆ $dispatcher

Slim\Router::$dispatcher

protected

Definition at line 84 of file Router.php.

◆ $routeCounter

Slim\Router::$routeCounter = 0

protected

Definition at line 72 of file Router.php.

◆ $routeGroups

Slim\Router::$routeGroups = []

protected

Definition at line 79 of file Router.php.

◆ $routeParser

Slim\Router::$routeParser

protected

Definition at line 45 of file Router.php.

◆ $routes

Slim\Router::$routes = []

protected

Definition at line 66 of file Router.php.

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

libs/composer/vendor/slim/slim/Slim/Router.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createDispatcher()

◆ createRoute()

◆ dispatch()

◆ getNamedRoute()

◆ getRoutes()

◆ lookupRoute()

◆ map()

◆ pathFor()

◆ popGroup()

◆ processGroups()

◆ pushGroup()

◆ relativePathFor()

◆ removeNamedRoute()

◆ setBasePath()

◆ setCacheFile()

◆ setContainer()

◆ setDispatcher()

◆ urlFor()

Field Documentation

◆ $basePath

◆ $cacheFile

◆ $container

◆ $dispatcher

◆ $routeCounter

◆ $routeGroups

◆ $routeParser

◆ $routes