api_default

Extends \SYSTEM\API\api_system Implements \SYSTEM\API\api_default_interface

API Default class providing defaulting capabilities and Hashbang-Crawling-Scheme.

package

SYSTEM\API

Methods

API Bug Call to report Bugs

call_bug(string $message, \SYSTEM\API\JSON $data) : null
inherited static

Arguments

$message

string

Bugreport Message

$data

\SYSTEM\API\JSON

Bugreport Data

Response

null

Returns JSON result with success/failure status

API Cache Call to request cached Data (usually js and css)

call_cache(integer $id, \SYSTEM\API\sha1 $ident) : mixed
inherited static

Arguments

$id

integer

Cache id to be queried

$ident

\SYSTEM\API\sha1

Cache ident to be queried

Response

mixed

Returns cached Data from Database

System run Cron Call

call_cron() : \SYSTEM\API\JSON
inherited static

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System File Request Call

call_files(string $cat, string $id = null) : mixed
inherited static

Arguments

$cat

string

File category

$id

string

File name

Response

mixed

Returns JSON result with failure status or streams the File

System State-Pages Request Call

call_pages(integer $group, string $state) : mixed
inherited static

Arguments

$group

integer

Page Group for Statesystem

$state

string

Full name of the State.

Response

mixed

Returns JSON result with data/failure status

System Text Request Call

call_text(mixed $request, \SYSTEM\API\lang $lang) : \SYSTEM\API\JSON
inherited static

Arguments

$request

mixed

Request String for Text API

$lang

\SYSTEM\API\lang

Request Language for given text

Response

\SYSTEM\API\JSON

Returns JSON result with data/failure status

API Class function - implement this function and return the Classname

get_class() : string
static

Response

string

Returns your API-Class name

Static Time-Parameter _ Call to avoid caching and API Errors for JS requests

static__(mixed $_) : null
inherited static

Arguments

$_

mixed

Anticaching Parameter of some Browsers

Response

null

Returns nothing

Static Call handler for Hashbang-Crawling Requests

static__escaped_fragment_(string $_escaped_fragment_) : string
static

Arguments

$_escaped_fragment_

string

Hashbang-Encoded State

Response

string

Returns your API-HTML result as HTML-Snapshot

Static Call to change Language for the current Session/User

static__lang(\SYSTEM\API\lang $lang) : null
inherited static

Arguments

$lang

\SYSTEM\API\lang

Language requested

Response

null

Returns nothing

Static Call to change Result-Type for the current Session/User

static__result(\SYSTEM\API\result $result) : null
inherited static

Arguments

$result

\SYSTEM\API\result

Resulttype

Response

null

Returns nothing