Slim\Route Class Reference

Route. More...

Inheritance diagram for Slim\Route:

Collaboration diagram for Slim\Route:

Public Member Functions
	__construct ($methods, $pattern, $callable, $groups=[], $identifier=0)
	Create new route. More...
	finalize ()
	Finalize the route in preparation for dispatching. More...
	getCallable ()
	Get route callable. More...
	setCallable ($callable)
	This method enables you to override the Route's callable. More...
	getMethods ()
	Get route methods. More...
	getGroups ()
	Get parent route groups. More...
	getName ()
	Get route name. More...
	getIdentifier ()
	Get route identifier. More...
	getOutputBuffering ()
	Get output buffering mode. More...
	setOutputBuffering ($mode)
	Set output buffering mode. More...
	setName ($name)
	Set route name. More...
	setArgument ($name, $value, $includeInSavedArguments=true)
	Set a route argument. More...
	setArguments (array $arguments, $includeInSavedArguments=true)
	Replace route arguments. More...
	getArguments ()
	Retrieve route arguments. More...
	getArgument ($name, $default=null)
	Retrieve a specific route argument. More...
	prepare (ServerRequestInterface $request, array $arguments)
	Prepare the route for use. More...
	run (ServerRequestInterface $request, ResponseInterface $response)
	Run route. More...
Public Member Functions inherited from Slim\Routable
	getMiddleware ()
	Get the middleware registered for the group. More...
	getPattern ()
	Get the route pattern. More...
	setContainer (ContainerInterface $container)
	Set container for use with resolveCallable. More...
	add ($callable)
	Prepend middleware to the middleware collection. More...
	setPattern ($newPattern)
	Set the route pattern. More...
Public Member Functions inherited from Slim\Interfaces\RouteInterface
	getArgument ($name, $default=null)
	Retrieve a specific route argument. More...
	getArguments ()
	Get route arguments. More...
	getName ()
	Get route name. More...
	getPattern ()
	Get route pattern. More...
	setArgument ($name, $value)
	Set a route argument. More...
	setArguments (array $arguments)
	Replace route arguments. More...
	setOutputBuffering ($mode)
	Set output buffering mode. More...
	setName ($name)
	Set route name. More...
	add ($callable)
	Add middleware. More...
	prepare (ServerRequestInterface $request, array $arguments)
	Prepare the route for use. More...
	run (ServerRequestInterface $request, ResponseInterface $response)
	Run route. More...
	__invoke (ServerRequestInterface $request, ResponseInterface $response)
	Dispatch route callable against current Request and Response objects. More...

Protected Attributes
	$methods = []
	$identifier
	$name
	$groups
	$outputBuffering = 'append'
	$arguments = []
	$savedArguments = []
	$callable
Protected Attributes inherited from Slim\Routable
	$callable
	$container
	$middleware = []
	$pattern

Private Attributes
	$finalized = false

Detailed Description

Route.

Definition at line 21 of file Route.php.

Constructor & Destructor Documentation

__construct()

Slim\Route::__construct	(		$methods,
			$pattern,
			$callable,
			$groups = [],
			$identifier = 0
	)

Create new route.

Parameters

string | string[]	$methods	The route HTTP methods
string	$pattern	The route pattern
callable	$callable	The route callable
RouteGroup[]	$groups	The parent route groups
int	$identifier	The route identifier

Definition at line 94 of file Route.php.

    {
        $this->methods  = is_string($methods) ? [$methods] : $methods;
        $this->pattern  = $pattern;
        $this->callable = $callable;
        $this->groups   = $groups;
        $this->identifier = 'route' . $identifier;
    }

Member Function Documentation

finalize()

Slim\Route::finalize

(

)

Finalize the route in preparation for dispatching.

Definition at line 106 of file Route.php.

    {
        if ($this->finalized) {
            return;
        }
 
        $groupMiddleware = [];
        foreach ($this->getGroups() as $group) {
            $groupMiddleware = array_merge($group->getMiddleware(), $groupMiddleware);
        }
 
        $this->middleware = array_merge($this->middleware, $groupMiddleware);
 
        foreach ($this->getMiddleware() as $middleware) {
            $this->addMiddleware($middleware);
        }
 
        $this->finalized = true;
    }

References Slim\addMiddleware().

Here is the call graph for this function:

getArgument()

Slim\Route::getArgument	(		$name,
			$default = null
	)

Retrieve a specific route argument.

Parameters

string	$name
string | null	$default

Returns

mixed

Implements Slim\Interfaces\RouteInterface.

Definition at line 287 of file Route.php.

    {
        if (array_key_exists($name, $this->arguments)) {
            return $this->arguments[$name];
        }
        return $default;
    }

References $name.

getArguments()

Slim\Route::getArguments

(

)

Retrieve route arguments.

Returns

array

Implements Slim\Interfaces\RouteInterface.

Definition at line 274 of file Route.php.

    {
        return $this->arguments;
    }

getCallable()

Slim\Route::getCallable

(

)

Get route callable.

Returns

callable

