Inheritance diagram for Slim_Router:

Collaboration diagram for Slim_Router:

Public Member Functions
	__construct (Slim_Http_Request $request)
	Constructor. More...

	getIterator ()
	Get Iterator. More...

	getRequest ()
	Get Request. More...

	setRequest (Slim_Http_Request $req)
	Set Request. More...

	getMatchedRoutes ( $reload=false)
	Return routes that match the current request. More...

	map ( $pattern, $callable)
	Map a route to a callback function. More...

	cacheNamedRoute ( $name, Slim_Route $route)
	Cache named route. More...

	urlFor ( $name, $params=array())
	Get URL for named route. More...

	notFound ( $callable=null)
	Register a 404 Not Found callback. More...

	error ( $callable=null)
	Register a 500 Error callback. More...

Protected Attributes
	$request

	$routes

	$namedRoutes

	$matchedRoutes

	$notFound

	$error

Detailed Description

Definition at line 45 of file Router.php.

Constructor & Destructor Documentation

◆ __construct()

Slim_Router::__construct ( Slim_Http_Request $request )

Constructor.

Parameters

Slim_Http_Request $request The HTTP request object

Definition at line 81 of file Router.php.

                                                              {
        $this->request = $request;
        $this->routes = array();
    }

References $request.

Member Function Documentation

◆ cacheNamedRoute()

Slim_Router::cacheNamedRoute	(		$name,
		Slim_Route	$route
	)

Cache named route.

Parameters

string	$name	The route name
Slim_Route	$route	The route object

Exceptions

RuntimeException If a named route already exists with the same name

Returns: void

Definition at line 147 of file Router.php.

                                                                {
        if ( isset($this->namedRoutes[(string)$name]) ) {
            throw new RuntimeException('Named route already exists with name: ' . $name);
        }
        $this->namedRoutes[$name] = $route;
    }

◆ error()

mixed Callable to be invoked if application Slim_Router::error ( $callable = null )

Register a 500 Error callback.

Parameters

mixed $callable Anything that returns TRUE for is_callable()

Returns: mixed

Definition at line 196 of file Router.php.

                                              {
        if ( is_callable($callable) ) {
            $this->error = $callable;
        }
        return $this->error;
    }

References $error, and error().

Referenced by error().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIterator()

Slim_Router::getIterator ( )

Get Iterator.

Returns: ArrayIterator

Definition at line 90 of file Router.php.

                                  {
        return new ArrayIterator($this->getMatchedRoutes());
    }

References getMatchedRoutes().

Here is the call graph for this function:

◆ getMatchedRoutes()

Slim_Router::getMatchedRoutes ( $reload = false )

Return routes that match the current request.

Returns: array[Slim_Route]

Definition at line 115 of file Router.php.

                                                        {
        if ( $reload || is_null($this->matchedRoutes) ) {
            $this->matchedRoutes = array();
            foreach ( $this->routes as $route ) {
                if ( $route->matches($this->request->getResourceUri()) ) {
                    $this->matchedRoutes[] = $route;
                }
            }
        }
        return $this->matchedRoutes;
    }

References $matchedRoutes.

Referenced by getIterator().

Here is the caller graph for this function:

◆ getRequest()

Slim_Router::getRequest ( )

Get Request.

Returns: Slim_Http_Request

Definition at line 98 of file Router.php.

                                 {
        return $this->request;
    }

References $request.

◆ map()

Slim_Router::map	(	$pattern,
		$callable
	)

Map a route to a callback function.

Parameters

string	$pattern	The URL pattern (ie. "/books/:id")
mixed	$callable	Anything that returns TRUE for is_callable()

Returns: Slim_Route

Definition at line 133 of file Router.php.

                                               {
        $route = new Slim_Route($pattern, $callable);
        $route->setRouter($this);
        $this->routes[] = $route;
        return $route;
    }

◆ notFound()

Slim_Router::notFound ( $callable = null )

Register a 404 Not Found callback.

Parameters

mixed $callable Anything that returns TRUE for is_callable()

Returns: mixed

Definition at line 184 of file Router.php.

                                                 {
        if ( is_callable($callable) ) {
            $this->notFound = $callable;
        }
        return $this->notFound;
    }

References $notFound, and notFound().

Referenced by notFound().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRequest()

Slim_Router::setRequest ( Slim_Http_Request $req )

Set Request.

Parameters

Slim_Http_Request $req

Returns: void

Definition at line 107 of file Router.php.

                                                         {
        $this->request = $req;
    }

◆ urlFor()

Slim_Router::urlFor	(	$name,
		$params = `array()`
	)

Get URL for named route.

Parameters

string	$name	The name of the route
	array	Associative array of URL parameter names and values

Exceptions

RuntimeException If named route not found

Returns: string The URL for the given route populated with the given parameters

Definition at line 161 of file Router.php.

                                                       {
        if ( !isset($this->namedRoutes[(string)$name]) ) {
            throw new RuntimeException('Named route not found for name: ' . $name);
        }
        $pattern = $this->namedRoutes[(string)$name]->getPattern();
        $search = $replace = array();
        foreach ( $params as $key => $value ) {
            $search[] = ':' . $key;
            $replace[] = $value;
        }
        $pattern = str_replace($search, $replace, $pattern);
        //Remove remnants of unpopulated, trailing optional pattern segments
        return preg_replace(array(
            '@\‍(\/?:.+\/??\‍)\??@',
            '@\?|\‍(|\‍)@'
        ), '', $this->request->getRootUri() . $pattern);
    }

References $params.

Field Documentation

◆ $error

Slim_Router::$error

protected

Definition at line 75 of file Router.php.

Referenced by error().

◆ $matchedRoutes

Slim_Router::$matchedRoutes

protected

Definition at line 65 of file Router.php.

Referenced by getMatchedRoutes().

◆ $namedRoutes

Slim_Router::$namedRoutes

protected

Definition at line 60 of file Router.php.

◆ $notFound

Slim_Router::$notFound

protected

Definition at line 70 of file Router.php.

Referenced by notFound().

◆ $request

Slim_Router::$request

protected

Definition at line 50 of file Router.php.

Referenced by __construct(), and getRequest().

◆ $routes

Slim_Router::$routes

protected

Definition at line 55 of file Router.php.

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

Services/WebServices/Rest/lib/Slim/Router.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cacheNamedRoute()

◆ error()

◆ getIterator()

◆ getMatchedRoutes()

◆ getRequest()

◆ map()

◆ notFound()

◆ setRequest()

◆ urlFor()

Field Documentation

◆ $error

◆ $matchedRoutes

◆ $namedRoutes

◆ $notFound

◆ $request

◆ $routes