SYSTEM - PHP Framework
Back to top  

api

API Class provided by System for Smart API's.

package

SYSTEM\API

Methods

Internal API function to parse commands for requested API

do_commands(array $params, array $tree) : array
static

Arguments

$params

array

Parameters given to the API

$tree

array

Array with API rules

Response

array

Returns array with parsed Commands

Internal API function to parse default redirect for requested API

do_default(boolean $default, string $apiclassname, string $call_funcname = null) : array
static

Arguments

$default

boolean

Defaulting to default_page setting

$apiclassname

string

Classname of the users API class

$call_funcname

string

Functionname which was called

Response

array

Array of static API rules

Internal API function to build function name for requested API

do_func_name(array $commands) : string
static

Arguments

$commands

array

Array of all Commands for the given API call

Response

string

Returns Function name

Internal API function to build function paramters for requested API

do_func_params(array $parameters, array $parameters_opt) : array
static

Arguments

$parameters

array

Array of all Paramters for the given API call

$parameters_opt

array

Array of all optional Paramters for the given API call

Response

array

Returns array with Paramters

Internal API function to parse parameters for requested API

do_parameters(array $params, array $tree, integer $parentid, string $lastcommandvalue, string $verifyclassname) : array
static

Arguments

$params

array

Parameters given to the API

$tree

array

Array with API rules

$parentid

integer

Parentid of last Tree Element

$lastcommandvalue

string

Last value of last Command

$verifyclassname

string

Verify Class given to the API

Response

array

Returns array with parsed Parameters

Internal API function to parse optional parameters for requested API

do_parameters_opt(array $params, array $tree, integer $parentid, string $lastcommandvalue, string $verifyclassname) : array
static

Arguments

$params

array

Parameters given to the API

$tree

array

Array with API rules

$parentid

integer

Parentid of last Tree Element

$lastcommandvalue

string

Last value of last Command

$verifyclassname

string

Verify Class given to the API

Response

array

Returns array with parsed optional Parameters

Internal API function to parse statics for requested API

do_statics(array $params, array $tree, string $apiclassname, string $verifyclassname, boolean $default) : array
static

Arguments

$params

array

Array of Params given to the API

$tree

array

Array of Rules for given API

$apiclassname

string

Classname of the users API class

$verifyclassname

string

Classname of the users Verify Class

$default

boolean

Defaulting to default_page setting

Response

array

Array of static API rules

Internal API function to strict parse the API

do_strict(boolean $strict, array $params, array $statics, array $commands, array $parameters, array $parameters_opt) : null
static

Arguments

$strict

boolean

Strict settings

$params

array

Parameters given to the API

$statics

array

Array with API statics

$commands

array

Array with API commands

$parameters

array

Array with API parameters

$parameters_opt

array

Array with API optional parameters

Response

null

Returns nothing or throws an Strict Error

Internal API function to retrive the Databasetree for requested API

getApiTree(integer $group) : array
static

Arguments

$group

integer

API Group to be read

Response

array

Array of API rules

Run the API Mechanism with your Data.

run(string $verifyclassname, string $apiclassname, array $params, integer $group = self::DEFAULT_GROUP, boolean $strict = self::DEFAULT_STRICT, boolean $default = self::DEFAULT_DEFAULT) : mixed
static

Arguments

$verifyclassname

string

Your class on which the parameter restriction is parsed upon

$apiclassname

string

Your class which provides your API

$params

array

Parameters given to the API

$group

integer

API Group to be used to parse Call

$strict

boolean

Parse the API in a strict way

$default

boolean

Defaulting to default_page setting

Response

mixed

Returns your API result or an JSON Error

Constants

int Root Node ID

ROOT_PARENTID

int Default API Group

DEFAULT_GROUP

bool Default parse strict setting

DEFAULT_STRICT

bool Default parse to default setting

DEFAULT_DEFAULT