Definition at line 131 of file Route.php.

    {
        return $this->callable;
    }

getGroups()

Slim\Route::getGroups

(

)

Get parent route groups.

Returns

RouteGroup[]

Definition at line 161 of file Route.php.

    {
        return $this->groups;
    }

getIdentifier()

Slim\Route::getIdentifier

(

)

Get route identifier.

Returns

string

Definition at line 181 of file Route.php.

    {
        return $this->identifier;
    }

getMethods()

Slim\Route::getMethods

(

)

Get route methods.

Returns

string[]

Definition at line 151 of file Route.php.

    {
        return $this->methods;
    }

getName()

Slim\Route::getName

(

)

Get route name.

Returns

null|string

Implements Slim\Interfaces\RouteInterface.

Definition at line 171 of file Route.php.

    {
        return $this->name;
    }

References $name.

getOutputBuffering()

Slim\Route::getOutputBuffering

(

)

Get output buffering mode.

Returns

boolean|string

Definition at line 191 of file Route.php.

    {
        return $this->outputBuffering;
    }

prepare()

Slim\Route::prepare	(	ServerRequestInterface	$request,
		array	$arguments
	)

Prepare the route for use.

Parameters

ServerRequestInterface	$request
array	$arguments

Implements Slim\Interfaces\RouteInterface.

Definition at line 305 of file Route.php.

    {
        // Remove temp arguments
        $this->setArguments($this->savedArguments);
 
        // Add the route arguments
        foreach ($arguments as $k => $v) {
            $this->setArgument($k, $v, false);
        }
    }

run()

Slim\Route::run	(	ServerRequestInterface	$request,
		ResponseInterface	$response
	)

Run route.

This method traverses the middleware stack, including the route's callable and captures the resultant HTTP response object. It then sends the response back to the Application.

Parameters

ServerRequestInterface	$request
ResponseInterface	$response

Returns

ResponseInterface

Implements Slim\Interfaces\RouteInterface.

Definition at line 328 of file Route.php.

    {
        // Finalise route now that we are about to run it
        $this->finalize();
 
        // Traverse middleware stack and fetch updated response
        return $this->callMiddlewareStack($request, $response);
    }

References $response.

setArgument()

Slim\Route::setArgument	(		$name,
			$value,
			$includeInSavedArguments = true
	)

Set a route argument.

Parameters

string	$name
string	$value
bool	$includeInSavedArguments

Returns

self

Definition at line 243 of file Route.php.

    {
        if ($includeInSavedArguments) {
            $this->savedArguments[$name] = $value;
        }
        $this->arguments[$name] = $value;
        return $this;
    }

References $name.

setArguments()

Slim\Route::setArguments	(	array	$arguments,
			$includeInSavedArguments = true
	)

Replace route arguments.

Parameters

array	$arguments
bool	$includeInSavedArguments

Returns

self

Definition at line 260 of file Route.php.

    {
        if ($includeInSavedArguments) {
            $this->savedArguments = $arguments;
        }
        $this->arguments = $arguments;
        return $this;
    }

setCallable()

Slim\Route::setCallable

(

$callable

)

This method enables you to override the Route's callable.

Parameters

string | \Closure

$callable

Definition at line 141 of file Route.php.

    {
        $this->callable = $callable;
    }

setName()

Slim\Route::setName

(

$name

)

Set route name.

Parameters

string

$name

Returns

self

Exceptions

InvalidArgumentException

if the route name is not a string

Implements Slim\Interfaces\RouteInterface.

Definition at line 225 of file Route.php.

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

References $name.

setOutputBuffering()

Slim\Route::setOutputBuffering

(

$mode

)

Set output buffering mode.

One of: false, 'prepend' or 'append'

Parameters

boolean | string

$mode

Returns

self

Exceptions

InvalidArgumentException

If an unknown buffering mode is specified

Implements Slim\Interfaces\RouteInterface.

Definition at line 207 of file Route.php.

    {
        if (!in_array($mode, [false, 'prepend', 'append'], true)) {
            throw new InvalidArgumentException('Unknown output buffering mode');
        }
        $this->outputBuffering = $mode;
        return $this;
    }

Field Documentation

$arguments

Slim\Route::$arguments = []

protected

Definition at line 69 of file Route.php.

$callable

Slim\Route::$callable

protected

Definition at line 83 of file Route.php.

$finalized

Slim\Route::$finalized = false

private

Definition at line 53 of file Route.php.

$groups

Slim\Route::$groups

protected

Definition at line 51 of file Route.php.

$identifier

Slim\Route::$identifier

protected

Definition at line 37 of file Route.php.

$methods

Slim\Route::$methods = []

protected

Definition at line 30 of file Route.php.

$name

Slim\Route::$name

protected

Definition at line 44 of file Route.php.

$outputBuffering

Slim\Route::$outputBuffering = 'append'

protected

Definition at line 62 of file Route.php.

$savedArguments

Slim\Route::$savedArguments = []

protected

Definition at line 76 of file Route.php.

---

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

• libs/composer/vendor/slim/slim/Slim/Route.php