RESTAPI Namespace Reference

Namespaces
namespace	Consumer
namespace	Renderer
namespace	Routes

Data Structures
class	ConsumerPermissions
class	Response
class	RouteMap
class	Router
class	RouterException
class	RouterHalt
class	UriTemplate
class	UserPermissions

Functions
catch(RouterException $e) catch(\Exception $e)	setupAuth ($router)

Variables
const	VERSION = '2'
	$router = Router::getInstance()
	try
	$uri = $_SERVER['PATH_INFO']
	$user_id = setupAuth($router)
	$response = $router->dispatch($uri)

Detailed Description

Im Namensraum RESTAPI sind alle Klassen und Funktionen versammelt, die für die RESTful Web Services von Stud.IP benötigt werden.

Function Documentation

setupAuth()

catch(RouterException $e) catch(\Exception $e) setupAuth

(

$router

)

Here is the call graph for this function:

Variable Documentation

$response

$response = $router->dispatch($uri)

$router

if (defined( 'RESTAPI\\VERSION') &&preg_match('~^/v(\d+)~i', $uri, $match) $router) = Router::getInstance()

$uri

$uri = $_SERVER['PATH_INFO']

$user_id

$user_id = setupAuth($router)

try

try

Initial value:

{
        if (!Config::get()->API_ENABLED) {
            throw new RouterException(503, 'REST API is not available');
        }
 
        require 'lib/bootstrap-api.php'

VERSION

const VERSION = '2'