SYSTEM - PHP Framework
Back to top  

saimod_sys_docu

Extends \SYSTEM\SAI\SaiModule

saimod_sys_docu Class provided by System as saimod to display the code documentation

package

SYSTEM\SAI

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

Default Page anchor to catch all calls not answered by the saimod api

default_page(string $_escaped_fragment_ = null) : string
inherited static

Arguments

$_escaped_fragment_

string

Param for Hashbangcrawling

Response

string

Returns HTML of the defaultpage

Get the Api Group this Api is operating on

get_apigroup() : integer
inherited static

Response

integer

Returns api group id.

API Class function - implement this function and return the Classname

get_class() : string
inherited static

Response

string

Returns your API-Class name

Get default state for this statesystem

get_default_state() : string
inherited static

Response

string

Returns name of the startstate.

Fixes Classnames for sai postfield

get_params(array $params) : array
inherited static

Arguments

$params

array

Params to be corrected

Response

array

Returns array of corrected Params.

Generate the <li> menu for the Saimod Override this

html_li_menu() : string
inherited static

Response

string

Returns HTML of the

  • menu for the Saimod

    • Get all js System Paths required for this Saimod

    js() : array
    static

    Response

    array

    Returns array of Pathobjects pointing to the saimods js

    Check public state for the Saimod.

    right_public() : boolean
    inherited static

    Override this

    Response

    boolean

    Returns true if the saimod is public

    Check rights for the Saimod.

    right_right() : boolean
    inherited static

    Override this

    Response

    boolean

    Returns true if accessable for the user else false

    Generate the HTML for the Saimods startpage

    sai_mod__SYSTEM_SAI_saimod_sys_docu(string $cat = '\SYSTEM\DOCU\docu_system') : string
    static

    Arguments

    $cat

    string

    Docu selected

    Response

    string

    Returns HTML for the Saimods startpage

    Generate the HTML Documentation

    sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate() : \SYSTEM\SAI\json
    static

    Response

    \SYSTEM\SAI\json

    Returns jsn with log

    Generate the MD Documentation based on the HTML Documentation

    sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate_md() : null
    static

    Response

    null

    Returns null

    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
    inherited 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