SYSTEM - PHP Framework » \SYSTEM\SAI\saimod_sys

package	SYSTEM\SAI

System Account Request Change EMail Token

call_account_action_change_email(string $new_email) : \SYSTEM\API\JSON

inherited static

Arguments

$new_email

string

Users new EMail Address

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account Change Password

call_account_action_change_password(string $old_password_sha1, string $new_password_sha1) : \SYSTEM\API\JSON

inherited static

Arguments

$old_password_sha1

string

Users Old Password SHA1 String

$new_password_sha1

string

Users New Password SHA1 String

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account Right Check

call_account_action_check(integer $rightid) : \SYSTEM\API\JSON

inherited static

Arguments

$rightid

integer

RightID of the right to be checked

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account Confirm Tokens

call_account_action_confirm(string $token) : \SYSTEM\API\JSON

inherited static

Arguments

$token

string

Token to do specifics with your Account

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account Request Confirm EMail Token

call_account_action_confirm_email() : \SYSTEM\API\JSON

inherited static

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account Create

call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale = null) : \SYSTEM\API\JSON

inherited static

Arguments

$username

string

Username

$password_sha1

\SYSTEM\API\sha1

User Password SHA1 String

$email

\SYSTEM\API\email

Email of the new User

$locale

\SYSTEM\API\lang

Locale which the User wants to register or null for default language

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account isloggedin check

call_account_action_isloggedin() : \SYSTEM\API\JSON

inherited static

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account Login

call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale = null) : \SYSTEM\API\JSON

inherited static

Arguments

$username

string

Username

$password_sha1

\SYSTEM\API\sha1

User Password SHA1 String

$locale

\SYSTEM\API\lang

Locale which the User wants to login with

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account Logout

call_account_action_logout() : \SYSTEM\API\JSON

inherited static

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

System Account Request Reset Password Token

call_account_action_reset_password(string $username) : \SYSTEM\API\JSON

inherited static

Arguments

$username

string

Username

Response

\SYSTEM\API\JSON

Returns JSON result with success/failure status

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

Get all css System Paths required for this Saimod

css() : array

static

Response

array

Returns array of Pathobjects pointing to the saimods css

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_page() : string

static

Response

string

Returns HTML for the Saimods startpage

Add a new Page Entry

sai_mod__system_sai_saimod_sys_page_action_addcall(integer $ID, integer $group, integer $type, integer $parentID, string $parentValue, string $name, string $verify) : \SYSTEM\SAI\JSON

static

Arguments

$ID

integer

ID of the Entry

$group

integer

Group id of the Entry

$type

integer

Type of the new Entry

$parentID

integer

Parent id of the new Entry

$parentValue

string

Parent Valze of the new Entry

$name

string

Name of the new Entry

$verify

string

Verifiername of the new Entry

Response

\SYSTEM\SAI\JSON

Returns json with status true of error

Delete a Page Entry

sai_mod__system_sai_saimod_sys_page_action_deletecall(integer $ID, integer $group) : \SYSTEM\SAI\JSON

static

Arguments

$ID

integer

ID of the Entry

$group

integer

Group id of the Entry

Response

\SYSTEM\SAI\JSON

Returns json with status true of error

Generate the HTML for the Delete Dialog of a Page Entry

sai_mod__system_sai_saimod_sys_page_action_deletedialog(integer $ID, integer $group) : string

static

Arguments

$ID

integer

ID of the Entry

$group

integer

Group id of the Entry

Response

string

Returns HTML

Generate the HTML for the List of Page Entries

sai_mod__system_sai_saimod_sys_page_action_list(integer $group = null) : string

static

Arguments

$group

integer

Group Filter of the List

Response

string

Returns HTML

Generate the HTML for the New Dialog for a Page Entry

sai_mod__system_sai_saimod_sys_page_action_newdialog() : string

static

Response

string

Returns HTML

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

Internal Function to generate page row classes

tablerow_class(integer $flag) : string

static

Arguments

$flag

integer

Flag of the Page Entry

Response

string

Returns string representing the flag

Internal Function to decode Types to Strings

type_names(integer $type) : string

static

Arguments

$type

integer

Type of the Page Entry

Response

string

Returns string representing the type

saimod_sys_page

Methods

System Account Request Change EMail Token

Arguments

$new_email

Response

System Account Change Password

Arguments

$old_password_sha1

$new_password_sha1

Response

System Account Right Check

Arguments

$rightid

Response

System Account Confirm Tokens

Arguments

$token

Response

System Account Request Confirm EMail Token

Response

System Account Create

Arguments

$username

$password_sha1

$email

$locale

Response

System Account isloggedin check

Response

System Account Login

Arguments

$username

$password_sha1

$locale

Response

System Account Logout

Response

System Account Request Reset Password Token

Arguments

$username

Response

API Bug Call to report Bugs

Arguments

$message

$data

Response

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

Arguments

$id

$ident

Response

System run Cron Call

Response

System File Request Call

Arguments

$cat

$id

Response

System State-Pages Request Call

Arguments

$group

$state

Response

System Text Request Call

Arguments

$request

$lang

Response

Get all css System Paths required for this Saimod

Response

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

Arguments

$_escaped_fragment_

Response

Get the Api Group this Api is operating on

Response

API Class function - implement this function and return the Classname

Response

Get default state for this statesystem