Stud.IP  4.2 Revision
RESTAPI Namespace Reference

Namespaces

 Consumer
 
 Renderer
 
 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, $request_body)
 

Variables

const VERSION = '2'
 
 $router = Router::getInstance()
 
 try
 
 $uri = $_SERVER['PATH_INFO']
 
 $method = $_SERVER['REQUEST_METHOD']
 
if(defined('RESTAPI\\VERSION') &&preg_match('~^/v(\d+)~i', $uri, $match)) if(version_compare(phpversion(), '5.6', '<') else )
 
 $user_id = setupAuth($router, $request_body)
 
 $response = $router->dispatch($uri, $method, $request_body)
 

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) RESTAPI\setupAuth (   $router,
  $request_body 
)
Here is the call graph for this function:

Variable Documentation

◆ $method

$method = $_SERVER['REQUEST_METHOD']

◆ $response

$response = $router->dispatch($uri, $method, $request_body)

◆ $router

$router = Router::getInstance()

◆ $uri

$uri = $_SERVER['PATH_INFO']

◆ $user_id

$user_id = setupAuth($router, $request_body)

◆ else

if (defined( 'RESTAPI\\VERSION') &&preg_match('~^/v(\d+)~i', $uri, $match)) if (version_compare(phpversion(), '5.6', '<') else)
Initial value:
{
$request_body = null

◆ try

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

◆ VERSION

const VERSION = '2'