Ubiquity  2.0.0
php rapid development framework
RestServer Class Reference

Public Member Functions

 __construct ($config)
 
 connect (RestController $controller)
 
 isValid ()
 Check if token is valid. More...
 
 _getHeaderToken ()
 
 finalizeTokens ()
 
 _getHeader ($header)
 
 _addHeaderToken ($token)
 
 _getApiTokens ()
 To override for defining another ApiToken type. More...
 
 _header ($headerField, $value=null, $replace=null)
 
 _setContentType ($contentType, $charset=null)
 
 cors ()
 

Static Public Member Functions

static getRestNamespace ()
 

Protected Attributes

 $config
 
 $headers
 
 $tokensFolder
 
 $tokensCacheKey ="_apiTokens"
 
 $apiTokens
 

Detailed Description

Author
jc

Definition at line 15 of file RestServer.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $config)

Definition at line 30 of file RestServer.php.

Member Function Documentation

◆ _addHeaderToken()

_addHeaderToken (   $token)

Definition at line 88 of file RestServer.php.

◆ _getApiTokens()

_getApiTokens ( )

To override for defining another ApiToken type.

Returns
ApiTokens

Definition at line 96 of file RestServer.php.

◆ _getHeader()

_getHeader (   $header)

Definition at line 80 of file RestServer.php.

◆ _getHeaderToken()

_getHeaderToken ( )

Definition at line 59 of file RestServer.php.

◆ _header()

_header (   $headerField,
  $value = null,
  $replace = null 
)
Parameters
string$headerField
string$value
boolean$replace

Definition at line 106 of file RestServer.php.

◆ _setContentType()

_setContentType (   $contentType,
  $charset = null 
)
Parameters
string$contentTypedefault application/json
string$charsetdefault utf8

Definition at line 121 of file RestServer.php.

◆ connect()

connect ( RestController  $controller)

Definition at line 35 of file RestServer.php.

◆ cors()

cors ( )

Definition at line 128 of file RestServer.php.

◆ finalizeTokens()

finalizeTokens ( )

Definition at line 73 of file RestServer.php.

◆ getRestNamespace()

static getRestNamespace ( )
static

Definition at line 145 of file RestServer.php.

◆ isValid()

isValid ( )

Check if token is valid.

Returns
boolean

Definition at line 48 of file RestServer.php.

Field Documentation

◆ $apiTokens

$apiTokens
protected

Definition at line 28 of file RestServer.php.

◆ $config

$config
protected

Definition at line 20 of file RestServer.php.

◆ $headers

$headers
protected

Definition at line 21 of file RestServer.php.

◆ $tokensCacheKey

$tokensCacheKey ="_apiTokens"
protected

Definition at line 23 of file RestServer.php.

◆ $tokensFolder

$tokensFolder
protected

Definition at line 22 of file RestServer.php.


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