updated md docu
parent
0dd604843e
commit
66ca23259d
43
ApiIndex.md
43
ApiIndex.md
@ -25,7 +25,9 @@ API Index
|
||||
* [DBInfoMYS](SYSTEM-DB-DBInfoMYS)
|
||||
* SYSTEM\SQL
|
||||
* [SYS_TEXT_GET_ID_ADV](SYSTEM-SQL-SYS_TEXT_GET_ID_ADV)
|
||||
* [SYS_SECURITY_AVAILABLE_EMAIL](SYSTEM-SQL-SYS_SECURITY_AVAILABLE_EMAIL)
|
||||
* [SYS_SAIMOD_CRON_SINGLE_SELECT](SYSTEM-SQL-SYS_SAIMOD_CRON_SINGLE_SELECT)
|
||||
* [SYS_SECURITY_CONFIRM_EMAIL](SYSTEM-SQL-SYS_SECURITY_CONFIRM_EMAIL)
|
||||
* [SYS_PAGE_GROUP](SYSTEM-SQL-SYS_PAGE_GROUP)
|
||||
* [SYS_SAIMOD_TEXT_COUNT_TAG](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_TAG)
|
||||
* [system_text](SYSTEM-SQL-system_text)
|
||||
@ -34,8 +36,6 @@ API Index
|
||||
* [SYS_TEXT_GET_ID_TAGS](SYSTEM-SQL-SYS_TEXT_GET_ID_TAGS)
|
||||
* [system_user_to_rights](SYSTEM-SQL-system_user_to_rights)
|
||||
* [SYS_SAIMOD_TODO_LIST_FREE](SYSTEM-SQL-SYS_SAIMOD_TODO_LIST_FREE)
|
||||
* [DATA_SYSTEM_PAGE](SYSTEM-SQL-DATA_SYSTEM_PAGE)
|
||||
* [DATA_SYSTEM_RIGHTS](SYSTEM-SQL-DATA_SYSTEM_RIGHTS)
|
||||
* [SYS_SAIMOD_LOG_UNIQUE_REQUEST](SYSTEM-SQL-SYS_SAIMOD_LOG_UNIQUE_REQUEST)
|
||||
* [SYS_SAIMOD_TODO_EDIT](SYSTEM-SQL-SYS_SAIMOD_TODO_EDIT)
|
||||
* [SYS_TEXT_GET_TAG](SYSTEM-SQL-SYS_TEXT_GET_TAG)
|
||||
@ -50,20 +50,21 @@ API Index
|
||||
* [SYS_SAIMOD_SECURITY_USER_LOG](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_LOG)
|
||||
* [SYS_SAIMOD_API_SINGLE_SELECT](SYSTEM-SQL-SYS_SAIMOD_API_SINGLE_SELECT)
|
||||
* [SYS_SAIMOD_LOG_UNIQUE_EXCEPTION](SYSTEM-SQL-SYS_SAIMOD_LOG_UNIQUE_EXCEPTION)
|
||||
* [DATA_SYSTEM_TEXT](SYSTEM-SQL-DATA_SYSTEM_TEXT)
|
||||
* [SYS_SAIMOD_SECURITY_RENAME_USER](SYSTEM-SQL-SYS_SAIMOD_SECURITY_RENAME_USER)
|
||||
* [SYS_CRON_LAST_VISIT](SYSTEM-SQL-SYS_CRON_LAST_VISIT)
|
||||
* [SYS_SAIMOD_TODO_STATS_USERS](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_USERS)
|
||||
* [SYS_TEXT_DELETE_TAGS](SYSTEM-SQL-SYS_TEXT_DELETE_TAGS)
|
||||
* [SYS_SAIMOD_LOG_FILTERS](SYSTEM-SQL-SYS_SAIMOD_LOG_FILTERS)
|
||||
* [SYS_TEXT_RENAME_TAGS](SYSTEM-SQL-SYS_TEXT_RENAME_TAGS)
|
||||
* [SYS_SAIMOD_TEXT_COUNT_NOTAG](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_NOTAG)
|
||||
* [SCHEMA_SYSTEM](SYSTEM-SQL-SCHEMA_SYSTEM)
|
||||
* [SYS_SAIMOD_TODO_STATS_COUNT_TODO_NOT_ASSIGNED](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_COUNT_TODO_NOT_ASSIGNED)
|
||||
* [SYS_SECURITY_LOGIN_SHA1](SYSTEM-SQL-SYS_SECURITY_LOGIN_SHA1)
|
||||
* [DATA_SYSTEM_API](SYSTEM-SQL-DATA_SYSTEM_API)
|
||||
* [SYS_SAIMOD_LOG_UNIQUE_REFERER](SYSTEM-SQL-SYS_SAIMOD_LOG_UNIQUE_REFERER)
|
||||
* [SYS_SAIMOD_TODO_STATS_COUNT_DOTO_GEN](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_COUNT_DOTO_GEN)
|
||||
* [SYS_TEXT_GET_ID](SYSTEM-SQL-SYS_TEXT_GET_ID)
|
||||
* [SYS_SAIMOD_SECURITY_DELETE_USER](SYSTEM-SQL-SYS_SAIMOD_SECURITY_DELETE_USER)
|
||||
* [SYS_SAIMOD_LOG_ANALYTICS](SYSTEM-SQL-SYS_SAIMOD_LOG_ANALYTICS)
|
||||
* [DATA_SYSTEM_CRON](SYSTEM-SQL-DATA_SYSTEM_CRON)
|
||||
* [SYS_SAIMOD_TEXT_TEXT_TAG_FILTER](SYSTEM-SQL-SYS_SAIMOD_TEXT_TEXT_TAG_FILTER)
|
||||
* [SYS_SAIMOD_TODO_TODO](SYSTEM-SQL-SYS_SAIMOD_TODO_TODO)
|
||||
* [SYS_SAIMOD_TODO_DEASSIGN](SYSTEM-SQL-SYS_SAIMOD_TODO_DEASSIGN)
|
||||
@ -72,7 +73,6 @@ API Index
|
||||
* [SYS_SAIMOD_TODO_COUNT_FREE](SYSTEM-SQL-SYS_SAIMOD_TODO_COUNT_FREE)
|
||||
* [SYS_SAIMOD_TEXT_COUNT_NOTAG_FILTER](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_NOTAG_FILTER)
|
||||
* [SYS_API_TREE](SYSTEM-SQL-SYS_API_TREE)
|
||||
* [DATA_SYSTEM_TEXT](SYSTEM-SQL-DATA_SYSTEM_TEXT)
|
||||
* [SYS_CACHE_CHECK](SYSTEM-SQL-SYS_CACHE_CHECK)
|
||||
* [system_user](SYSTEM-SQL-system_user)
|
||||
* [SYS_SAIMOD_TEXT_COUNT](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT)
|
||||
@ -80,6 +80,7 @@ API Index
|
||||
* [SYS_TEXT_GET_ID_COUNT](SYSTEM-SQL-SYS_TEXT_GET_ID_COUNT)
|
||||
* [SYS_SAIMOD_PAGE_ADD](SYSTEM-SQL-SYS_SAIMOD_PAGE_ADD)
|
||||
* [setup](SYSTEM-SQL-setup)
|
||||
* [SYS_SECURITY_RESET_PASSWORD](SYSTEM-SQL-SYS_SECURITY_RESET_PASSWORD)
|
||||
* [SYS_SECURITY_UPDATE_PW](SYSTEM-SQL-SYS_SECURITY_UPDATE_PW)
|
||||
* [SYS_SAIMOD_LOG_ERROR](SYSTEM-SQL-SYS_SAIMOD_LOG_ERROR)
|
||||
* [system_cron](SYSTEM-SQL-system_cron)
|
||||
@ -95,6 +96,7 @@ API Index
|
||||
* [SYS_SAIMOD_SECURITY_USERS_FILTER](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USERS_FILTER)
|
||||
* [SYS_SAIMOD_TEXT_TEXT](SYSTEM-SQL-SYS_SAIMOD_TEXT_TEXT)
|
||||
* [SYS_SAIMOD_TODO_COUNT](SYSTEM-SQL-SYS_SAIMOD_TODO_COUNT)
|
||||
* [DATA_SYSTEM_RIGHTS](SYSTEM-SQL-DATA_SYSTEM_RIGHTS)
|
||||
* [SYS_SECURITY_CREATE](SYSTEM-SQL-SYS_SECURITY_CREATE)
|
||||
* [SYS_SECURITY_UPDATE_LASTACTIVE](SYSTEM-SQL-SYS_SECURITY_UPDATE_LASTACTIVE)
|
||||
* [SYS_SAIMOD_TEXT_TEXT_NOTAG](SYSTEM-SQL-SYS_SAIMOD_TEXT_TEXT_NOTAG)
|
||||
@ -102,6 +104,7 @@ API Index
|
||||
* [SYS_SAIMOD_CACHE_CLEAR](SYSTEM-SQL-SYS_SAIMOD_CACHE_CLEAR)
|
||||
* [SYS_SAIMOD_TODO_STATS_COUNT_DOTO_REPORT](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_COUNT_DOTO_REPORT)
|
||||
* [SYS_SAIMOD_TODO_COUNT_TYPE](SYSTEM-SQL-SYS_SAIMOD_TODO_COUNT_TYPE)
|
||||
* [DATA_SYSTEM_CRON](SYSTEM-SQL-DATA_SYSTEM_CRON)
|
||||
* [SYS_SAIMOD_CACHE_COUNT](SYSTEM-SQL-SYS_SAIMOD_CACHE_COUNT)
|
||||
* [SYS_SAIMOD_TODO_CLOSE_ALL](SYSTEM-SQL-SYS_SAIMOD_TODO_CLOSE_ALL)
|
||||
* [SYS_SAIMOD_LOG_BASIC_QUERYTIME](SYSTEM-SQL-SYS_SAIMOD_LOG_BASIC_QUERYTIME)
|
||||
@ -109,6 +112,7 @@ API Index
|
||||
* [SYS_SAIMOD_TODO_CLOSE](SYSTEM-SQL-SYS_SAIMOD_TODO_CLOSE)
|
||||
* [SYS_TEXT_DELETE](SYSTEM-SQL-SYS_TEXT_DELETE)
|
||||
* [SYS_SAIMOD_SECURITY_USER_COUNT_FILTER](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_COUNT_FILTER)
|
||||
* [SYS_SECURITY_USER_INFO](SYSTEM-SQL-SYS_SECURITY_USER_INFO)
|
||||
* [SYS_SAIMOD_SECURITY_USER_RIGHTS](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_RIGHTS)
|
||||
* [SYS_CACHE_PUT](SYSTEM-SQL-SYS_CACHE_PUT)
|
||||
* [SYS_LOG_INSERT](SYSTEM-SQL-SYS_LOG_INSERT)
|
||||
@ -132,27 +136,34 @@ API Index
|
||||
* [SYS_SAIMOD_TODO_STATS_COUNT_DOTO_USER](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_COUNT_DOTO_USER)
|
||||
* [SYS_SAIMOD_LOG_UNIQUE_BASIC](SYSTEM-SQL-SYS_SAIMOD_LOG_UNIQUE_BASIC)
|
||||
* [SYS_SAIMOD_TODO_STATS_CLOSED](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_CLOSED)
|
||||
* [SYS_TOKEN_INSERT](SYSTEM-SQL-SYS_TOKEN_INSERT)
|
||||
* [SYS_SAIMOD_LOG_TRUNCATE](SYSTEM-SQL-SYS_SAIMOD_LOG_TRUNCATE)
|
||||
* [SYS_SAIMOD_TODO_ASSIGNEES](SYSTEM-SQL-SYS_SAIMOD_TODO_ASSIGNEES)
|
||||
* [SYS_SAIMOD_SECURITY_RIGHT_DELETE](SYSTEM-SQL-SYS_SAIMOD_SECURITY_RIGHT_DELETE)
|
||||
* [DATA_SYSTEM_API](SYSTEM-SQL-DATA_SYSTEM_API)
|
||||
* [SYS_SAIMOD_LOG_BASIC_SUCCESS](SYSTEM-SQL-SYS_SAIMOD_LOG_BASIC_SUCCESS)
|
||||
* [SYS_SAIMOD_LOG_CLASS_OTHER](SYSTEM-SQL-SYS_SAIMOD_LOG_CLASS_OTHER)
|
||||
* [SYS_CRON_GET](SYSTEM-SQL-SYS_CRON_GET)
|
||||
* [SCHEMA_SYSTEM](SYSTEM-SQL-SCHEMA_SYSTEM)
|
||||
* [SYS_SAIMOD_CRON_CHANGE](SYSTEM-SQL-SYS_SAIMOD_CRON_CHANGE)
|
||||
* [SYS_SAIMOD_TODO_ASSIGN](SYSTEM-SQL-SYS_SAIMOD_TODO_ASSIGN)
|
||||
* [system_log](SYSTEM-SQL-system_log)
|
||||
* [SYS_CRON_UPD](SYSTEM-SQL-SYS_CRON_UPD)
|
||||
* [SYS_SECURITY_CHANGE_EMAIL](SYSTEM-SQL-SYS_SECURITY_CHANGE_EMAIL)
|
||||
* [SYS_TOKEN_GET](SYSTEM-SQL-SYS_TOKEN_GET)
|
||||
* [SYS_TOKEN_CONFIRM](SYSTEM-SQL-SYS_TOKEN_CONFIRM)
|
||||
* [SYS_SAIMOD_API_GROUPS](SYSTEM-SQL-SYS_SAIMOD_API_GROUPS)
|
||||
* [SYS_SAIMOD_SECURITY_USER_COUNT](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_COUNT)
|
||||
* [SYS_TEXT_SAVE_TAG](SYSTEM-SQL-SYS_TEXT_SAVE_TAG)
|
||||
* [SYS_TEXT_GET_TAG_ADV](SYSTEM-SQL-SYS_TEXT_GET_TAG_ADV)
|
||||
* [SYS_SECURITY_USER_SESSIONID](SYSTEM-SQL-SYS_SECURITY_USER_SESSIONID)
|
||||
* [SYS_SAIMOD_TEXT_COUNT_FILTER](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_FILTER)
|
||||
* [DATA_SYSTEM_PAGE](SYSTEM-SQL-DATA_SYSTEM_PAGE)
|
||||
* [SYS_LOG_OLDEST](SYSTEM-SQL-SYS_LOG_OLDEST)
|
||||
* [SYS_SECURITY_LOGIN_MD5](SYSTEM-SQL-SYS_SECURITY_LOGIN_MD5)
|
||||
* [SYS_TEXT_SEARCH_TAG](SYSTEM-SQL-SYS_TEXT_SEARCH_TAG)
|
||||
* [SYS_SAIMOD_SECURITY_DELETE_USER_RIGHTS](SYSTEM-SQL-SYS_SAIMOD_SECURITY_DELETE_USER_RIGHTS)
|
||||
* [SYS_SAIMOD_TEXT_COUNT_TAG_FILTER](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_TAG_FILTER)
|
||||
* [SYS_SAIMOD_LOG_BASIC_VISITOR](SYSTEM-SQL-SYS_SAIMOD_LOG_BASIC_VISITOR)
|
||||
* [SYS_SECURITY_LOGIN_USER_SHA1](SYSTEM-SQL-SYS_SECURITY_LOGIN_USER_SHA1)
|
||||
* [SYS_LOCALE_SET_LOCALE](SYSTEM-SQL-SYS_LOCALE_SET_LOCALE)
|
||||
* [SYS_SAIMOD_LOG_FILTER](SYSTEM-SQL-SYS_SAIMOD_LOG_FILTER)
|
||||
* [SYS_SAIMOD_SECURITY_USER_RIGHT_DELETE](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_RIGHT_DELETE)
|
||||
@ -167,6 +178,7 @@ API Index
|
||||
* [SYS_SAIMOD_CRON](SYSTEM-SQL-SYS_SAIMOD_CRON)
|
||||
* [SYS_SAIMOD_CRON_DEL](SYSTEM-SQL-SYS_SAIMOD_CRON_DEL)
|
||||
* [SYS_SAIMOD_API_GET](SYSTEM-SQL-SYS_SAIMOD_API_GET)
|
||||
* [DATA_DEFAULT](SYSTEM-SQL-DATA_DEFAULT)
|
||||
* [SYS_CACHE_DELETE](SYSTEM-SQL-SYS_CACHE_DELETE)
|
||||
* [SYS_SAIMOD_TODO_LIST_MINE](SYSTEM-SQL-SYS_SAIMOD_TODO_LIST_MINE)
|
||||
* SYSTEM\SAI
|
||||
@ -193,12 +205,11 @@ API Index
|
||||
* [SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* [saimod_sys_git](SYSTEM-SAI-saimod_sys_git)
|
||||
* [todo_stats](SYSTEM-SAI-todo_stats)
|
||||
* [saimod_sys_langswitcher](SYSTEM-SAI-saimod_sys_langswitcher)
|
||||
* [saimod_sys_text](SYSTEM-SAI-saimod_sys_text)
|
||||
* [saimod_sys_config](SYSTEM-SAI-saimod_sys_config)
|
||||
* SYSTEM\SECURITY
|
||||
* [RIGHTS](SYSTEM-SECURITY-RIGHTS)
|
||||
* [Security](SYSTEM-SECURITY-Security)
|
||||
* [security](SYSTEM-SECURITY-security)
|
||||
* [User](SYSTEM-SECURITY-User)
|
||||
* [system](SYSTEM-system)
|
||||
* SYSTEM\PAGE
|
||||
@ -206,9 +217,12 @@ API Index
|
||||
* [Page](SYSTEM-PAGE-Page)
|
||||
* [State](SYSTEM-PAGE-State)
|
||||
* [ParensParser](SYSTEM-PAGE-ParensParser)
|
||||
* [DefaultPage](SYSTEM-PAGE-DefaultPage)
|
||||
* [replace](SYSTEM-PAGE-replace)
|
||||
* SYSTEM\DOCU
|
||||
* [docu](SYSTEM-DOCU-docu)
|
||||
* [docu_system](SYSTEM-DOCU-docu_system)
|
||||
* [docu_package](SYSTEM-DOCU-docu_package)
|
||||
* SYSTEM\LOG
|
||||
* [error_handler_jsonoutput](SYSTEM-LOG-error_handler_jsonoutput)
|
||||
* [ERROR_EXCEPTION](SYSTEM-LOG-ERROR_EXCEPTION)
|
||||
@ -219,7 +233,6 @@ API Index
|
||||
* [TranslatableError](SYSTEM-LOG-TranslatableError)
|
||||
* [SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
* [error_handler](SYSTEM-LOG-error_handler)
|
||||
* [AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
* [INFO](SYSTEM-LOG-INFO)
|
||||
* [TODO](SYSTEM-LOG-TODO)
|
||||
* [COUNTER](SYSTEM-LOG-COUNTER)
|
||||
@ -228,10 +241,17 @@ API Index
|
||||
* [error_handler_dbwriter](SYSTEM-LOG-error_handler_dbwriter)
|
||||
* [CRON](SYSTEM-LOG-CRON)
|
||||
* [WARNING](SYSTEM-LOG-WARNING)
|
||||
* SYSTEM\TOKEN
|
||||
* [token](SYSTEM-TOKEN-token)
|
||||
* [token_change_email](SYSTEM-TOKEN-token_change_email)
|
||||
* [token_confirm_email](SYSTEM-TOKEN-token_confirm_email)
|
||||
* [token_handler](SYSTEM-TOKEN-token_handler)
|
||||
* [token_reset_password](SYSTEM-TOKEN-token_reset_password)
|
||||
* SYSTEM\API
|
||||
* [api_system](SYSTEM-API-api_system)
|
||||
* [api](SYSTEM-API-api)
|
||||
* [api_login](SYSTEM-API-api_login)
|
||||
* [api_default_interface](SYSTEM-API-api_default_interface)
|
||||
* [api_default](SYSTEM-API-api_default)
|
||||
* [verify](SYSTEM-API-verify)
|
||||
* [PATH](SYSTEM-PATH)
|
||||
@ -267,7 +287,6 @@ API Index
|
||||
* [TODO](TODO)
|
||||
* [ERROR](ERROR)
|
||||
* LIB
|
||||
* [lib_textillate](LIB-lib_textillate)
|
||||
* [lib_css](LIB-lib_css)
|
||||
* [lib_jscss](LIB-lib_jscss)
|
||||
* [lib_php](LIB-lib_php)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
DEPRECATED
|
||||
===============
|
||||
|
||||
Deprecated Log Class provided by System for marking code as Deprecated.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: DEPRECATED
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
18
ERROR.md
18
ERROR.md
@ -1,9 +1,9 @@
|
||||
ERROR
|
||||
===============
|
||||
|
||||
Error Log Class provided by System for all kinds of Errors.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: ERROR
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
18
INFO.md
18
INFO.md
@ -1,9 +1,9 @@
|
||||
INFO
|
||||
===============
|
||||
|
||||
Info Log Class provided by System for logging Infos.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: INFO
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
JsonResult
|
||||
===============
|
||||
|
||||
|
||||
JsonResult Class provided by System to return Data as JSON or MSGPACK.
|
||||
|
||||
|
||||
|
||||
@ -12,24 +12,6 @@ JsonResult
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
----------
|
||||
|
||||
|
||||
### JSONRESULT_OK
|
||||
|
||||
const JSONRESULT_OK = true
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### JSONRESULT_ERROR
|
||||
|
||||
const JSONRESULT_ERROR = false
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -40,62 +22,62 @@ Methods
|
||||
|
||||
### toString
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::toString($json_array, $status, $start_time)
|
||||
|
||||
string SYSTEM\LOG\JsonResult::toString(array $json_array, boolean $status, integer $start_time)
|
||||
|
||||
Retun JsonResult with data given by array
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $json_array **mixed**
|
||||
* $status **mixed**
|
||||
* $start_time **mixed**
|
||||
* $json_array **array** - <p>Data which should be included in the JSOn Result.</p>
|
||||
* $status **boolean** - <p>true or false depending on success</p>
|
||||
* $start_time **integer** - <p>To calculate Querytime - if Null System time is used.</p>
|
||||
|
||||
|
||||
|
||||
### error
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::error(\Exception $e)
|
||||
|
||||
string SYSTEM\LOG\JsonResult::error(\Exception $e)
|
||||
|
||||
Retun JsonResult for given Exception
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $e **Exception**
|
||||
* $e **Exception** - <p>Exception to be convered.</p>
|
||||
|
||||
|
||||
|
||||
### ok
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::ok()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
|
||||
|
||||
|
||||
|
||||
### fail
|
||||
|
||||
mixed SYSTEM\LOG\JsonResult::fail()
|
||||
|
||||
string SYSTEM\LOG\JsonResult::ok()
|
||||
|
||||
Retun JsonResult with success status
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)
|
||||
|
||||
|
||||
|
||||
|
||||
### fail
|
||||
|
||||
string SYSTEM\LOG\JsonResult::fail()
|
||||
|
||||
Retun JsonResult with failure status
|
||||
|
||||
|
||||
|
||||
|
||||
18
LIB-lib.md
18
LIB-lib.md
@ -1,7 +1,7 @@
|
||||
LIB\lib
|
||||
===============
|
||||
|
||||
|
||||
Lib Class provided by System to define API to load libs.
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### php
|
||||
|
||||
mixed LIB\lib::php()
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed LIB\lib::css()
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
@ -50,9 +50,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed LIB\lib::js()
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
@ -64,9 +64,9 @@ Methods
|
||||
|
||||
### version
|
||||
|
||||
mixed LIB\lib::version()
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
LIB\lib_controll
|
||||
===============
|
||||
|
||||
|
||||
lib_controll Class provided by System to register libs.
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ Properties
|
||||
|
||||
private mixed $libs = array()
|
||||
|
||||
|
||||
array Variable to store all registred libs
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### check_lib
|
||||
|
||||
mixed LIB\lib_controll::check_lib($lib)
|
||||
|
||||
boolean LIB\lib_controll::check_lib(string $lib)
|
||||
|
||||
Check if given class is a valid lib
|
||||
|
||||
|
||||
|
||||
@ -46,15 +46,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lib **mixed**
|
||||
* $lib **string** - <p>Lib Class</p>
|
||||
|
||||
|
||||
|
||||
### register
|
||||
|
||||
mixed LIB\lib_controll::register($classname)
|
||||
|
||||
null LIB\lib_controll::register(string $classname)
|
||||
|
||||
Register given class as lib
|
||||
|
||||
|
||||
|
||||
@ -63,15 +63,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $classname **mixed**
|
||||
* $classname **string** - <p>Lib Class</p>
|
||||
|
||||
|
||||
|
||||
### all
|
||||
|
||||
mixed LIB\lib_controll::all()
|
||||
|
||||
array LIB\lib_controll::all()
|
||||
|
||||
Get all registered libs available
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
LIB\lib_css
|
||||
===============
|
||||
|
||||
|
||||
css lib Class provided by System to provide css libs.
|
||||
|
||||
|
||||
|
||||
@ -23,9 +23,9 @@ Methods
|
||||
|
||||
### css_path
|
||||
|
||||
mixed LIB\lib_css::css_path()
|
||||
|
||||
string LIB\lib_css::css_path()
|
||||
|
||||
Get Css lib include path
|
||||
|
||||
|
||||
|
||||
@ -37,9 +37,9 @@ Methods
|
||||
|
||||
### php
|
||||
|
||||
mixed LIB\lib::php()
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
|
||||
|
||||
|
||||
@ -52,9 +52,9 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed LIB\lib::css()
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
@ -67,9 +67,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed LIB\lib::js()
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
@ -82,9 +82,9 @@ Methods
|
||||
|
||||
### version
|
||||
|
||||
mixed LIB\lib::version()
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
LIB\lib_js
|
||||
===============
|
||||
|
||||
|
||||
js lib Class provided by System to provide js libs.
|
||||
|
||||
|
||||
|
||||
@ -23,9 +23,9 @@ Methods
|
||||
|
||||
### js_path
|
||||
|
||||
mixed LIB\lib_js::js_path()
|
||||
|
||||
string LIB\lib_js::js_path()
|
||||
|
||||
Get js lib include path
|
||||
|
||||
|
||||
|
||||
@ -37,9 +37,9 @@ Methods
|
||||
|
||||
### php
|
||||
|
||||
mixed LIB\lib::php()
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
|
||||
|
||||
|
||||
@ -52,9 +52,9 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed LIB\lib::css()
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
@ -67,9 +67,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed LIB\lib::js()
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
@ -82,9 +82,9 @@ Methods
|
||||
|
||||
### version
|
||||
|
||||
mixed LIB\lib::version()
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
LIB\lib_jscss
|
||||
===============
|
||||
|
||||
|
||||
js+css lib Class provided by System to provide js+css libs.
|
||||
|
||||
|
||||
|
||||
@ -23,9 +23,9 @@ Methods
|
||||
|
||||
### js_path
|
||||
|
||||
mixed LIB\lib_jscss::js_path()
|
||||
|
||||
string LIB\lib_jscss::js_path()
|
||||
|
||||
Get js lib include path
|
||||
|
||||
|
||||
|
||||
@ -37,9 +37,9 @@ Methods
|
||||
|
||||
### css_path
|
||||
|
||||
mixed LIB\lib_jscss::css_path()
|
||||
|
||||
string LIB\lib_jscss::css_path()
|
||||
|
||||
Get Css lib include path
|
||||
|
||||
|
||||
|
||||
@ -51,9 +51,9 @@ Methods
|
||||
|
||||
### php
|
||||
|
||||
mixed LIB\lib::php()
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
|
||||
|
||||
|
||||
@ -66,9 +66,9 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed LIB\lib::css()
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
@ -81,9 +81,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed LIB\lib::js()
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
@ -96,9 +96,9 @@ Methods
|
||||
|
||||
### version
|
||||
|
||||
mixed LIB\lib::version()
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
LIB\lib_php
|
||||
===============
|
||||
|
||||
|
||||
php lib Class provided by System to provide php libs.
|
||||
|
||||
|
||||
|
||||
@ -23,9 +23,9 @@ Methods
|
||||
|
||||
### php_autoload
|
||||
|
||||
mixed LIB\lib_php::php_autoload()
|
||||
|
||||
null LIB\lib_php::php_autoload()
|
||||
|
||||
include the php files to be used
|
||||
|
||||
|
||||
|
||||
@ -37,9 +37,9 @@ Methods
|
||||
|
||||
### php
|
||||
|
||||
mixed LIB\lib::php()
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
|
||||
|
||||
|
||||
@ -52,9 +52,9 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed LIB\lib::css()
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
@ -67,9 +67,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed LIB\lib::js()
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
@ -82,9 +82,9 @@ Methods
|
||||
|
||||
### version
|
||||
|
||||
mixed LIB\lib::version()
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
LIB\lib_system
|
||||
===============
|
||||
|
||||
|
||||
lib_system Class provided by System to serve system.js and system.css library.
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### get_class
|
||||
|
||||
mixed LIB\lib_system::get_class()
|
||||
|
||||
string LIB\lib_system::get_class()
|
||||
|
||||
Get Classname of the Library
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### js_path
|
||||
|
||||
mixed LIB\lib_jscss::js_path()
|
||||
|
||||
string LIB\lib_jscss::js_path()
|
||||
|
||||
Get js lib include path
|
||||
|
||||
|
||||
|
||||
@ -51,9 +51,9 @@ Methods
|
||||
|
||||
### css_path
|
||||
|
||||
mixed LIB\lib_jscss::css_path()
|
||||
|
||||
string LIB\lib_jscss::css_path()
|
||||
|
||||
Get Css lib include path
|
||||
|
||||
|
||||
|
||||
@ -66,9 +66,9 @@ Methods
|
||||
|
||||
### version
|
||||
|
||||
mixed LIB\lib::version()
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
@ -81,9 +81,9 @@ Methods
|
||||
|
||||
### php
|
||||
|
||||
mixed LIB\lib::php()
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
|
||||
|
||||
|
||||
@ -96,9 +96,9 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed LIB\lib::css()
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
@ -111,9 +111,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed LIB\lib::js()
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,110 +0,0 @@
|
||||
LIB\lib_textillate
|
||||
===============
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: lib_textillate
|
||||
* Namespace: LIB
|
||||
* Parent class: [LIB\lib_js](LIB-lib_js)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed LIB\lib_textillate::get_class()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### js_path
|
||||
|
||||
mixed LIB\lib_js::js_path()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib_js](LIB-lib_js)
|
||||
|
||||
|
||||
|
||||
|
||||
### version
|
||||
|
||||
mixed LIB\lib::version()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### php
|
||||
|
||||
mixed LIB\lib::php()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
mixed LIB\lib::css()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
mixed LIB\lib::js()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\API\api
|
||||
===============
|
||||
|
||||
|
||||
API Class provided by System for Smart API's.
|
||||
|
||||
|
||||
|
||||
@ -55,9 +55,9 @@ Methods
|
||||
|
||||
### run
|
||||
|
||||
mixed SYSTEM\API\api::run($verifyclassname, $apiclassname, $params, $group, $strict, $default)
|
||||
|
||||
mixed SYSTEM\API\api::run(string $verifyclassname, string $apiclassname, array $params, integer $group, boolean $strict, boolean $default)
|
||||
|
||||
Run the API Mechanism with your Data.
|
||||
|
||||
|
||||
|
||||
@ -66,20 +66,20 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $verifyclassname **mixed**
|
||||
* $apiclassname **mixed**
|
||||
* $params **mixed**
|
||||
* $group **mixed**
|
||||
* $strict **mixed**
|
||||
* $default **mixed**
|
||||
* $verifyclassname **string** - <p>Your class on which the parameter restriction is parsed upon</p>
|
||||
* $apiclassname **string** - <p>Your class which provides your API</p>
|
||||
* $params **array** - <p>Parameters given to the API</p>
|
||||
* $group **integer** - <p>API Group to be used to parse Call</p>
|
||||
* $strict **boolean** - <p>Parse the API in a strict way</p>
|
||||
* $default **boolean** - <p>Defaulting to default_page setting</p>
|
||||
|
||||
|
||||
|
||||
### getApiTree
|
||||
|
||||
mixed SYSTEM\API\api::getApiTree($group)
|
||||
|
||||
array SYSTEM\API\api::getApiTree(integer $group)
|
||||
|
||||
Internal API function to retrive the Databasetree for requested API
|
||||
|
||||
|
||||
|
||||
@ -88,15 +88,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $group **integer** - <p>API Group to be read</p>
|
||||
|
||||
|
||||
|
||||
### do_statics
|
||||
|
||||
mixed SYSTEM\API\api::do_statics($params, $tree, $apiclassname, $verifyclassname, $default)
|
||||
|
||||
array SYSTEM\API\api::do_statics(array $params, array $tree, string $apiclassname, string $verifyclassname, boolean $default)
|
||||
|
||||
Internal API function to parse statics for requested API
|
||||
|
||||
|
||||
|
||||
@ -105,19 +105,19 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $tree **mixed**
|
||||
* $apiclassname **mixed**
|
||||
* $verifyclassname **mixed**
|
||||
* $default **mixed**
|
||||
* $params **array** - <p>Array of Params given to the API</p>
|
||||
* $tree **array** - <p>Array of Rules for given API</p>
|
||||
* $apiclassname **string** - <p>Classname of the users API class</p>
|
||||
* $verifyclassname **string** - <p>Classname of the users Verify Class</p>
|
||||
* $default **boolean** - <p>Defaulting to default_page setting</p>
|
||||
|
||||
|
||||
|
||||
### do_default
|
||||
|
||||
mixed SYSTEM\API\api::do_default($default, $apiclassname, $call_funcname)
|
||||
|
||||
array SYSTEM\API\api::do_default(boolean $default, string $apiclassname, string $call_funcname)
|
||||
|
||||
Internal API function to parse default redirect for requested API
|
||||
|
||||
|
||||
|
||||
@ -126,17 +126,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $default **mixed**
|
||||
* $apiclassname **mixed**
|
||||
* $call_funcname **mixed**
|
||||
* $default **boolean** - <p>Defaulting to default_page setting</p>
|
||||
* $apiclassname **string** - <p>Classname of the users API class</p>
|
||||
* $call_funcname **string** - <p>Functionname which was called</p>
|
||||
|
||||
|
||||
|
||||
### do_strict
|
||||
|
||||
mixed SYSTEM\API\api::do_strict($strict, $params, $statics, $commands, $parameters, $parameters_opt)
|
||||
|
||||
null SYSTEM\API\api::do_strict(boolean $strict, array $params, array $statics, array $commands, array $parameters, array $parameters_opt)
|
||||
|
||||
Internal API function to strict parse the API
|
||||
|
||||
|
||||
|
||||
@ -145,20 +145,20 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $strict **mixed**
|
||||
* $params **mixed**
|
||||
* $statics **mixed**
|
||||
* $commands **mixed**
|
||||
* $parameters **mixed**
|
||||
* $parameters_opt **mixed**
|
||||
* $strict **boolean** - <p>Strict settings</p>
|
||||
* $params **array** - <p>Parameters given to the API</p>
|
||||
* $statics **array** - <p>Array with API statics</p>
|
||||
* $commands **array** - <p>Array with API commands</p>
|
||||
* $parameters **array** - <p>Array with API parameters</p>
|
||||
* $parameters_opt **array** - <p>Array with API optional parameters</p>
|
||||
|
||||
|
||||
|
||||
### do_commands
|
||||
|
||||
mixed SYSTEM\API\api::do_commands($params, $tree)
|
||||
|
||||
array SYSTEM\API\api::do_commands(array $params, array $tree)
|
||||
|
||||
Internal API function to parse commands for requested API
|
||||
|
||||
|
||||
|
||||
@ -167,16 +167,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $tree **mixed**
|
||||
* $params **array** - <p>Parameters given to the API</p>
|
||||
* $tree **array** - <p>Array with API rules</p>
|
||||
|
||||
|
||||
|
||||
### do_parameters
|
||||
|
||||
mixed SYSTEM\API\api::do_parameters($params, $tree, $parentid, $lastcommandvalue, $verifyclassname)
|
||||
|
||||
array SYSTEM\API\api::do_parameters(array $params, array $tree, integer $parentid, string $lastcommandvalue, string $verifyclassname)
|
||||
|
||||
Internal API function to parse parameters for requested API
|
||||
|
||||
|
||||
|
||||
@ -185,19 +185,19 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $tree **mixed**
|
||||
* $parentid **mixed**
|
||||
* $lastcommandvalue **mixed**
|
||||
* $verifyclassname **mixed**
|
||||
* $params **array** - <p>Parameters given to the API</p>
|
||||
* $tree **array** - <p>Array with API rules</p>
|
||||
* $parentid **integer** - <p>Parentid of last Tree Element</p>
|
||||
* $lastcommandvalue **string** - <p>Last value of last Command</p>
|
||||
* $verifyclassname **string** - <p>Verify Class given to the API</p>
|
||||
|
||||
|
||||
|
||||
### do_parameters_opt
|
||||
|
||||
mixed SYSTEM\API\api::do_parameters_opt($params, $tree, $parentid, $lastcommandvalue, $verifyclassname)
|
||||
|
||||
array SYSTEM\API\api::do_parameters_opt(array $params, array $tree, integer $parentid, string $lastcommandvalue, string $verifyclassname)
|
||||
|
||||
Internal API function to parse optional parameters for requested API
|
||||
|
||||
|
||||
|
||||
@ -206,19 +206,19 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $tree **mixed**
|
||||
* $parentid **mixed**
|
||||
* $lastcommandvalue **mixed**
|
||||
* $verifyclassname **mixed**
|
||||
* $params **array** - <p>Parameters given to the API</p>
|
||||
* $tree **array** - <p>Array with API rules</p>
|
||||
* $parentid **integer** - <p>Parentid of last Tree Element</p>
|
||||
* $lastcommandvalue **string** - <p>Last value of last Command</p>
|
||||
* $verifyclassname **string** - <p>Verify Class given to the API</p>
|
||||
|
||||
|
||||
|
||||
### do_func_name
|
||||
|
||||
mixed SYSTEM\API\api::do_func_name($commands)
|
||||
|
||||
string SYSTEM\API\api::do_func_name(array $commands)
|
||||
|
||||
Internal API function to build function name for requested API
|
||||
|
||||
|
||||
|
||||
@ -227,15 +227,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $commands **mixed**
|
||||
* $commands **array** - <p>Array of all Commands for the given API call</p>
|
||||
|
||||
|
||||
|
||||
### do_func_params
|
||||
|
||||
mixed SYSTEM\API\api::do_func_params($parameters, $parameters_opt)
|
||||
|
||||
array SYSTEM\API\api::do_func_params(array $parameters, array $parameters_opt)
|
||||
|
||||
Internal API function to build function paramters for requested API
|
||||
|
||||
|
||||
|
||||
@ -244,7 +244,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $parameters **mixed**
|
||||
* $parameters_opt **mixed**
|
||||
* $parameters **array** - <p>Array of all Paramters for the given API call</p>
|
||||
* $parameters_opt **array** - <p>Array of all optional Paramters for the given API call</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\API\api_default
|
||||
===============
|
||||
|
||||
|
||||
API Default class providing defaulting capabilities and Hashbang-Crawling-Scheme.
|
||||
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ SYSTEM\API\api_default
|
||||
* Namespace: SYSTEM\API
|
||||
* This is an **abstract** class
|
||||
* Parent class: [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
* This class implements: [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
@ -23,9 +23,9 @@ Methods
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -34,29 +34,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -64,64 +50,13 @@ Methods
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -134,9 +69,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -146,16 +81,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -165,16 +100,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -184,16 +119,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -203,15 +138,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -221,15 +156,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -239,15 +174,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -257,16 +192,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -276,16 +211,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -295,17 +230,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -318,9 +253,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -333,9 +268,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -345,15 +280,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -363,9 +298,145 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
### get_apigroup
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
66
SYSTEM-API-api_default_interface.md
Normal file
66
SYSTEM-API-api_default_interface.md
Normal file
@ -0,0 +1,66 @@
|
||||
SYSTEM\API\api_default_interface
|
||||
===============
|
||||
|
||||
api_default Interface used internally in api_default Class
|
||||
can be used insted of api_default if hashbang mechanic should not be used.
|
||||
|
||||
|
||||
|
||||
|
||||
* Interface name: api_default_interface
|
||||
* Namespace: SYSTEM\API
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
|
||||
### get_apigroup
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\API\api_login
|
||||
===============
|
||||
|
||||
|
||||
API Login class providing System Account Functionality.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -32,17 +32,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -54,9 +54,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -68,9 +68,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -79,15 +79,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -96,9 +96,92 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\API\api_system
|
||||
===============
|
||||
|
||||
|
||||
API System class providing System Functionality.
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -47,16 +47,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -65,16 +65,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -83,16 +83,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -101,15 +101,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -118,15 +118,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -135,15 +135,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -152,16 +152,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -170,16 +170,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -189,17 +189,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -212,9 +212,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -227,9 +227,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -239,15 +239,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -257,9 +257,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\API\verify
|
||||
===============
|
||||
|
||||
|
||||
API default verify Class for Parameter validation
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### ALL
|
||||
|
||||
mixed SYSTEM\API\verify::ALL($param)
|
||||
|
||||
boolean SYSTEM\API\verify::ALL(mixed $param)
|
||||
|
||||
Verify All - everything is allowed
|
||||
|
||||
|
||||
|
||||
@ -32,15 +32,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### UINT
|
||||
|
||||
mixed SYSTEM\API\verify::UINT($param)
|
||||
|
||||
boolean SYSTEM\API\verify::UINT(mixed $param)
|
||||
|
||||
Verify UINT - Positive Integer excluding 0
|
||||
|
||||
|
||||
|
||||
@ -49,15 +49,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### UINT0
|
||||
|
||||
mixed SYSTEM\API\verify::UINT0($param)
|
||||
|
||||
boolean SYSTEM\API\verify::UINT0(mixed $param)
|
||||
|
||||
Verify UINT0 - Positive Integer including 0
|
||||
|
||||
|
||||
|
||||
@ -66,15 +66,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### INT
|
||||
|
||||
mixed SYSTEM\API\verify::INT($param)
|
||||
|
||||
boolean SYSTEM\API\verify::INT(mixed $param)
|
||||
|
||||
Verify INT - all integers
|
||||
|
||||
|
||||
|
||||
@ -83,15 +83,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### TIMEUNIX
|
||||
|
||||
mixed SYSTEM\API\verify::TIMEUNIX($param)
|
||||
|
||||
boolean SYSTEM\API\verify::TIMEUNIX(mixed $param)
|
||||
|
||||
Verify TIMEUNIX - unixtimestamp number
|
||||
|
||||
|
||||
|
||||
@ -100,15 +100,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### DATE
|
||||
|
||||
mixed SYSTEM\API\verify::DATE($param)
|
||||
|
||||
boolean SYSTEM\API\verify::DATE(mixed $param)
|
||||
|
||||
Verify DATE - string parseable as date
|
||||
|
||||
|
||||
|
||||
@ -117,15 +117,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### STRING
|
||||
|
||||
mixed SYSTEM\API\verify::STRING($param)
|
||||
|
||||
boolean SYSTEM\API\verify::STRING(mixed $param)
|
||||
|
||||
Verify STRING - allow every string - thats all
|
||||
|
||||
|
||||
|
||||
@ -134,15 +134,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### BOOL
|
||||
|
||||
mixed SYSTEM\API\verify::BOOL($param)
|
||||
|
||||
boolean SYSTEM\API\verify::BOOL(mixed $param)
|
||||
|
||||
Verify BOOL - allow booleans
|
||||
|
||||
|
||||
|
||||
@ -151,15 +151,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### FLOAT
|
||||
|
||||
mixed SYSTEM\API\verify::FLOAT($param)
|
||||
|
||||
boolean SYSTEM\API\verify::FLOAT(mixed $param)
|
||||
|
||||
Verify FLOAT - every float value
|
||||
|
||||
|
||||
|
||||
@ -168,15 +168,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### JSON
|
||||
|
||||
mixed SYSTEM\API\verify::JSON($param)
|
||||
|
||||
boolean SYSTEM\API\verify::JSON(mixed $param)
|
||||
|
||||
Verify JSON - JSON format check
|
||||
|
||||
|
||||
|
||||
@ -185,15 +185,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### ARY
|
||||
|
||||
mixed SYSTEM\API\verify::ARY($param)
|
||||
|
||||
boolean SYSTEM\API\verify::ARY(mixed $param)
|
||||
|
||||
Verify ARY - array check
|
||||
|
||||
|
||||
|
||||
@ -202,15 +202,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### LANG
|
||||
|
||||
mixed SYSTEM\API\verify::LANG($param)
|
||||
|
||||
boolean SYSTEM\API\verify::LANG(mixed $param)
|
||||
|
||||
Verify LANG - verify supported languages
|
||||
|
||||
|
||||
|
||||
@ -219,15 +219,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### RESULT
|
||||
|
||||
mixed SYSTEM\API\verify::RESULT($param)
|
||||
|
||||
boolean SYSTEM\API\verify::RESULT(mixed $param)
|
||||
|
||||
Verify RESULT - verify possible resulttypes
|
||||
|
||||
|
||||
|
||||
@ -236,6 +236,23 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed**
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### EMAIL
|
||||
|
||||
boolean SYSTEM\API\verify::EMAIL(mixed $param)
|
||||
|
||||
Verify EMAIL - verify email
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CACHE\cache
|
||||
===============
|
||||
|
||||
|
||||
Cache Class provided by System for caching in the Database.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache::get($cache, $ident, $header)
|
||||
|
||||
mixed SYSTEM\CACHE\cache::get(integer $cache, \SYSTEM\CACHE\sha1 $ident, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
|
||||
|
||||
|
||||
@ -32,17 +32,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cache **mixed**
|
||||
* $ident **mixed**
|
||||
* $header **mixed**
|
||||
* $cache **integer** - <p>Cache Group to query</p>
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
|
||||
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache::put($cache, $ident, $type, $data, $fail_on_exist)
|
||||
|
||||
mixed SYSTEM\CACHE\cache::put(integer $cache, \SYSTEM\CACHE\sha1 $ident, string $type, string $data, boolean $fail_on_exist)
|
||||
|
||||
Put Data into the Cache
|
||||
|
||||
|
||||
|
||||
@ -51,19 +51,19 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cache **mixed**
|
||||
* $ident **mixed**
|
||||
* $type **mixed**
|
||||
* $data **mixed**
|
||||
* $fail_on_exist **mixed**
|
||||
* $cache **integer** - <p>Cache Group to put Data to</p>
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the Content</p>
|
||||
* $type **string** - <p>String representing the Header-Type which will be sent with the content eg. JS for javascript</p>
|
||||
* $data **string** - <p>Content to be cached</p>
|
||||
* $fail_on_exist **boolean** - <p>Fail on existing record</p>
|
||||
|
||||
|
||||
|
||||
### del
|
||||
|
||||
mixed SYSTEM\CACHE\cache::del($cache, $ident)
|
||||
|
||||
boolean SYSTEM\CACHE\cache::del(integer $cache, \SYSTEM\CACHE\sha1 $ident)
|
||||
|
||||
Delete Data from Cache
|
||||
|
||||
|
||||
|
||||
@ -72,7 +72,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cache **mixed**
|
||||
* $ident **mixed**
|
||||
* $cache **integer** - <p>Cache Group to delete Data from</p>
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the Content</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CACHE\cache_css
|
||||
===============
|
||||
|
||||
|
||||
CSS Cache Class provided by System for caching CSS in the Database.
|
||||
|
||||
|
||||
|
||||
@ -31,9 +31,9 @@ Methods
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache_css::put($ident, $data)
|
||||
|
||||
mixed SYSTEM\CACHE\cache_css::put(\SYSTEM\CACHE\sha1 $ident, integer $data)
|
||||
|
||||
Put Data into the Cache
|
||||
|
||||
|
||||
|
||||
@ -42,16 +42,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **mixed**
|
||||
* $data **mixed**
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $data **integer** - <p>Data to cache</p>
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache_css::get($ident, $header)
|
||||
|
||||
mixed SYSTEM\CACHE\cache_css::get(\SYSTEM\CACHE\sha1 $ident, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
|
||||
|
||||
|
||||
@ -60,16 +60,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **mixed**
|
||||
* $header **mixed**
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
|
||||
|
||||
|
||||
### ident
|
||||
|
||||
mixed SYSTEM\CACHE\cache_css::ident($files)
|
||||
|
||||
\SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_css::ident(array $files)
|
||||
|
||||
Calculate Ident for a list of Files
|
||||
|
||||
|
||||
|
||||
@ -78,15 +78,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $files **mixed**
|
||||
* $files **array** - <p>List of Files to be cached into one Cacheentry</p>
|
||||
|
||||
|
||||
|
||||
### url
|
||||
|
||||
mixed SYSTEM\CACHE\cache_css::url($files)
|
||||
### minify
|
||||
|
||||
\SYSTEM\CACHE\url SYSTEM\CACHE\cache_css::minify(array $files)
|
||||
|
||||
Minify CSS and calculate URL from it
|
||||
|
||||
|
||||
|
||||
@ -95,6 +95,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $files **mixed**
|
||||
* $files **array** - <p>List of Files to be cached into one Cacheentry</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CACHE\cache_filemask
|
||||
===============
|
||||
|
||||
|
||||
File Cache Class provided by System for hiding Filepaths on the Server.
|
||||
|
||||
|
||||
|
||||
@ -31,9 +31,10 @@ Methods
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache_filemask::put($file)
|
||||
|
||||
mixed SYSTEM\CACHE\cache_filemask::put(\SYSTEM\CACHE\sha1 $file)
|
||||
|
||||
Put Data into the Cache
|
||||
Remark: Saves only the path into the Cache, not the File itself
|
||||
|
||||
|
||||
|
||||
@ -42,15 +43,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **mixed**
|
||||
* $file **SYSTEM\CACHE\sha1** - <p>String Filepath of Content</p>
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache_filemask::get($ident, $header)
|
||||
|
||||
mixed SYSTEM\CACHE\cache_filemask::get(\SYSTEM\CACHE\sha1 $ident, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
|
||||
|
||||
|
||||
@ -59,16 +60,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **mixed**
|
||||
* $header **mixed**
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
|
||||
|
||||
|
||||
### ident
|
||||
|
||||
mixed SYSTEM\CACHE\cache_filemask::ident($file)
|
||||
|
||||
\SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_filemask::ident(array $file)
|
||||
|
||||
Calculate Ident for a File
|
||||
|
||||
|
||||
|
||||
@ -77,6 +78,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **mixed**
|
||||
* $file **array** - <p>Filepath to be cached</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CACHE\cache_js
|
||||
===============
|
||||
|
||||
|
||||
JS Cache Class provided by System for caching JS in the Database.
|
||||
|
||||
|
||||
|
||||
@ -31,9 +31,9 @@ Methods
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache_js::put($ident, $data)
|
||||
|
||||
mixed SYSTEM\CACHE\cache_js::put(\SYSTEM\CACHE\sha1 $ident, integer $data)
|
||||
|
||||
Put Data into the Cache
|
||||
|
||||
|
||||
|
||||
@ -42,16 +42,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **mixed**
|
||||
* $data **mixed**
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $data **integer** - <p>Data to cache</p>
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache_js::get($ident, $header)
|
||||
|
||||
mixed SYSTEM\CACHE\cache_js::get(\SYSTEM\CACHE\sha1 $ident, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
|
||||
|
||||
|
||||
@ -60,16 +60,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **mixed**
|
||||
* $header **mixed**
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
|
||||
|
||||
|
||||
### ident
|
||||
|
||||
mixed SYSTEM\CACHE\cache_js::ident($files)
|
||||
|
||||
\SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_js::ident(array $files)
|
||||
|
||||
Calculate Ident for a list of Files
|
||||
|
||||
|
||||
|
||||
@ -78,15 +78,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $files **mixed**
|
||||
* $files **array** - <p>List of Files to be cached into one Cacheentry</p>
|
||||
|
||||
|
||||
|
||||
### url
|
||||
|
||||
mixed SYSTEM\CACHE\cache_js::url($files)
|
||||
### minify
|
||||
|
||||
\SYSTEM\CACHE\url SYSTEM\CACHE\cache_js::minify(array $files)
|
||||
|
||||
Minify JS files and calculate URL for it
|
||||
|
||||
|
||||
|
||||
@ -95,6 +95,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $files **mixed**
|
||||
* $files **array** - <p>List of Files to be cached into one Cacheentry</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CACHE\cache_scss
|
||||
===============
|
||||
|
||||
|
||||
SCSS Cache Class provided by System for compiling and caching SCSS in the Database.
|
||||
|
||||
|
||||
|
||||
@ -31,9 +31,9 @@ Methods
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache_scss::put($file, $data)
|
||||
|
||||
mixed SYSTEM\CACHE\cache_scss::put(\SYSTEM\CACHE\sha1 $file, integer $data)
|
||||
|
||||
Put Data into the Cache
|
||||
|
||||
|
||||
|
||||
@ -42,16 +42,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **mixed**
|
||||
* $data **mixed**
|
||||
* $file **SYSTEM\CACHE\sha1** - <p>Filepath of the Content</p>
|
||||
* $data **integer** - <p>Data to cache</p>
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache_scss::get($file, $header)
|
||||
|
||||
mixed SYSTEM\CACHE\cache_scss::get(\SYSTEM\CACHE\sha1 $file, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
|
||||
|
||||
|
||||
@ -60,16 +60,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **mixed**
|
||||
* $header **mixed**
|
||||
* $file **SYSTEM\CACHE\sha1** - <p>Filepath for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
|
||||
|
||||
|
||||
### ident
|
||||
|
||||
mixed SYSTEM\CACHE\cache_scss::ident($file)
|
||||
|
||||
\SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_scss::ident(string $file)
|
||||
|
||||
Calculate Ident for a File
|
||||
|
||||
|
||||
|
||||
@ -78,15 +78,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **mixed**
|
||||
* $file **string** - <p>Filepath to be cached</p>
|
||||
|
||||
|
||||
|
||||
### url
|
||||
|
||||
mixed SYSTEM\CACHE\cache_scss::url($file)
|
||||
|
||||
\SYSTEM\CACHE\url SYSTEM\CACHE\cache_scss::url(array $file)
|
||||
|
||||
Calculate URL for a File
|
||||
|
||||
|
||||
|
||||
@ -95,6 +95,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **mixed**
|
||||
* $file **array** - <p>Filepath to be cached</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CONFIG\config
|
||||
===============
|
||||
|
||||
|
||||
Config Class provided by System for configuration of the System Environment.
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ Properties
|
||||
|
||||
private mixed $config
|
||||
|
||||
|
||||
array Holding all the Config Data
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CONFIG\config::get($config_id)
|
||||
|
||||
mixed SYSTEM\CONFIG\config::get(integer $config_id)
|
||||
|
||||
Get Config Setting
|
||||
|
||||
|
||||
|
||||
@ -46,15 +46,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $config_id **mixed**
|
||||
* $config_id **integer** - <p>Config ID to be retrieved</p>
|
||||
|
||||
|
||||
|
||||
### set
|
||||
|
||||
mixed SYSTEM\CONFIG\config::set($config_id, $value)
|
||||
|
||||
NULL SYSTEM\CONFIG\config::set(integer $config_id, mixed $value)
|
||||
|
||||
Set Config Setting
|
||||
|
||||
|
||||
|
||||
@ -63,16 +63,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $config_id **mixed**
|
||||
* $value **mixed**
|
||||
* $config_id **integer** - <p>Config ID to be written</p>
|
||||
* $value **mixed** - <p>Config Value to be written</p>
|
||||
|
||||
|
||||
|
||||
### setArray
|
||||
|
||||
mixed SYSTEM\CONFIG\config::setArray($id_value_array)
|
||||
|
||||
NULL SYSTEM\CONFIG\config::setArray(array $id_value_array)
|
||||
|
||||
Set Array of Config Settings
|
||||
|
||||
|
||||
|
||||
@ -81,6 +81,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id_value_array **mixed**
|
||||
* $id_value_array **array** - <p>Array containing Config IDs as Key and Value as Value to that Key. array( array(ID, VALUE), array(ID, VALUE))</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\CONFIG\config_ids
|
||||
===============
|
||||
|
||||
ConfigID Class provided by System for System Environment Config IDs.
|
||||
|
||||
|
||||
|
||||
Extend this class for your own purposes.
|
||||
|
||||
|
||||
* Class name: config_ids
|
||||
@ -159,6 +159,14 @@ Constants
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_PATH_CACHE
|
||||
|
||||
const SYS_CONFIG_PATH_CACHE = 31
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_SAI_CONFIG_PROJECT
|
||||
|
||||
const SYS_SAI_CONFIG_PROJECT = 54
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CRON\cron
|
||||
===============
|
||||
|
||||
|
||||
Cron Class provided by System for Tasks occurring repeateadly.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### check
|
||||
|
||||
mixed SYSTEM\CRON\cron::check($class)
|
||||
|
||||
boolean SYSTEM\CRON\cron::check(\SYSTEM\CRON\class $class)
|
||||
|
||||
Check if given Class is a compatible Cronjob
|
||||
|
||||
|
||||
|
||||
@ -32,15 +32,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **mixed**
|
||||
* $class **SYSTEM\CRON\class** - <p>Cronclass extending cronjob</p>
|
||||
|
||||
|
||||
|
||||
### run
|
||||
|
||||
mixed SYSTEM\CRON\cron::run()
|
||||
|
||||
\SYSTEM\CRON\JSON SYSTEM\CRON\cron::run()
|
||||
|
||||
Run all registered Cronjobs if its time to do so.
|
||||
|
||||
|
||||
|
||||
@ -50,11 +50,28 @@ Methods
|
||||
|
||||
|
||||
|
||||
### run_class
|
||||
|
||||
\SYSTEM\CRON\JSON SYSTEM\CRON\cron::run_class($class)
|
||||
|
||||
Run a specific registered Cronjob by classname if its time to do so.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **mixed**
|
||||
|
||||
|
||||
|
||||
### next
|
||||
|
||||
mixed SYSTEM\CRON\cron::next($class)
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\cron::next(\SYSTEM\CRON\class $class)
|
||||
|
||||
Determine next run of a given Cronjob
|
||||
|
||||
|
||||
|
||||
@ -63,15 +80,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **mixed**
|
||||
* $class **SYSTEM\CRON\class** - <p>Cronjob class</p>
|
||||
|
||||
|
||||
|
||||
### last
|
||||
|
||||
mixed SYSTEM\CRON\cron::last($class)
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\cron::last(\SYSTEM\CRON\class $class)
|
||||
|
||||
Determine last run of a given Cronjob
|
||||
|
||||
|
||||
|
||||
@ -80,15 +97,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **mixed**
|
||||
* $class **SYSTEM\CRON\class** - <p>Cronjob class</p>
|
||||
|
||||
|
||||
|
||||
### status
|
||||
|
||||
mixed SYSTEM\CRON\cron::status($class, $status)
|
||||
|
||||
boolean SYSTEM\CRON\cron::status(\SYSTEM\CRON\class $class, integer $status)
|
||||
|
||||
Updates the Status of a Cronjob
|
||||
|
||||
|
||||
|
||||
@ -97,16 +114,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **mixed**
|
||||
* $status **mixed**
|
||||
* $class **SYSTEM\CRON\class** - <p>Cronjob class</p>
|
||||
* $status **integer** - <p>Status to be written</p>
|
||||
|
||||
|
||||
|
||||
### last_visit
|
||||
|
||||
mixed SYSTEM\CRON\cron::last_visit()
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\cron::last_visit()
|
||||
|
||||
Determines the time when the System-Cronjobs were executed the last time.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,15 +1,14 @@
|
||||
SYSTEM\CRON\cron_cache_delete
|
||||
===============
|
||||
|
||||
|
||||
Conjob Class provided by System to delete System Cache.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cron_cache_delete
|
||||
* Namespace: SYSTEM\CRON
|
||||
* Parent class: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
|
||||
* This class implements: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
|
||||
|
||||
|
||||
@ -22,9 +21,9 @@ Methods
|
||||
|
||||
### run
|
||||
|
||||
mixed SYSTEM\CRON\cronjob::run()
|
||||
|
||||
integer SYSTEM\CRON\cronjob::run()
|
||||
|
||||
Run the Cronjob and execute its task
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,15 +1,14 @@
|
||||
SYSTEM\CRON\cron_log2sqlite
|
||||
===============
|
||||
|
||||
|
||||
Conjob Class provided by System to extract Logentries into sqlite files.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cron_log2sqlite
|
||||
* Namespace: SYSTEM\CRON
|
||||
* Parent class: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
|
||||
* This class implements: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
|
||||
|
||||
|
||||
@ -22,9 +21,9 @@ Methods
|
||||
|
||||
### run
|
||||
|
||||
mixed SYSTEM\CRON\cronjob::run()
|
||||
|
||||
integer SYSTEM\CRON\cronjob::run()
|
||||
|
||||
Run the Cronjob and execute its task
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
SYSTEM\CRON\cronjob
|
||||
===============
|
||||
|
||||
Conjob Class provided by System to derive from for custom Cronjobs.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cronjob
|
||||
* Interface name: cronjob
|
||||
* Namespace: SYSTEM\CRON
|
||||
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### run
|
||||
|
||||
mixed SYSTEM\CRON\cronjob::run()
|
||||
|
||||
integer SYSTEM\CRON\cronjob::run()
|
||||
|
||||
Run the Cronjob and execute its task
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CRON\cronstatus
|
||||
===============
|
||||
|
||||
|
||||
Cronstatus Class provided by System for Cronjob stati.
|
||||
|
||||
|
||||
|
||||
@ -63,9 +63,9 @@ Methods
|
||||
|
||||
### text
|
||||
|
||||
mixed SYSTEM\CRON\cronstatus::text($status)
|
||||
|
||||
string SYSTEM\CRON\cronstatus::text(integer $status)
|
||||
|
||||
Convert Cron Status to a text value.
|
||||
|
||||
|
||||
|
||||
@ -74,6 +74,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $status **mixed**
|
||||
* $status **integer** - <p>Value from this Class</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\CRON\crontime
|
||||
===============
|
||||
|
||||
|
||||
Crontime Class provided by System for Cronjob time calculation.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### next
|
||||
|
||||
mixed SYSTEM\CRON\crontime::next($base_time, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\crontime::next(\SYSTEM\CRON\time $base_time, integer $min, integer $hour, integer $day, integer $day_week, integer $month)
|
||||
|
||||
Determine next time based on a basetime and crontab-style modificators
|
||||
|
||||
|
||||
|
||||
@ -32,20 +32,20 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $base_time **mixed**
|
||||
* $min **mixed**
|
||||
* $hour **mixed**
|
||||
* $day **mixed**
|
||||
* $day_week **mixed**
|
||||
* $month **mixed**
|
||||
* $base_time **SYSTEM\CRON\time** - <p>Time which the calculation should be based upon</p>
|
||||
* $min **integer** - <p>Minutes-Modificator for next run</p>
|
||||
* $hour **integer** - <p>Hour-Modificator for next run</p>
|
||||
* $day **integer** - <p>Day-Modificator for next run</p>
|
||||
* $day_week **integer** - <p>Day-Of-The-Week-Modificator for next run</p>
|
||||
* $month **integer** - <p>Month-Modificator for next run</p>
|
||||
|
||||
|
||||
|
||||
### last
|
||||
|
||||
mixed SYSTEM\CRON\crontime::last($base_time, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\crontime::last(\SYSTEM\CRON\time $base_time, integer $min, integer $hour, integer $day, integer $day_week, integer $month)
|
||||
|
||||
Determine last time based on a basetime and crontab-style modificators
|
||||
|
||||
|
||||
|
||||
@ -54,20 +54,21 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $base_time **mixed**
|
||||
* $min **mixed**
|
||||
* $hour **mixed**
|
||||
* $day **mixed**
|
||||
* $day_week **mixed**
|
||||
* $month **mixed**
|
||||
* $base_time **SYSTEM\CRON\time** - <p>Time which the calculation should be based upon</p>
|
||||
* $min **integer** - <p>Minutes-Modificator for last run</p>
|
||||
* $hour **integer** - <p>Hour-Modificator for last run</p>
|
||||
* $day **integer** - <p>Day-Modificator for last run</p>
|
||||
* $day_week **integer** - <p>Day-Of-The-Week-Modificator for last run</p>
|
||||
* $month **integer** - <p>Month-Modificator for last run</p>
|
||||
|
||||
|
||||
|
||||
### check
|
||||
|
||||
mixed SYSTEM\CRON\crontime::check($base_time, $last_run, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
boolean SYSTEM\CRON\crontime::check(\SYSTEM\CRON\time $base_time, \SYSTEM\CRON\time $last_run, integer $min, integer $hour, integer $day, integer $day_week, integer $month)
|
||||
|
||||
Determine if time for next run lies in the past based on a lastrun,
|
||||
a basetime and crontab-style modificators
|
||||
|
||||
|
||||
|
||||
@ -76,63 +77,22 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $base_time **mixed**
|
||||
* $last_run **mixed**
|
||||
* $min **mixed**
|
||||
* $hour **mixed**
|
||||
* $day **mixed**
|
||||
* $day_week **mixed**
|
||||
* $month **mixed**
|
||||
|
||||
|
||||
|
||||
### next_now
|
||||
|
||||
mixed SYSTEM\CRON\crontime::next_now($min, $hour, $day, $day_week, $month)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $min **mixed**
|
||||
* $hour **mixed**
|
||||
* $day **mixed**
|
||||
* $day_week **mixed**
|
||||
* $month **mixed**
|
||||
|
||||
|
||||
|
||||
### last_now
|
||||
|
||||
mixed SYSTEM\CRON\crontime::last_now($min, $hour, $day, $day_week, $month)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $min **mixed**
|
||||
* $hour **mixed**
|
||||
* $day **mixed**
|
||||
* $day_week **mixed**
|
||||
* $month **mixed**
|
||||
* $base_time **SYSTEM\CRON\time** - <p>Time upon which is checked if the calculated time is in the past</p>
|
||||
* $last_run **SYSTEM\CRON\time** - <p>Time which the calculation should be based upon</p>
|
||||
* $min **integer** - <p>Minutes-Modificator for next run</p>
|
||||
* $hour **integer** - <p>Hour-Modificator for next run</p>
|
||||
* $day **integer** - <p>Day-Modificator for next run</p>
|
||||
* $day_week **integer** - <p>Day-Of-The-Week-Modificator for next run</p>
|
||||
* $month **integer** - <p>Month-Modificator for next run</p>
|
||||
|
||||
|
||||
|
||||
### check_now
|
||||
|
||||
mixed SYSTEM\CRON\crontime::check_now($last_run, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
boolean SYSTEM\CRON\crontime::check_now(\SYSTEM\CRON\time $last_run, integer $min, integer $hour, integer $day, integer $day_week, integer $month)
|
||||
|
||||
Determine if time for next run lies in the past based on a lastrun and
|
||||
crontab-style modificators using system-time as compare-time.
|
||||
|
||||
|
||||
|
||||
@ -141,11 +101,53 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $last_run **mixed**
|
||||
* $min **mixed**
|
||||
* $hour **mixed**
|
||||
* $day **mixed**
|
||||
* $day_week **mixed**
|
||||
* $month **mixed**
|
||||
* $last_run **SYSTEM\CRON\time** - <p>Time which the calculation should be based upon</p>
|
||||
* $min **integer** - <p>Minutes-Modificator for next run</p>
|
||||
* $hour **integer** - <p>Hour-Modificator for next run</p>
|
||||
* $day **integer** - <p>Day-Modificator for next run</p>
|
||||
* $day_week **integer** - <p>Day-Of-The-Week-Modificator for next run</p>
|
||||
* $month **integer** - <p>Month-Modificator for next run</p>
|
||||
|
||||
|
||||
|
||||
### next_now
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\crontime::next_now(integer $min, integer $hour, integer $day, integer $day_week, integer $month)
|
||||
|
||||
Determine next time based on the system-time and crontab-style modificators
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $min **integer** - <p>Minutes-Modificator for next run</p>
|
||||
* $hour **integer** - <p>Hour-Modificator for next run</p>
|
||||
* $day **integer** - <p>Day-Modificator for next run</p>
|
||||
* $day_week **integer** - <p>Day-Of-The-Week-Modificator for next run</p>
|
||||
* $month **integer** - <p>Month-Modificator for next run</p>
|
||||
|
||||
|
||||
|
||||
### last_now
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\crontime::last_now(integer $min, integer $hour, integer $day, integer $day_week, integer $month)
|
||||
|
||||
Determine last time based on system-time and crontab-style modificators
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $min **integer** - <p>Minutes-Modificator for last run</p>
|
||||
* $hour **integer** - <p>Hour-Modificator for last run</p>
|
||||
* $day **integer** - <p>Day-Modificator for last run</p>
|
||||
* $day_week **integer** - <p>Day-Of-The-Week-Modificator for last run</p>
|
||||
* $month **integer** - <p>Month-Modificator for last run</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\Connection
|
||||
===============
|
||||
|
||||
|
||||
Connection Class provided by System to open a Connection to a Database.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
|
||||
ressource Variable to store then open Connection
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
|
||||
|
||||
|
||||
@ -55,9 +55,24 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Destruct the Database Connection upon Destruction.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
@ -68,9 +83,9 @@ Methods
|
||||
|
||||
### prepare
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
@ -80,32 +95,18 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $stmtName **mixed**
|
||||
* $stmt **mixed**
|
||||
* $values **mixed**
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p>
|
||||
* $stmt **string** - <p>SQL string of the Statement</p>
|
||||
* $values **array** - <p>Array of Prepare Values</p>
|
||||
* $types **string** - <p>types sql prepare string</p>
|
||||
|
||||
|
||||
|
||||
### query
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
@ -115,31 +116,33 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **mixed**
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### exec
|
||||
|
||||
mixed SYSTEM\DB\Connection::exec($query)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query)
|
||||
|
||||
Exec Query on Database
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **mixed**
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### trans
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -152,9 +155,9 @@ Methods
|
||||
|
||||
### commit
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -167,9 +170,9 @@ Methods
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
@ -179,6 +182,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **mixed**
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ConnectionAMQP
|
||||
===============
|
||||
|
||||
|
||||
AMQP Connection Class provided by System to connect to AMQP Services.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
|
||||
ressource Variable to store then open Connection
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -47,15 +47,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
|
||||
|
||||
|
||||
### send
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAMQP::send($msg)
|
||||
|
||||
null SYSTEM\DB\ConnectionAMQP::send(array $msg)
|
||||
|
||||
Send a Message to the AMQP Server
|
||||
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $msg **mixed**
|
||||
* $msg **array** - <p>Query Object</p>
|
||||
|
||||
|
||||
|
||||
@ -71,7 +71,7 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
|
||||
Destruct the Database Connection upon Destruction.
|
||||
|
||||
|
||||
|
||||
@ -84,9 +84,9 @@ Methods
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
@ -99,9 +99,9 @@ Methods
|
||||
|
||||
### query
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
@ -111,15 +111,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **mixed**
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### prepare
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
@ -129,17 +129,18 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $stmtName **mixed**
|
||||
* $stmt **mixed**
|
||||
* $values **mixed**
|
||||
* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p>
|
||||
* $stmt **string** - <p>SQL string of the Statement</p>
|
||||
* $values **array** - <p>Array of Prepare Values</p>
|
||||
* $types **string** - <p>types sql prepare string</p>
|
||||
|
||||
|
||||
|
||||
### commit
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -150,11 +151,29 @@ Methods
|
||||
|
||||
|
||||
|
||||
### exec
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query)
|
||||
|
||||
Exec Query on Database
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### trans
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -167,9 +186,9 @@ Methods
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
@ -179,6 +198,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **mixed**
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ConnectionAbstr
|
||||
===============
|
||||
|
||||
|
||||
Abstract Connection Class provided by System as a PDO Controller.
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
|
||||
|
||||
|
||||
@ -41,7 +41,7 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
|
||||
Destruct the Database Connection upon Destruction.
|
||||
|
||||
|
||||
|
||||
@ -53,9 +53,9 @@ Methods
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
@ -67,9 +67,9 @@ Methods
|
||||
|
||||
### prepare
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
@ -78,17 +78,18 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $stmtName **mixed**
|
||||
* $stmt **mixed**
|
||||
* $values **mixed**
|
||||
* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p>
|
||||
* $stmt **string** - <p>SQL string of the Statement</p>
|
||||
* $values **array** - <p>Array of Prepare Values</p>
|
||||
* $types **string** - <p>types sql prepare string</p>
|
||||
|
||||
|
||||
|
||||
### query
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
@ -97,16 +98,33 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **mixed**
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### commit
|
||||
### exec
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query)
|
||||
|
||||
Exec Query on Database
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### trans
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
@ -115,11 +133,11 @@ Methods
|
||||
|
||||
|
||||
|
||||
### trans
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
### commit
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -131,9 +149,9 @@ Methods
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
@ -142,6 +160,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **mixed**
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ConnectionMYS
|
||||
===============
|
||||
|
||||
|
||||
MYSQL Connection Class provided by System to connect to MYSQL Database.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
|
||||
ressource Variable to store then open Connection
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
|
||||
|
||||
|
||||
@ -55,9 +55,24 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Destruct the Database Connection upon Destruction.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
@ -68,9 +83,9 @@ Methods
|
||||
|
||||
### prepare
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
@ -80,32 +95,18 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $stmtName **mixed**
|
||||
* $stmt **mixed**
|
||||
* $values **mixed**
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p>
|
||||
* $stmt **string** - <p>SQL string of the Statement</p>
|
||||
* $values **array** - <p>Array of Prepare Values</p>
|
||||
* $types **string** - <p>types sql prepare string</p>
|
||||
|
||||
|
||||
|
||||
### query
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
@ -115,15 +116,33 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **mixed**
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### exec
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query)
|
||||
|
||||
Exec Query on Database
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### commit
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -136,9 +155,9 @@ Methods
|
||||
|
||||
### trans
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -151,9 +170,9 @@ Methods
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
@ -163,6 +182,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **mixed**
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ConnectionPG
|
||||
===============
|
||||
|
||||
|
||||
PostgreSQL Connection Class provided by System to connect to PostgreSQL Database.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
|
||||
ressource Variable to store then open Connection
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
|
||||
|
||||
|
||||
@ -55,9 +55,24 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Destruct the Database Connection upon Destruction.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
@ -68,9 +83,9 @@ Methods
|
||||
|
||||
### prepare
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
@ -80,32 +95,18 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $stmtName **mixed**
|
||||
* $stmt **mixed**
|
||||
* $values **mixed**
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p>
|
||||
* $stmt **string** - <p>SQL string of the Statement</p>
|
||||
* $values **array** - <p>Array of Prepare Values</p>
|
||||
* $types **string** - <p>types sql prepare string</p>
|
||||
|
||||
|
||||
|
||||
### query
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
@ -115,15 +116,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **mixed**
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### trans
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -136,9 +137,9 @@ Methods
|
||||
|
||||
### commit
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -149,11 +150,29 @@ Methods
|
||||
|
||||
|
||||
|
||||
### exec
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query)
|
||||
|
||||
Exec Query on Database
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
@ -163,6 +182,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **mixed**
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ConnectionSQLite
|
||||
===============
|
||||
|
||||
|
||||
SQLite Connection Class provided by System to connect to SQLite Databasefile.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
|
||||
ressource Variable to store the open Connection
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
|
||||
|
||||
|
||||
@ -55,9 +55,24 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Destruct the Database Connection upon Destruction.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
@ -68,9 +83,9 @@ Methods
|
||||
|
||||
### prepare
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
@ -80,32 +95,18 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $stmtName **mixed**
|
||||
* $stmt **mixed**
|
||||
* $values **mixed**
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p>
|
||||
* $stmt **string** - <p>SQL string of the Statement</p>
|
||||
* $values **array** - <p>Array of Prepare Values</p>
|
||||
* $types **string** - <p>types sql prepare string</p>
|
||||
|
||||
|
||||
|
||||
### query
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
@ -115,31 +116,33 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **mixed**
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### exec
|
||||
|
||||
mixed SYSTEM\DB\ConnectionSQLite::exec($query)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query)
|
||||
|
||||
Exec Query on Database
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $query **mixed**
|
||||
* $query **string** - <p>SQL string of the Statement</p>
|
||||
|
||||
|
||||
|
||||
### commit
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -152,9 +155,9 @@ Methods
|
||||
|
||||
### trans
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
@ -167,9 +170,9 @@ Methods
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
@ -179,6 +182,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **mixed**
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\DBInfo
|
||||
===============
|
||||
|
||||
|
||||
DBInfo Abstract Class provided by System to hold Database Information.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
|
||||
string Variable to store Database name
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
|
||||
string Variable to store Database user
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
|
||||
string Variable to store Database password
|
||||
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ Properties
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
|
||||
string Variable to store Database host
|
||||
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ Properties
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
|
||||
int Variable to store Database port
|
||||
|
||||
|
||||
|
||||
@ -79,9 +79,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -90,10 +90,10 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $database **mixed**
|
||||
* $user **mixed**
|
||||
* $password **mixed**
|
||||
* $host **mixed**
|
||||
* $port **mixed**
|
||||
* $database **string** - <p>Database name</p>
|
||||
* $user **string** - <p>Database user</p>
|
||||
* $password **string** - <p>Database password</p>
|
||||
* $host **string** - <p>Database host</p>
|
||||
* $port **integer** - <p>Database port</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\DBInfoAMQP
|
||||
===============
|
||||
|
||||
|
||||
DBInfoAMQP Class provided by System to hold AMQP Database Information.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
|
||||
string Variable to store Database name
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
|
||||
string Variable to store Database user
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
|
||||
string Variable to store Database password
|
||||
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ Properties
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
|
||||
string Variable to store Database host
|
||||
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ Properties
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
|
||||
int Variable to store Database port
|
||||
|
||||
|
||||
|
||||
@ -79,9 +79,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -91,10 +91,10 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $database **mixed**
|
||||
* $user **mixed**
|
||||
* $password **mixed**
|
||||
* $host **mixed**
|
||||
* $port **mixed**
|
||||
* $database **string** - <p>Database name</p>
|
||||
* $user **string** - <p>Database user</p>
|
||||
* $password **string** - <p>Database password</p>
|
||||
* $host **string** - <p>Database host</p>
|
||||
* $port **integer** - <p>Database port</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\DBInfoMYS
|
||||
===============
|
||||
|
||||
|
||||
DBInfoMYS Class provided by System to hold MYSQL Database Information.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
|
||||
string Variable to store Database name
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
|
||||
string Variable to store Database user
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
|
||||
string Variable to store Database password
|
||||
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ Properties
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
|
||||
string Variable to store Database host
|
||||
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ Properties
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
|
||||
int Variable to store Database port
|
||||
|
||||
|
||||
|
||||
@ -79,9 +79,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -91,10 +91,10 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $database **mixed**
|
||||
* $user **mixed**
|
||||
* $password **mixed**
|
||||
* $host **mixed**
|
||||
* $port **mixed**
|
||||
* $database **string** - <p>Database name</p>
|
||||
* $user **string** - <p>Database user</p>
|
||||
* $password **string** - <p>Database password</p>
|
||||
* $host **string** - <p>Database host</p>
|
||||
* $port **integer** - <p>Database port</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\DBInfoPG
|
||||
===============
|
||||
|
||||
|
||||
DBInfoPG Class provided by System to hold PostgreSQL Database Information.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
|
||||
string Variable to store Database name
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
|
||||
string Variable to store Database user
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
|
||||
string Variable to store Database password
|
||||
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ Properties
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
|
||||
string Variable to store Database host
|
||||
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ Properties
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
|
||||
int Variable to store Database port
|
||||
|
||||
|
||||
|
||||
@ -79,9 +79,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -91,10 +91,10 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $database **mixed**
|
||||
* $user **mixed**
|
||||
* $password **mixed**
|
||||
* $host **mixed**
|
||||
* $port **mixed**
|
||||
* $database **string** - <p>Database name</p>
|
||||
* $user **string** - <p>Database user</p>
|
||||
* $password **string** - <p>Database password</p>
|
||||
* $host **string** - <p>Database host</p>
|
||||
* $port **integer** - <p>Database port</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\DBInfoSQLite
|
||||
===============
|
||||
|
||||
|
||||
DBInfoSQLite Class provided by System to hold SQLite File-Database Information.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
|
||||
string Variable to store Database name
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
|
||||
string Variable to store Database user
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
|
||||
string Variable to store Database password
|
||||
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ Properties
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
|
||||
string Variable to store Database host
|
||||
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ Properties
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
|
||||
int Variable to store Database port
|
||||
|
||||
|
||||
|
||||
@ -79,9 +79,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
|
||||
|
||||
|
||||
@ -91,10 +91,10 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $database **mixed**
|
||||
* $user **mixed**
|
||||
* $password **mixed**
|
||||
* $host **mixed**
|
||||
* $port **mixed**
|
||||
* $database **string** - <p>Database name</p>
|
||||
* $user **string** - <p>Database user</p>
|
||||
* $password **string** - <p>Database password</p>
|
||||
* $host **string** - <p>Database host</p>
|
||||
* $port **integer** - <p>Database port</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\QI
|
||||
===============
|
||||
|
||||
|
||||
QI Class provided by System to execute quick installation statements.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,10 @@ Methods
|
||||
|
||||
### QI
|
||||
|
||||
mixed SYSTEM\DB\QI::QI($dbinfo)
|
||||
|
||||
array SYSTEM\DB\QI::QI(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action by calling either files_pgsql() or files_mysql()
|
||||
of inherting class
|
||||
|
||||
|
||||
|
||||
@ -32,6 +33,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **mixed**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\QP
|
||||
===============
|
||||
|
||||
|
||||
QQ Class provided by System to execute quick prepare statements.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### QQ
|
||||
|
||||
mixed SYSTEM\DB\QP::QQ($params, $dbinfo)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\QP::QQ(array $params, \SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return Database Object
|
||||
|
||||
|
||||
|
||||
@ -32,16 +32,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $dbinfo **mixed**
|
||||
* $params **array** - <p>Parameter passed to the prepare-query</p>
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
### QA
|
||||
|
||||
mixed SYSTEM\DB\QP::QA($params, $dbinfo)
|
||||
|
||||
array SYSTEM\DB\QP::QA(array $params, \SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return all Data found
|
||||
|
||||
|
||||
|
||||
@ -50,16 +50,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $dbinfo **mixed**
|
||||
* $params **array** - <p>Parameter passed to the prepare-query</p>
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
### Q1
|
||||
|
||||
mixed SYSTEM\DB\QP::Q1($params, $dbinfo)
|
||||
|
||||
array SYSTEM\DB\QP::Q1(array $params, \SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return one line of Data found
|
||||
|
||||
|
||||
|
||||
@ -68,25 +68,25 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $dbinfo **mixed**
|
||||
* $params **array** - <p>Parameter passed to the prepare-query</p>
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
### QI
|
||||
|
||||
mixed SYSTEM\DB\QP::QI($params, $dbinfo)
|
||||
|
||||
|
||||
boolean SYSTEM\DB\QP::QI(array $params, \SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return Database Result Object.
|
||||
|
||||
Use this function if the Result is either true or false (update/delete/insert)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $dbinfo **mixed**
|
||||
* $params **array** - <p>Parameter passed to the prepare-query</p>
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\QQ
|
||||
===============
|
||||
|
||||
|
||||
QQ Class provided by System to execute quick query statements.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### QQ
|
||||
|
||||
mixed SYSTEM\DB\QQ::QQ($dbinfo)
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\QQ::QQ(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return Database Object
|
||||
|
||||
|
||||
|
||||
@ -32,15 +32,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **mixed**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
### QA
|
||||
|
||||
mixed SYSTEM\DB\QQ::QA($dbinfo)
|
||||
|
||||
array SYSTEM\DB\QQ::QA(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return all Data found
|
||||
|
||||
|
||||
|
||||
@ -49,15 +49,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **mixed**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
### Q1
|
||||
|
||||
mixed SYSTEM\DB\QQ::Q1($dbinfo)
|
||||
|
||||
array SYSTEM\DB\QQ::Q1(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return one line of Data found
|
||||
|
||||
|
||||
|
||||
@ -66,23 +66,23 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **mixed**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
### QI
|
||||
|
||||
mixed SYSTEM\DB\QQ::QI($dbinfo)
|
||||
|
||||
|
||||
boolean SYSTEM\DB\QQ::QI(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return Database Result Object.
|
||||
|
||||
Use this function if the Result is either true or false (update/delete/insert)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **mixed**
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\Result
|
||||
===============
|
||||
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources.
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### count
|
||||
|
||||
mixed SYSTEM\DB\Result::count()
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### affectedRows
|
||||
|
||||
mixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -50,9 +50,9 @@ Methods
|
||||
|
||||
### next
|
||||
|
||||
mixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -61,15 +61,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **mixed**
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
mixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
@ -78,15 +78,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **mixed**
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\Result::close()
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ResultAMQP
|
||||
===============
|
||||
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of AMQP Querys.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $current = NULL
|
||||
|
||||
|
||||
ressource Variable to store current Line either as array or object
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultAMQP::__construct($res)
|
||||
|
||||
mixed SYSTEM\DB\ResultAMQP::__construct(\SYSTEM\DB\ressource $res)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $res **mixed**
|
||||
* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p>
|
||||
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ResultAMQP::__destruct()
|
||||
|
||||
|
||||
Close Resultset upon destruction
|
||||
|
||||
|
||||
|
||||
@ -75,9 +75,9 @@ Methods
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\Result::close()
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
|
||||
|
||||
|
||||
@ -90,9 +90,9 @@ Methods
|
||||
|
||||
### count
|
||||
|
||||
mixed SYSTEM\DB\Result::count()
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -105,9 +105,9 @@ Methods
|
||||
|
||||
### affectedRows
|
||||
|
||||
mixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -120,9 +120,9 @@ Methods
|
||||
|
||||
### next
|
||||
|
||||
mixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -132,15 +132,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **mixed**
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
mixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
@ -150,6 +150,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **mixed**
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ResultMysqli
|
||||
===============
|
||||
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of MYSQL Querys.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $current = NULL
|
||||
|
||||
|
||||
ressource Variable to store current Line either as array or object
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqli::__construct($res)
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqli::__construct(\SYSTEM\DB\ressource $res)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $res **mixed**
|
||||
* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p>
|
||||
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqli::__destruct()
|
||||
|
||||
|
||||
Close Resultset upon destruction
|
||||
|
||||
|
||||
|
||||
@ -75,9 +75,9 @@ Methods
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\Result::close()
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
|
||||
|
||||
|
||||
@ -90,9 +90,9 @@ Methods
|
||||
|
||||
### count
|
||||
|
||||
mixed SYSTEM\DB\Result::count()
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -105,9 +105,9 @@ Methods
|
||||
|
||||
### affectedRows
|
||||
|
||||
mixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -120,9 +120,9 @@ Methods
|
||||
|
||||
### next
|
||||
|
||||
mixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -132,15 +132,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **mixed**
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
mixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
@ -150,6 +150,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **mixed**
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ResultMysqliPrepare
|
||||
===============
|
||||
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of MYSQL prepare Querys.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $meta = NULL
|
||||
|
||||
|
||||
ressource Variable to store Metadata of Colums
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
private mixed $binds = array()
|
||||
|
||||
|
||||
ressource Variable to store Binding Variables
|
||||
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ Properties
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
|
||||
ressource Variable to store Database Connection
|
||||
|
||||
|
||||
|
||||
@ -68,9 +68,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqliPrepare::__construct($res, $connection)
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqliPrepare::__construct(\SYSTEM\DB\ressource $res, \SYSTEM\DB\ressource $connection)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
|
||||
|
||||
|
||||
@ -78,8 +78,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $res **mixed**
|
||||
* $connection **mixed**
|
||||
* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p>
|
||||
* $connection **SYSTEM\DB\ressource** - <p>Connection on which the Result-Set was returned</p>
|
||||
|
||||
|
||||
|
||||
@ -87,7 +87,7 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqliPrepare::__destruct()
|
||||
|
||||
|
||||
Close Resultset upon destruction
|
||||
|
||||
|
||||
|
||||
@ -98,9 +98,9 @@ Methods
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\Result::close()
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
|
||||
|
||||
|
||||
@ -113,9 +113,9 @@ Methods
|
||||
|
||||
### count
|
||||
|
||||
mixed SYSTEM\DB\Result::count()
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -128,9 +128,9 @@ Methods
|
||||
|
||||
### affectedRows
|
||||
|
||||
mixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -143,9 +143,9 @@ Methods
|
||||
|
||||
### next
|
||||
|
||||
mixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -155,15 +155,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **mixed**
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
mixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
@ -173,6 +173,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **mixed**
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ResultPostgres
|
||||
===============
|
||||
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of PostgreSQL Querys.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $current = NULL
|
||||
|
||||
|
||||
ressource Variable to store current Line either as array or object
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
|
||||
ressource Variable to store Database Connection
|
||||
|
||||
|
||||
|
||||
@ -57,9 +57,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultPostgres::__construct($res, $connection)
|
||||
|
||||
mixed SYSTEM\DB\ResultPostgres::__construct(\SYSTEM\DB\ressource $res, \SYSTEM\DB\ressource $connection)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
|
||||
|
||||
|
||||
@ -67,8 +67,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $res **mixed**
|
||||
* $connection **mixed**
|
||||
* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p>
|
||||
* $connection **SYSTEM\DB\ressource** - <p>Connection on which the Result-Set was returned</p>
|
||||
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ResultPostgres::__destruct()
|
||||
|
||||
|
||||
Close Resultset upon destruction
|
||||
|
||||
|
||||
|
||||
@ -87,9 +87,9 @@ Methods
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\Result::close()
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
|
||||
|
||||
|
||||
@ -102,9 +102,9 @@ Methods
|
||||
|
||||
### count
|
||||
|
||||
mixed SYSTEM\DB\Result::count()
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -117,9 +117,9 @@ Methods
|
||||
|
||||
### affectedRows
|
||||
|
||||
mixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -132,9 +132,9 @@ Methods
|
||||
|
||||
### next
|
||||
|
||||
mixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -144,15 +144,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **mixed**
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
mixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
@ -162,6 +162,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **mixed**
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DB\ResultSQLite
|
||||
===============
|
||||
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of SQLite File Querys.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $stmt = NULL
|
||||
|
||||
|
||||
ressource Variable to store query statement
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
private mixed $current = NULL
|
||||
|
||||
|
||||
ressource Variable to store current Line either as array or object
|
||||
|
||||
|
||||
|
||||
@ -57,9 +57,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultSQLite::__construct($res, $stmt)
|
||||
|
||||
mixed SYSTEM\DB\ResultSQLite::__construct(\SYSTEM\DB\ressource $res, string $stmt)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
|
||||
|
||||
|
||||
@ -67,8 +67,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $res **mixed**
|
||||
* $stmt **mixed**
|
||||
* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p>
|
||||
* $stmt **string** - <p>Query Statement which produced the result set</p>
|
||||
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@ Methods
|
||||
|
||||
mixed SYSTEM\DB\ResultSQLite::__destruct()
|
||||
|
||||
|
||||
Close Resultset upon destruction
|
||||
|
||||
|
||||
|
||||
@ -87,9 +87,9 @@ Methods
|
||||
|
||||
### close
|
||||
|
||||
mixed SYSTEM\DB\Result::close()
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
|
||||
|
||||
|
||||
@ -102,9 +102,9 @@ Methods
|
||||
|
||||
### count
|
||||
|
||||
mixed SYSTEM\DB\Result::count()
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -117,9 +117,9 @@ Methods
|
||||
|
||||
### affectedRows
|
||||
|
||||
mixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -132,9 +132,9 @@ Methods
|
||||
|
||||
### next
|
||||
|
||||
mixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
@ -144,15 +144,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **mixed**
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
mixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
@ -162,6 +162,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **mixed**
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\DOCU\docu
|
||||
===============
|
||||
|
||||
|
||||
Docu Class provided by System to register docu_packages.
|
||||
|
||||
|
||||
|
||||
@ -17,11 +17,11 @@ Properties
|
||||
----------
|
||||
|
||||
|
||||
### $phpdocconfigs
|
||||
|
||||
private mixed $phpdocconfigs = array()
|
||||
### $docu_packages
|
||||
|
||||
private mixed $docu_packages = array()
|
||||
|
||||
array Variable to store all registred docu_package classes
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### register
|
||||
|
||||
mixed SYSTEM\DOCU\docu::register($phpdocconfig)
|
||||
|
||||
null SYSTEM\DOCU\docu::register(string $docu_package)
|
||||
|
||||
Register a docu package
|
||||
|
||||
|
||||
|
||||
@ -46,15 +46,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $phpdocconfig **mixed**
|
||||
* $docu_package **string** - <p>Classname of Docu Package to be registered</p>
|
||||
|
||||
|
||||
|
||||
### getAll
|
||||
|
||||
mixed SYSTEM\DOCU\docu::getAll()
|
||||
|
||||
array SYSTEM\DOCU\docu::getAll()
|
||||
|
||||
Get all registered docu packages
|
||||
|
||||
|
||||
|
||||
@ -66,9 +66,9 @@ Methods
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\DOCU\docu::get($id)
|
||||
|
||||
array SYSTEM\DOCU\docu::get(string $id)
|
||||
|
||||
Get a specific docu package by classname
|
||||
|
||||
|
||||
|
||||
@ -77,6 +77,40 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $id **string** - <p>Class name of the package to be found</p>
|
||||
|
||||
|
||||
|
||||
### generate
|
||||
|
||||
array SYSTEM\DOCU\docu::generate(string $id)
|
||||
|
||||
Generate HTML Docu by docu classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **string** - <p>Classname of Docu Package to generated</p>
|
||||
|
||||
|
||||
|
||||
### generate_md
|
||||
|
||||
array SYSTEM\DOCU\docu::generate_md(string $id)
|
||||
|
||||
Generate Markdown Docu by docu classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **string** - <p>Classname of Docu Package to generated</p>
|
||||
|
||||
|
||||
|
||||
34
SYSTEM-DOCU-docu_package.md
Normal file
34
SYSTEM-DOCU-docu_package.md
Normal file
@ -0,0 +1,34 @@
|
||||
SYSTEM\DOCU\docu_package
|
||||
===============
|
||||
|
||||
Docu Package Interface to abstract from for every docu to be registered.
|
||||
|
||||
|
||||
|
||||
|
||||
* Interface name: docu_package
|
||||
* Namespace: SYSTEM\DOCU
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
|
||||
### get_config
|
||||
|
||||
array SYSTEM\DOCU\docu_package::get_config()
|
||||
|
||||
Config of the Docu Package
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
35
SYSTEM-DOCU-docu_system.md
Normal file
35
SYSTEM-DOCU-docu_system.md
Normal file
@ -0,0 +1,35 @@
|
||||
SYSTEM\DOCU\docu_system
|
||||
===============
|
||||
|
||||
Docu Package Class for System.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: docu_system
|
||||
* Namespace: SYSTEM\DOCU
|
||||
* This class implements: [SYSTEM\DOCU\docu_package](SYSTEM-DOCU-docu_package)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
|
||||
### get_config
|
||||
|
||||
array SYSTEM\DOCU\docu_package::get_config()
|
||||
|
||||
Config of the Docu Package
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\DOCU\docu_package](SYSTEM-DOCU-docu_package)
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\FILES\files
|
||||
===============
|
||||
|
||||
|
||||
Files Class provided by System to register folders and serve files.
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ Properties
|
||||
|
||||
private mixed $folders = array()
|
||||
|
||||
|
||||
array Variable to store all registred file folders
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### registerFolder
|
||||
|
||||
mixed SYSTEM\FILES\files::registerFolder($path, $cat)
|
||||
|
||||
null SYSTEM\FILES\files::registerFolder(string $path, string $cat)
|
||||
|
||||
Register a filefolder
|
||||
|
||||
|
||||
|
||||
@ -46,16 +46,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $path **mixed**
|
||||
* $cat **mixed**
|
||||
* $path **string** - <p>Path of the Folder</p>
|
||||
* $cat **string** - <p>Category to register that folder to</p>
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\FILES\files::get($cat, $id, $returnasjson)
|
||||
|
||||
mixed SYSTEM\FILES\files::get(string $cat, string $id, boolean $returnasjson)
|
||||
|
||||
Retrieve a File
|
||||
|
||||
|
||||
|
||||
@ -64,17 +64,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $returnasjson **mixed**
|
||||
* $cat **string** - <p>Category to query or null</p>
|
||||
* $id **string** - <p>File to query or null</p>
|
||||
* $returnasjson **boolean** - <p>Determines if you recieve Arrays or JSON results</p>
|
||||
|
||||
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\FILES\files::put($cat, $id, $contents)
|
||||
|
||||
boolean SYSTEM\FILES\files::put(string $cat, string $id, \SYSTEM\FILES\ressource $contents)
|
||||
|
||||
Move a uploaded File into a Directtory
|
||||
|
||||
|
||||
|
||||
@ -83,17 +83,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $contents **mixed**
|
||||
* $cat **string** - <p>Category for the File</p>
|
||||
* $id **string** - <p>ID for the File</p>
|
||||
* $contents **SYSTEM\FILES\ressource** - <p>Uploaded File Ressource</p>
|
||||
|
||||
|
||||
|
||||
### delete
|
||||
|
||||
mixed SYSTEM\FILES\files::delete($cat, $id)
|
||||
|
||||
boolean SYSTEM\FILES\files::delete(string $cat, string $id)
|
||||
|
||||
Delete a File
|
||||
|
||||
|
||||
|
||||
@ -102,16 +102,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>Category of the File</p>
|
||||
* $id **string** - <p>ID of the File</p>
|
||||
|
||||
|
||||
|
||||
### rename
|
||||
|
||||
mixed SYSTEM\FILES\files::rename($cat, $id, $newid)
|
||||
|
||||
boolean SYSTEM\FILES\files::rename(string $cat, string $id, string $newid)
|
||||
|
||||
Rename a File
|
||||
|
||||
|
||||
|
||||
@ -120,17 +120,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $newid **mixed**
|
||||
* $cat **string** - <p>Category of the File</p>
|
||||
* $id **string** - <p>ID of the File</p>
|
||||
* $newid **string** - <p>ID of the renamed File</p>
|
||||
|
||||
|
||||
|
||||
### getFolder
|
||||
|
||||
mixed SYSTEM\FILES\files::getFolder($folder)
|
||||
|
||||
array SYSTEM\FILES\files::getFolder(string $folder)
|
||||
|
||||
Returns the contents of a Folder
|
||||
|
||||
|
||||
|
||||
@ -139,15 +139,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $folder **mixed**
|
||||
* $folder **string** - <p>Path to the Folder</p>
|
||||
|
||||
|
||||
|
||||
### getURL
|
||||
|
||||
mixed SYSTEM\FILES\files::getURL($cat, $id)
|
||||
|
||||
string SYSTEM\FILES\files::getURL(string $cat, string $id)
|
||||
|
||||
Returns a URL for a File
|
||||
|
||||
|
||||
|
||||
@ -156,16 +156,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>Category of the File</p>
|
||||
* $id **string** - <p>ID of the File</p>
|
||||
|
||||
|
||||
|
||||
### file_get_contents_chunked
|
||||
|
||||
mixed SYSTEM\FILES\files::file_get_contents_chunked($file, $chunk_size, $callback)
|
||||
|
||||
boolean SYSTEM\FILES\files::file_get_contents_chunked(string $file, integer $chunk_size, \SYSTEM\FILES\function $callback)
|
||||
|
||||
Returns Chunks of a File
|
||||
Callback: function($chunk,&$handle,$iteration)
|
||||
|
||||
|
||||
|
||||
@ -174,8 +175,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **mixed**
|
||||
* $chunk_size **mixed**
|
||||
* $callback **mixed**
|
||||
* $file **string** - <p>Path of the File</p>
|
||||
* $chunk_size **integer** - <p>Size of the Chunks</p>
|
||||
* $callback **SYSTEM\FILES\function** - <p>Callback function which is called for every chunk</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\HEADER
|
||||
===============
|
||||
|
||||
|
||||
HEADER Class provided by System Send HTML Headers
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,10 @@ Methods
|
||||
|
||||
### checkHeader
|
||||
|
||||
mixed SYSTEM\HEADER::checkHeader()
|
||||
|
||||
boolean SYSTEM\HEADER::checkHeader()
|
||||
|
||||
Check if Header was already sent
|
||||
Writes Warning into Database on failure if Database logging is enabled.
|
||||
|
||||
|
||||
|
||||
@ -33,11 +34,28 @@ Methods
|
||||
|
||||
|
||||
|
||||
### available
|
||||
|
||||
boolean SYSTEM\HEADER::available(string $datatype)
|
||||
|
||||
Check if a given Datatype has a handler within this class.
|
||||
|
||||
Not Case sensitive.
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $datatype **string** - <p>Datatype to be checked eg. 'jpg'</p>
|
||||
|
||||
|
||||
|
||||
### JSON
|
||||
|
||||
mixed SYSTEM\HEADER::JSON()
|
||||
|
||||
null SYSTEM\HEADER::JSON()
|
||||
|
||||
Send JSON Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -49,9 +67,9 @@ Methods
|
||||
|
||||
### PNG
|
||||
|
||||
mixed SYSTEM\HEADER::PNG()
|
||||
|
||||
null SYSTEM\HEADER::PNG()
|
||||
|
||||
Send PNG Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -63,9 +81,9 @@ Methods
|
||||
|
||||
### JPG
|
||||
|
||||
mixed SYSTEM\HEADER::JPG()
|
||||
|
||||
null SYSTEM\HEADER::JPG()
|
||||
|
||||
Send JPG Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -77,9 +95,9 @@ Methods
|
||||
|
||||
### JPEG
|
||||
|
||||
mixed SYSTEM\HEADER::JPEG()
|
||||
|
||||
null SYSTEM\HEADER::JPEG()
|
||||
|
||||
Send JPEG Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -91,9 +109,9 @@ Methods
|
||||
|
||||
### GIF
|
||||
|
||||
mixed SYSTEM\HEADER::GIF()
|
||||
|
||||
null SYSTEM\HEADER::GIF()
|
||||
|
||||
Send GIF Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -105,9 +123,9 @@ Methods
|
||||
|
||||
### JS
|
||||
|
||||
mixed SYSTEM\HEADER::JS()
|
||||
|
||||
null SYSTEM\HEADER::JS()
|
||||
|
||||
Send JS Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -119,9 +137,9 @@ Methods
|
||||
|
||||
### CSS
|
||||
|
||||
mixed SYSTEM\HEADER::CSS()
|
||||
|
||||
null SYSTEM\HEADER::CSS()
|
||||
|
||||
Send CSS Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -133,9 +151,9 @@ Methods
|
||||
|
||||
### LESS
|
||||
|
||||
mixed SYSTEM\HEADER::LESS()
|
||||
|
||||
null SYSTEM\HEADER::LESS()
|
||||
|
||||
Send LESS Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -147,9 +165,9 @@ Methods
|
||||
|
||||
### FILE
|
||||
|
||||
mixed SYSTEM\HEADER::FILE($filename)
|
||||
|
||||
null SYSTEM\HEADER::FILE(string $filename)
|
||||
|
||||
Send FILE(download) Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
@ -158,23 +176,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filename **mixed**
|
||||
|
||||
|
||||
|
||||
### available
|
||||
|
||||
mixed SYSTEM\HEADER::available($datatype)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $datatype **mixed**
|
||||
* $filename **string** - <p>Filename which should be transmitted with the Filetransfere</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\HTML\html
|
||||
===============
|
||||
|
||||
|
||||
HTML Class provided by System to generate common HTML tags.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### link
|
||||
|
||||
mixed SYSTEM\HTML\html::link($href, $rel, $type)
|
||||
|
||||
string SYSTEM\HTML\html::link(string $href, string $rel, string $type)
|
||||
|
||||
Generate <link> tag
|
||||
|
||||
|
||||
|
||||
@ -32,17 +32,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $href **mixed**
|
||||
* $rel **mixed**
|
||||
* $type **mixed**
|
||||
* $href **string** - <p>href attribute</p>
|
||||
* $rel **string** - <p>rel attribute</p>
|
||||
* $type **string** - <p>type attribute</p>
|
||||
|
||||
|
||||
|
||||
### script
|
||||
|
||||
mixed SYSTEM\HTML\html::script($src, $type, $rel, $language, $script)
|
||||
|
||||
string SYSTEM\HTML\html::script(string $src, string $type, string $rel, string $script)
|
||||
|
||||
Generate <script> tag
|
||||
|
||||
|
||||
|
||||
@ -51,19 +51,18 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $src **mixed**
|
||||
* $type **mixed**
|
||||
* $rel **mixed**
|
||||
* $language **mixed**
|
||||
* $script **mixed**
|
||||
* $src **string** - <p>src attribute</p>
|
||||
* $type **string** - <p>type attribute</p>
|
||||
* $rel **string** - <p>rel attribute</p>
|
||||
* $script **string** - <p>script contents</p>
|
||||
|
||||
|
||||
|
||||
### style
|
||||
|
||||
mixed SYSTEM\HTML\html::style($style)
|
||||
|
||||
string SYSTEM\HTML\html::style(string $style)
|
||||
|
||||
Generate <style> tag
|
||||
|
||||
|
||||
|
||||
@ -72,6 +71,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $style **mixed**
|
||||
* $style **string** - <p>style contents</p>
|
||||
|
||||
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
SYSTEM\LOG\AbstractResult
|
||||
===============
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: AbstractResult
|
||||
* Namespace: SYSTEM\LOG
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
|
||||
### toString
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::toString($json_array, $status, $start_time)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $json_array **mixed**
|
||||
* $status **mixed**
|
||||
* $start_time **mixed**
|
||||
|
||||
|
||||
|
||||
### error
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::error(\Exception $e)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $e **Exception**
|
||||
|
||||
|
||||
|
||||
### ok
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::ok()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\COUNTER
|
||||
===============
|
||||
|
||||
Counter Log Class provided by System to count calls to the Site.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: COUNTER
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\CRON
|
||||
===============
|
||||
|
||||
Cron Log Class provided by System for Cron Messages.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: CRON
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\DEPRECATED
|
||||
===============
|
||||
|
||||
Deprecated Log Class provided by System for marking code as Deprecated.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: DEPRECATED
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\ERROR
|
||||
===============
|
||||
|
||||
Error Log Class provided by System for all kinds of Errors.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: ERROR
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\ERROR_EXCEPTION
|
||||
===============
|
||||
|
||||
Error Exception Log Class provided by System for Errors Exceptions.
|
||||
|
||||
|
||||
|
||||
All other error exception Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: ERROR_EXCEPTION
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct($message, $code, $severity, $filename, $lineno, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct(string $message, integer $code, integer $severity, string $filename, integer $lineno, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -46,11 +46,11 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $severity **mixed**
|
||||
* $filename **mixed**
|
||||
* $lineno **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $severity **integer** - <p>Severity of the Error</p>
|
||||
* $filename **string** - <p>Filename where the Error occurred</p>
|
||||
* $lineno **integer** - <p>Line number where the Error occurred</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\INFO
|
||||
===============
|
||||
|
||||
Info Log Class provided by System for logging Infos.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: INFO
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,32 +1,13 @@
|
||||
SYSTEM\LOG\JsonResult
|
||||
===============
|
||||
|
||||
|
||||
JsonResult Class provided by System to return Data as JSON or MSGPACK.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: JsonResult
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
----------
|
||||
|
||||
|
||||
### JSONRESULT_OK
|
||||
|
||||
const JSONRESULT_OK = true
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### JSONRESULT_ERROR
|
||||
|
||||
const JSONRESULT_ERROR = false
|
||||
|
||||
|
||||
|
||||
@ -40,62 +21,59 @@ Methods
|
||||
|
||||
### toString
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::toString($json_array, $status, $start_time)
|
||||
|
||||
string SYSTEM\LOG\JsonResult::toString(array $json_array, boolean $status, integer $start_time)
|
||||
|
||||
Retun JsonResult with data given by array
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $json_array **mixed**
|
||||
* $status **mixed**
|
||||
* $start_time **mixed**
|
||||
* $json_array **array** - <p>Data which should be included in the JSOn Result.</p>
|
||||
* $status **boolean** - <p>true or false depending on success</p>
|
||||
* $start_time **integer** - <p>To calculate Querytime - if Null System time is used.</p>
|
||||
|
||||
|
||||
|
||||
### error
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::error(\Exception $e)
|
||||
|
||||
string SYSTEM\LOG\JsonResult::error(\Exception $e)
|
||||
|
||||
Retun JsonResult for given Exception
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $e **Exception**
|
||||
* $e **Exception** - <p>Exception to be convered.</p>
|
||||
|
||||
|
||||
|
||||
### ok
|
||||
|
||||
mixed SYSTEM\LOG\AbstractResult::ok()
|
||||
|
||||
string SYSTEM\LOG\JsonResult::ok()
|
||||
|
||||
Retun JsonResult with success status
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
|
||||
|
||||
|
||||
|
||||
### fail
|
||||
|
||||
mixed SYSTEM\LOG\JsonResult::fail()
|
||||
|
||||
string SYSTEM\LOG\JsonResult::fail()
|
||||
|
||||
Retun JsonResult with failure status
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\SHUTDOWN_EXCEPTION
|
||||
===============
|
||||
|
||||
Shutdown Exception Class provided by System for logging Shutdown Exceptions.
|
||||
|
||||
|
||||
|
||||
All other error exception Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: SHUTDOWN_EXCEPTION
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct($message, $code, $severity, $filename, $lineno, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct(string $message, integer $code, integer $severity, string $filename, integer $lineno, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -46,11 +46,11 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $severity **mixed**
|
||||
* $filename **mixed**
|
||||
* $lineno **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $severity **integer** - <p>Severity of the Error</p>
|
||||
* $filename **string** - <p>Filename where the Error occurred</p>
|
||||
* $lineno **integer** - <p>Line number where the Error occurred</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION
|
||||
===============
|
||||
|
||||
System Exception Class provided by System for logging all kinds of System Exceptions.
|
||||
|
||||
|
||||
|
||||
All other error exception Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: SYSTEM_ERROR_EXCEPTION
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -35,9 +35,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct($message, $code, $severity, $filename, $lineno, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct(string $message, integer $code, integer $severity, string $filename, integer $lineno, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -45,11 +45,11 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $severity **mixed**
|
||||
* $filename **mixed**
|
||||
* $lineno **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $severity **integer** - <p>Severity of the Error</p>
|
||||
* $filename **string** - <p>Filename where the Error occurred</p>
|
||||
* $lineno **integer** - <p>Line number where the Error occurred</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\SYSTEM_EXCEPTION
|
||||
===============
|
||||
|
||||
System Exception Class provided by System for logging all kinds of System Exceptions.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: SYSTEM_EXCEPTION
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -56,8 +56,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\TODO
|
||||
===============
|
||||
|
||||
Todo Class provided by System for logging todos.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: TODO
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\TranslatableError
|
||||
===============
|
||||
|
||||
Translateable Error Class provided by System for serving Multilanguage Errors from Database.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: TranslatableError
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
SYSTEM\LOG\WARNING
|
||||
===============
|
||||
|
||||
Warning Class provided by System for logging Warnings.
|
||||
|
||||
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: WARNING
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
|
||||
|
||||
|
||||
@ -46,9 +46,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
|
||||
|
||||
|
||||
@ -57,8 +57,8 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $code **mixed**
|
||||
* $previous **mixed**
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
SYSTEM\LOG\error_handler
|
||||
===============
|
||||
|
||||
Error handler Interface provided by System to derive your own loghandlers from.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: error_handler
|
||||
* Interface name: error_handler
|
||||
* Namespace: SYSTEM\LOG
|
||||
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
@ -19,25 +19,11 @@ Methods
|
||||
-------
|
||||
|
||||
|
||||
### MASK
|
||||
|
||||
mixed SYSTEM\LOG\error_handler::MASK()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### CALL
|
||||
|
||||
mixed SYSTEM\LOG\error_handler::CALL(\Exception $E, $thrown)
|
||||
|
||||
boolean SYSTEM\LOG\error_handler::CALL(\Exception $E, boolean $thrown)
|
||||
|
||||
Call function to handle exceptions
|
||||
|
||||
|
||||
|
||||
@ -46,7 +32,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception**
|
||||
* $thrown **mixed**
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
|
||||
|
||||
|
||||
@ -1,15 +1,14 @@
|
||||
SYSTEM\LOG\error_handler_dbwriter
|
||||
===============
|
||||
|
||||
Error handler Class provided by System to log to the database.
|
||||
|
||||
|
||||
|
||||
Register this before every other handler, cuz this will need to handle every single error.
|
||||
|
||||
|
||||
* Class name: error_handler_dbwriter
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
|
||||
* This class implements: [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
|
||||
|
||||
|
||||
@ -22,9 +21,9 @@ Methods
|
||||
|
||||
### CALL
|
||||
|
||||
mixed SYSTEM\LOG\error_handler::CALL(\Exception $E, $thrown)
|
||||
|
||||
boolean SYSTEM\LOG\error_handler::CALL(\Exception $E, boolean $thrown)
|
||||
|
||||
Call function to handle exceptions
|
||||
|
||||
|
||||
|
||||
@ -34,22 +33,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception**
|
||||
* $thrown **mixed**
|
||||
|
||||
|
||||
|
||||
### MASK
|
||||
|
||||
mixed SYSTEM\LOG\error_handler::MASK()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
|
||||
|
||||
|
||||
@ -1,15 +1,14 @@
|
||||
SYSTEM\LOG\error_handler_jsonoutput
|
||||
===============
|
||||
|
||||
Error handler Class provided by System to return the Error as JSON.
|
||||
|
||||
|
||||
|
||||
Register this Handler as last one
|
||||
|
||||
|
||||
* Class name: error_handler_jsonoutput
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
|
||||
* This class implements: [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
|
||||
|
||||
|
||||
@ -22,9 +21,9 @@ Methods
|
||||
|
||||
### CALL
|
||||
|
||||
mixed SYSTEM\LOG\error_handler::CALL(\Exception $E, $thrown)
|
||||
|
||||
boolean SYSTEM\LOG\error_handler::CALL(\Exception $E, boolean $thrown)
|
||||
|
||||
Call function to handle exceptions
|
||||
|
||||
|
||||
|
||||
@ -34,22 +33,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception**
|
||||
* $thrown **mixed**
|
||||
|
||||
|
||||
|
||||
### MASK
|
||||
|
||||
mixed SYSTEM\LOG\error_handler::MASK()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\LOG\log
|
||||
===============
|
||||
|
||||
|
||||
Log Class provided by System to manage log handlers.
|
||||
|
||||
|
||||
|
||||
@ -31,7 +31,7 @@ Properties
|
||||
|
||||
private mixed $handlers = array()
|
||||
|
||||
|
||||
array Variable to store all registred log handlers
|
||||
|
||||
|
||||
|
||||
@ -45,9 +45,9 @@ Methods
|
||||
|
||||
### registerHandler
|
||||
|
||||
mixed SYSTEM\LOG\log::registerHandler($handler)
|
||||
|
||||
null SYSTEM\LOG\log::registerHandler(\SYSTEM\LOG\class $handler)
|
||||
|
||||
Register a Log Handler
|
||||
|
||||
|
||||
|
||||
@ -56,15 +56,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $handler **mixed**
|
||||
* $handler **SYSTEM\LOG\class** - <p>Classname of the handler to be registered</p>
|
||||
|
||||
|
||||
|
||||
### call_handlers
|
||||
|
||||
mixed SYSTEM\LOG\log::call_handlers(\Exception $E, $thrown)
|
||||
|
||||
boolean SYSTEM\LOG\log::call_handlers(\Exception $E, boolean $thrown)
|
||||
|
||||
Call handlers function upon error
|
||||
|
||||
|
||||
|
||||
@ -73,16 +73,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception**
|
||||
* $thrown **mixed**
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
|
||||
|
||||
|
||||
### __exception_handler
|
||||
|
||||
mixed SYSTEM\LOG\log::__exception_handler(\Exception $E, $thrown)
|
||||
|
||||
boolean SYSTEM\LOG\log::__exception_handler(\Exception $E, boolean $thrown)
|
||||
|
||||
Exception Handler for System-log handling
|
||||
|
||||
|
||||
|
||||
@ -91,16 +91,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception**
|
||||
* $thrown **mixed**
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
|
||||
|
||||
|
||||
### __error_handler
|
||||
|
||||
mixed SYSTEM\LOG\log::__error_handler($code, $message, $file, $line, $thrown)
|
||||
|
||||
boolean SYSTEM\LOG\log::__error_handler(integer $code, string $message, string $file, string $line, boolean $thrown)
|
||||
|
||||
Error Handler for System-log handling
|
||||
|
||||
|
||||
|
||||
@ -109,19 +109,19 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $code **mixed**
|
||||
* $message **mixed**
|
||||
* $file **mixed**
|
||||
* $line **mixed**
|
||||
* $thrown **mixed**
|
||||
* $code **integer** - <p>Errorcode</p>
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $file **string** - <p>Error File</p>
|
||||
* $line **string** - <p>Error File-Line</p>
|
||||
* $thrown **boolean** - <p>Was the Error thrown?</p>
|
||||
|
||||
|
||||
|
||||
### __shutdown_handler
|
||||
|
||||
mixed SYSTEM\LOG\log::__shutdown_handler($thrown)
|
||||
|
||||
boolean SYSTEM\LOG\log::__shutdown_handler(boolean $thrown)
|
||||
|
||||
Shutdown Handler for System-log handling
|
||||
|
||||
|
||||
|
||||
@ -130,15 +130,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $thrown **mixed**
|
||||
* $thrown **boolean** - <p>Was the Error thrown?</p>
|
||||
|
||||
|
||||
|
||||
### __fatal_error_handler
|
||||
|
||||
mixed SYSTEM\LOG\log::__fatal_error_handler($bufferContent, $thrown)
|
||||
|
||||
string SYSTEM\LOG\log::__fatal_error_handler(string $bufferContent, boolean $thrown)
|
||||
|
||||
Fatal Error Handler for System-log handling
|
||||
(unused - experimental)
|
||||
|
||||
|
||||
|
||||
@ -147,7 +148,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $bufferContent **mixed**
|
||||
* $thrown **mixed**
|
||||
* $bufferContent **string** - <p>Website contens before sent to user</p>
|
||||
* $thrown **boolean** - <p>Was the Error thrown?</p>
|
||||
|
||||
|
||||
|
||||
61
SYSTEM-PAGE-DefaultPage.md
Normal file
61
SYSTEM-PAGE-DefaultPage.md
Normal file
@ -0,0 +1,61 @@
|
||||
SYSTEM\PAGE\DefaultPage
|
||||
===============
|
||||
|
||||
DefaultPage Interface provided by System to describe default page functions.
|
||||
|
||||
|
||||
|
||||
|
||||
* Interface name: DefaultPage
|
||||
* Namespace: SYSTEM\PAGE
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
|
||||
### html
|
||||
|
||||
string SYSTEM\PAGE\DefaultPage::html()
|
||||
|
||||
Html content of the page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\PAGE\DefaultPage::js()
|
||||
|
||||
Js files to be loaded for this page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
array SYSTEM\PAGE\DefaultPage::css()
|
||||
|
||||
Css files to be loaded for this page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
@ -1,15 +1,14 @@
|
||||
SYSTEM\PAGE\Page
|
||||
===============
|
||||
|
||||
Page Interface provided by System to describe page functions.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: Page
|
||||
* Interface name: Page
|
||||
* Namespace: SYSTEM\PAGE
|
||||
* This is an **abstract** class
|
||||
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
@ -22,14 +21,71 @@ Methods
|
||||
|
||||
### html
|
||||
|
||||
mixed SYSTEM\PAGE\Page::html()
|
||||
|
||||
string SYSTEM\PAGE\Page::html()
|
||||
|
||||
Html content of the page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\PAGE\Page::js()
|
||||
|
||||
Js files to be loaded for this page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
array SYSTEM\PAGE\Page::css()
|
||||
|
||||
Css files to be loaded for this page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### title
|
||||
|
||||
string SYSTEM\PAGE\Page::title()
|
||||
|
||||
Tile of the page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### meta
|
||||
|
||||
array SYSTEM\PAGE\Page::meta()
|
||||
|
||||
Meta of the page
|
||||
Array Key is used as Meta to be written. The string is Split by the last
|
||||
"_". meta_samplepage_description will resolve to meta['description']
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PAGE\ParensParser
|
||||
===============
|
||||
|
||||
|
||||
ParensParser Class provided by System to parse Statestring.
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ Properties
|
||||
|
||||
protected mixed $stack = null
|
||||
|
||||
|
||||
something to keep track of parens nesting
|
||||
|
||||
|
||||
|
||||
@ -32,7 +32,7 @@ Properties
|
||||
|
||||
protected mixed $current = null
|
||||
|
||||
|
||||
current level
|
||||
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ Properties
|
||||
|
||||
protected mixed $string = null
|
||||
|
||||
|
||||
input string to parse
|
||||
|
||||
|
||||
|
||||
@ -54,7 +54,7 @@ Properties
|
||||
|
||||
protected mixed $position = null
|
||||
|
||||
|
||||
current character offset in string
|
||||
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@ Properties
|
||||
|
||||
protected mixed $buffer_start = null
|
||||
|
||||
|
||||
start of text-buffer
|
||||
|
||||
|
||||
|
||||
@ -78,9 +78,9 @@ Methods
|
||||
|
||||
### parse
|
||||
|
||||
mixed SYSTEM\PAGE\ParensParser::parse($string)
|
||||
|
||||
array SYSTEM\PAGE\ParensParser::parse(string $string)
|
||||
|
||||
Parse the given string and split by () brackets and |
|
||||
|
||||
|
||||
|
||||
@ -88,15 +88,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $string **mixed**
|
||||
* $string **string** - <p>String to be parsed</p>
|
||||
|
||||
|
||||
|
||||
### push
|
||||
|
||||
mixed SYSTEM\PAGE\ParensParser::push()
|
||||
|
||||
null SYSTEM\PAGE\ParensParser::push()
|
||||
|
||||
Internal Function to push onto the stack
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PAGE\State
|
||||
===============
|
||||
|
||||
|
||||
State Class provided by System to get State information.
|
||||
|
||||
|
||||
|
||||
@ -21,9 +21,9 @@ Methods
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\PAGE\State::get($group, $state, $returnasjson)
|
||||
|
||||
\SYSTEM\PAGE\json SYSTEM\PAGE\State::get(integer $group, string $state, boolean $returnasjson)
|
||||
|
||||
Get a State
|
||||
|
||||
|
||||
|
||||
@ -32,34 +32,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $returnasjson **mixed**
|
||||
* $group **integer** - <p>Group ID of the State requested.</p>
|
||||
* $state **string** - <p>Name of the state(including all substates and params.</p>
|
||||
* $returnasjson **boolean** - <p>Return the result as Json or Array</p>
|
||||
|
||||
|
||||
|
||||
### parse_substate
|
||||
|
||||
mixed SYSTEM\PAGE\State::parse_substate($substate)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $substate **mixed**
|
||||
|
||||
|
||||
|
||||
### is_loaded
|
||||
|
||||
mixed SYSTEM\PAGE\State::is_loaded($row, $substate, $state_name, $parent_id)
|
||||
|
||||
array SYSTEM\PAGE\State::parse_substate(string $substate)
|
||||
|
||||
Get Substates out of State string
|
||||
|
||||
|
||||
|
||||
@ -68,9 +51,27 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row **mixed**
|
||||
* $substate **mixed**
|
||||
* $state_name **mixed**
|
||||
* $parent_id **mixed**
|
||||
* $substate **string** - <p>Substate string.</p>
|
||||
|
||||
|
||||
|
||||
### is_loaded
|
||||
|
||||
boolean SYSTEM\PAGE\State::is_loaded(array $row, array $substate, string $state_name, integer $parent_id)
|
||||
|
||||
Is the substate loaded alrdy(for result set)
|
||||
(recursive)
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row **array** - <p>Substate Database row.</p>
|
||||
* $substate **array** - <p>Array with substates</p>
|
||||
* $state_name **string** - <p>Name of the main state</p>
|
||||
* $parent_id **integer** - <p>Id of parent</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PAGE\replace
|
||||
===============
|
||||
|
||||
|
||||
Replace Class provided by System to replace placeholders in text and files ${placeholder}.
|
||||
|
||||
|
||||
|
||||
@ -21,53 +21,63 @@ Methods
|
||||
|
||||
### replace
|
||||
|
||||
mixed SYSTEM\PAGE\replace::replace($text, $vars)
|
||||
|
||||
string SYSTEM\PAGE\replace::replace(string $text, array $vars)
|
||||
|
||||
Replace all placeholders in a text.
|
||||
|
||||
Array Key of Placeholders represents the name of the placeholder.
|
||||
The value to the key is filled in.
|
||||
|
||||
"Text ${textplaceholder}"
|
||||
array('textplaceholder' => 'test')
|
||||
resolves to: "Text test"
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $text **mixed**
|
||||
* $vars **mixed**
|
||||
* $text **string** - <p>text to be subject of replacements</p>
|
||||
* $vars **array** - <p>Array with Placeholders.</p>
|
||||
|
||||
|
||||
|
||||
### replaceFile
|
||||
|
||||
mixed SYSTEM\PAGE\replace::replaceFile($path, $vars)
|
||||
|
||||
string SYSTEM\PAGE\replace::replaceFile(string $path, array $vars)
|
||||
|
||||
Replace all placeholders in a file.
|
||||
|
||||
Array Key of Placeholders represents the name of the placeholder.
|
||||
The value to the key is filled in.
|
||||
|
||||
"Text ${textplaceholder}"
|
||||
array('textplaceholder' => 'test')
|
||||
resolves to: "Text test"
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $path **mixed**
|
||||
* $vars **mixed**
|
||||
* $path **string** - <p>Filepath of file to be subject of replacements</p>
|
||||
* $vars **array** - <p>Array with Placeholders.</p>
|
||||
|
||||
|
||||
|
||||
### clean
|
||||
|
||||
mixed SYSTEM\PAGE\replace::clean($text)
|
||||
|
||||
|
||||
string SYSTEM\PAGE\replace::clean(string $text)
|
||||
|
||||
Replace all placeholders in a text with null.
|
||||
|
||||
Effectively removing all Placeholders
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $text **mixed**
|
||||
* $text **string** - <p>text to be subject of replacements</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PAGE\text
|
||||
===============
|
||||
|
||||
|
||||
Text Class provided by System to get Texts from the Database.
|
||||
|
||||
|
||||
|
||||
@ -31,9 +31,9 @@ Methods
|
||||
|
||||
### id_tags
|
||||
|
||||
mixed SYSTEM\PAGE\text::id_tags($id)
|
||||
|
||||
array SYSTEM\PAGE\text::id_tags(string $id)
|
||||
|
||||
Get the tags of a textid
|
||||
|
||||
|
||||
|
||||
@ -42,15 +42,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $id **string** - <p>textid to be checked upon</p>
|
||||
|
||||
|
||||
|
||||
### tag
|
||||
|
||||
mixed SYSTEM\PAGE\text::tag($tag, $lang, $fallback)
|
||||
|
||||
array SYSTEM\PAGE\text::tag(string $tag, string $lang, boolean $fallback)
|
||||
|
||||
Get the texts with certain tag and language
|
||||
|
||||
|
||||
|
||||
@ -59,17 +59,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $tag **mixed**
|
||||
* $lang **mixed**
|
||||
* $fallback **mixed**
|
||||
* $tag **string** - <p>tag to be checked upon</p>
|
||||
* $lang **string** - <p>Language for the requested texts</p>
|
||||
* $fallback **boolean** - <p>Fallback to default language if certain id is not found for the specified language.</p>
|
||||
|
||||
|
||||
|
||||
### tag_adv
|
||||
|
||||
mixed SYSTEM\PAGE\text::tag_adv($tag, $lang, $fallback)
|
||||
|
||||
array SYSTEM\PAGE\text::tag_adv(string $tag, string $lang, boolean $fallback)
|
||||
|
||||
Get the texts with certain tag and language plus creation user info etc
|
||||
|
||||
|
||||
|
||||
@ -78,17 +78,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $tag **mixed**
|
||||
* $lang **mixed**
|
||||
* $fallback **mixed**
|
||||
* $tag **string** - <p>tag to be checked upon</p>
|
||||
* $lang **string** - <p>Language for the requested texts</p>
|
||||
* $fallback **boolean** - <p>Fallback to default language if certain id is not found for the specified language.</p>
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\PAGE\text::get($id, $lang, $fallback)
|
||||
|
||||
string SYSTEM\PAGE\text::get(string $id, string $lang, boolean $fallback)
|
||||
|
||||
Get a text with certain id and language
|
||||
|
||||
|
||||
|
||||
@ -97,17 +97,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $lang **mixed**
|
||||
* $fallback **mixed**
|
||||
* $id **string** - <p>Id of the text requested</p>
|
||||
* $lang **string** - <p>Language for the requested text</p>
|
||||
* $fallback **boolean** - <p>Fallback to default language if textid is not found for the specified language.</p>
|
||||
|
||||
|
||||
|
||||
### get_adv
|
||||
|
||||
mixed SYSTEM\PAGE\text::get_adv($id, $lang, $fallback)
|
||||
|
||||
\SYSTEM\PAGE\Databaseresult SYSTEM\PAGE\text::get_adv(string $id, string $lang, boolean $fallback)
|
||||
|
||||
Get a text with certain id and language plus creation user info etc
|
||||
|
||||
|
||||
|
||||
@ -116,17 +116,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $lang **mixed**
|
||||
* $fallback **mixed**
|
||||
* $id **string** - <p>Id of the text requested</p>
|
||||
* $lang **string** - <p>Language for the requested text</p>
|
||||
* $fallback **boolean** - <p>Fallback to default language if textid is not found for the specified language.</p>
|
||||
|
||||
|
||||
|
||||
### get_tags
|
||||
|
||||
mixed SYSTEM\PAGE\text::get_tags($id, $limit)
|
||||
|
||||
array SYSTEM\PAGE\text::get_tags(string $id, integer $limit)
|
||||
|
||||
Get a tags of a text with certain id and limit the results
|
||||
|
||||
|
||||
|
||||
@ -135,16 +135,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $limit **mixed**
|
||||
* $id **string** - <p>Id of the text requested</p>
|
||||
* $limit **integer** - <p>Amount of Tags to be requested</p>
|
||||
|
||||
|
||||
|
||||
### get_latest
|
||||
|
||||
mixed SYSTEM\PAGE\text::get_latest($tag, $limit)
|
||||
|
||||
array SYSTEM\PAGE\text::get_latest(string $tag, integer $limit)
|
||||
|
||||
Get latest texts from database by tag and limit
|
||||
|
||||
|
||||
|
||||
@ -153,16 +153,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $tag **mixed**
|
||||
* $limit **mixed**
|
||||
* $tag **string** - <p>Id of the tag requested</p>
|
||||
* $limit **integer** - <p>Amount of Texts to be requested</p>
|
||||
|
||||
|
||||
|
||||
### search
|
||||
|
||||
mixed SYSTEM\PAGE\text::search($search, $tag)
|
||||
|
||||
array SYSTEM\PAGE\text::search(string $search, string $tag)
|
||||
|
||||
Search with content of texts with given tag
|
||||
|
||||
|
||||
|
||||
@ -171,16 +171,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $search **mixed**
|
||||
* $tag **mixed**
|
||||
* $search **string** - <p>Searchstring "%" are added inside</p>
|
||||
* $tag **string** - <p>Search only texts with given tag</p>
|
||||
|
||||
|
||||
|
||||
### save
|
||||
|
||||
mixed SYSTEM\PAGE\text::save($id, $new_id, $lang, $tags, $text)
|
||||
|
||||
boolean SYSTEM\PAGE\text::save(string $id, string $new_id, string $lang, array $tags, string $text)
|
||||
|
||||
Save a text into the Database. Works like rename
|
||||
|
||||
|
||||
|
||||
@ -189,19 +189,19 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $new_id **mixed**
|
||||
* $lang **mixed**
|
||||
* $tags **mixed**
|
||||
* $text **mixed**
|
||||
* $id **string** - <p>Id of the text</p>
|
||||
* $new_id **string** - <p>New Id of the text</p>
|
||||
* $lang **string** - <p>Language of the text</p>
|
||||
* $tags **array** - <p>Array with tags for that text</p>
|
||||
* $text **string** - <p>Text to be saved</p>
|
||||
|
||||
|
||||
|
||||
### delete
|
||||
|
||||
mixed SYSTEM\PAGE\text::delete($id, $lang)
|
||||
|
||||
boolean SYSTEM\PAGE\text::delete(string $id, string $lang)
|
||||
|
||||
Delete a text from the Database.
|
||||
|
||||
|
||||
|
||||
@ -210,7 +210,7 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $lang **mixed**
|
||||
* $id **string** - <p>Id of the text</p>
|
||||
* $lang **string** - <p>Language of the text</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PATH
|
||||
===============
|
||||
|
||||
|
||||
Path Class provided by System to provide a unified path approach.
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ Properties
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
|
||||
|
||||
|
||||
@ -32,7 +32,7 @@ Properties
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
|
||||
array Variable to store the path of the path object
|
||||
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ Properties
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
|
||||
|
||||
|
||||
@ -56,9 +56,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
|
||||
|
||||
|
||||
@ -66,17 +66,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)**
|
||||
* $path **mixed**
|
||||
* $subpath **mixed**
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
mixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -87,9 +87,9 @@ Methods
|
||||
|
||||
### WEBPATH
|
||||
|
||||
mixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -97,6 +97,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **mixed**
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PLIB
|
||||
===============
|
||||
|
||||
|
||||
System Lib Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
|
||||
array Variable to store the path of the path object
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
|
||||
|
||||
|
||||
@ -57,9 +57,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
|
||||
|
||||
|
||||
@ -68,17 +68,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)**
|
||||
* $path **mixed**
|
||||
* $subpath **mixed**
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
mixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -90,9 +90,9 @@ Methods
|
||||
|
||||
### WEBPATH
|
||||
|
||||
mixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -101,6 +101,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **mixed**
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PROOT
|
||||
===============
|
||||
|
||||
|
||||
Root Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
|
||||
array Variable to store the path of the path object
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
|
||||
|
||||
|
||||
@ -57,9 +57,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
|
||||
|
||||
|
||||
@ -68,17 +68,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)**
|
||||
* $path **mixed**
|
||||
* $subpath **mixed**
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
mixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -90,9 +90,9 @@ Methods
|
||||
|
||||
### WEBPATH
|
||||
|
||||
mixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -101,6 +101,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **mixed**
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PSAI
|
||||
===============
|
||||
|
||||
|
||||
System SAI Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
|
||||
array Variable to store the path of the path object
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
|
||||
|
||||
|
||||
@ -57,9 +57,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
|
||||
|
||||
|
||||
@ -68,17 +68,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)**
|
||||
* $path **mixed**
|
||||
* $subpath **mixed**
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
mixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -90,9 +90,9 @@ Methods
|
||||
|
||||
### WEBPATH
|
||||
|
||||
mixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -101,6 +101,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **mixed**
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PSQL
|
||||
===============
|
||||
|
||||
|
||||
System SQL Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
|
||||
array Variable to store the path of the path object
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
|
||||
|
||||
|
||||
@ -57,9 +57,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
|
||||
|
||||
|
||||
@ -68,17 +68,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)**
|
||||
* $path **mixed**
|
||||
* $subpath **mixed**
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
mixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -90,9 +90,9 @@ Methods
|
||||
|
||||
### WEBPATH
|
||||
|
||||
mixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -101,6 +101,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **mixed**
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\PSYSTEM
|
||||
===============
|
||||
|
||||
|
||||
System Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Properties
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
|
||||
array Variable to store the path of the path object
|
||||
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ Properties
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
|
||||
|
||||
|
||||
@ -57,9 +57,9 @@ Methods
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
|
||||
|
||||
|
||||
@ -68,17 +68,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)**
|
||||
* $path **mixed**
|
||||
* $subpath **mixed**
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
mixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -90,9 +90,9 @@ Methods
|
||||
|
||||
### WEBPATH
|
||||
|
||||
mixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
@ -101,6 +101,6 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **mixed**
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\SaiModule
|
||||
===============
|
||||
|
||||
|
||||
SaiModule Class provided by System to be etended by Saimods
|
||||
|
||||
|
||||
|
||||
@ -22,24 +22,39 @@ Methods
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -48,52 +63,49 @@ Methods
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
@ -105,11 +117,11 @@ Methods
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -119,11 +131,11 @@ Methods
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -133,9 +145,9 @@ Methods
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -145,30 +157,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -181,9 +178,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -193,16 +190,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -212,16 +209,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -231,16 +228,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -250,15 +247,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -268,15 +265,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -286,15 +283,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -304,16 +301,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -323,16 +320,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -342,17 +339,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -365,9 +362,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -380,9 +377,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -392,15 +389,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -410,9 +407,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,15 +1,14 @@
|
||||
SYSTEM\SAI\default_page
|
||||
===============
|
||||
|
||||
|
||||
Sai default_page Class provided by System to construct the Sai Environment
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: default_page
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\PAGE\Page](SYSTEM-PAGE-Page)
|
||||
|
||||
* This class implements: [SYSTEM\PAGE\DefaultPage](SYSTEM-PAGE-DefaultPage)
|
||||
|
||||
|
||||
|
||||
@ -22,9 +21,9 @@ Methods
|
||||
|
||||
### menu_sys
|
||||
|
||||
mixed SYSTEM\SAI\default_page::menu_sys()
|
||||
|
||||
string SYSTEM\SAI\default_page::menu_sys()
|
||||
|
||||
Get the System Saimod Menu
|
||||
|
||||
|
||||
|
||||
@ -36,9 +35,9 @@ Methods
|
||||
|
||||
### menu_proj
|
||||
|
||||
mixed SYSTEM\SAI\default_page::menu_proj()
|
||||
|
||||
string SYSTEM\SAI\default_page::menu_proj()
|
||||
|
||||
Get the Users Saimod Menu
|
||||
|
||||
|
||||
|
||||
@ -50,9 +49,9 @@ Methods
|
||||
|
||||
### menu_start
|
||||
|
||||
mixed SYSTEM\SAI\default_page::menu_start()
|
||||
|
||||
string SYSTEM\SAI\default_page::menu_start()
|
||||
|
||||
Get the Start Saimod Menu
|
||||
|
||||
|
||||
|
||||
@ -64,43 +63,61 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed SYSTEM\SAI\default_page::css()
|
||||
array SYSTEM\PAGE\DefaultPage::css()
|
||||
|
||||
Css files to be loaded for this page
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\PAGE\DefaultPage](SYSTEM-PAGE-DefaultPage)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
mixed SYSTEM\SAI\default_page::js()
|
||||
array SYSTEM\PAGE\DefaultPage::js()
|
||||
|
||||
Js files to be loaded for this page
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\PAGE\DefaultPage](SYSTEM-PAGE-DefaultPage)
|
||||
|
||||
|
||||
|
||||
|
||||
### html
|
||||
|
||||
mixed SYSTEM\PAGE\Page::html()
|
||||
|
||||
string SYSTEM\PAGE\DefaultPage::html()
|
||||
|
||||
Html content of the page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\PAGE\Page](SYSTEM-PAGE-Page)
|
||||
* This method is defined by [SYSTEM\PAGE\DefaultPage](SYSTEM-PAGE-DefaultPage)
|
||||
|
||||
|
||||
|
||||
|
||||
### lang_menu
|
||||
|
||||
string SYSTEM\SAI\default_page::lang_menu(string $endpoint)
|
||||
|
||||
generate the HTML for the Language Menu
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $endpoint **string** - <p>Endpoint for the Language Menu</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\sai
|
||||
===============
|
||||
|
||||
|
||||
sai Class provided by System to register and manage saimods
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ Properties
|
||||
|
||||
private mixed $module_start = '\SYSTEM\SAI\saistart_sys_sai'
|
||||
|
||||
|
||||
string Classname of the Module which should be loaded at start
|
||||
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ Properties
|
||||
|
||||
private mixed $modules = array()
|
||||
|
||||
|
||||
array Classnames of all registered Sai user Modules
|
||||
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@ Properties
|
||||
|
||||
private mixed $modules_sys = array()
|
||||
|
||||
|
||||
array Classnames of all registered Sai system Modules
|
||||
|
||||
|
||||
|
||||
@ -59,9 +59,9 @@ Methods
|
||||
|
||||
### check_module
|
||||
|
||||
mixed SYSTEM\SAI\sai::check_module($module)
|
||||
|
||||
boolean SYSTEM\SAI\sai::check_module(string $module)
|
||||
|
||||
Check if a given SaiModuleClass is valid
|
||||
|
||||
|
||||
|
||||
@ -70,15 +70,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $module **mixed**
|
||||
* $module **string** - <p>Classname of the Module to be checked</p>
|
||||
|
||||
|
||||
|
||||
### register_start
|
||||
|
||||
mixed SYSTEM\SAI\sai::register_start($module)
|
||||
|
||||
null SYSTEM\SAI\sai::register_start(string $module)
|
||||
|
||||
Sets the Sai Startmodule
|
||||
|
||||
|
||||
|
||||
@ -87,15 +87,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $module **mixed**
|
||||
* $module **string** - <p>Classname of the Module to be Startmodule</p>
|
||||
|
||||
|
||||
|
||||
### register
|
||||
|
||||
mixed SYSTEM\SAI\sai::register($module)
|
||||
|
||||
null SYSTEM\SAI\sai::register(string $module)
|
||||
|
||||
Register a Sai user Module
|
||||
|
||||
|
||||
|
||||
@ -104,15 +104,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $module **mixed**
|
||||
* $module **string** - <p>Classname of the Module</p>
|
||||
|
||||
|
||||
|
||||
### register_sys
|
||||
|
||||
mixed SYSTEM\SAI\sai::register_sys($module)
|
||||
|
||||
null SYSTEM\SAI\sai::register_sys(string $module)
|
||||
|
||||
Register a Sai system Module
|
||||
|
||||
|
||||
|
||||
@ -121,15 +121,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $module **mixed**
|
||||
* $module **string** - <p>Classname of the Module</p>
|
||||
|
||||
|
||||
|
||||
### getStartModule
|
||||
|
||||
mixed SYSTEM\SAI\sai::getStartModule()
|
||||
|
||||
string SYSTEM\SAI\sai::getStartModule()
|
||||
|
||||
Get the classname of the Startmodule
|
||||
|
||||
|
||||
|
||||
@ -141,9 +141,9 @@ Methods
|
||||
|
||||
### getModules
|
||||
|
||||
mixed SYSTEM\SAI\sai::getModules()
|
||||
|
||||
array SYSTEM\SAI\sai::getModules()
|
||||
|
||||
Get all classnames of the registered user saimods
|
||||
|
||||
|
||||
|
||||
@ -155,9 +155,9 @@ Methods
|
||||
|
||||
### getSysModules
|
||||
|
||||
mixed SYSTEM\SAI\sai::getSysModules()
|
||||
|
||||
array SYSTEM\SAI\sai::getSysModules()
|
||||
|
||||
Get all classnames of the registered system saimods
|
||||
|
||||
|
||||
|
||||
@ -169,9 +169,9 @@ Methods
|
||||
|
||||
### getAllModules
|
||||
|
||||
mixed SYSTEM\SAI\sai::getAllModules()
|
||||
|
||||
array SYSTEM\SAI\sai::getAllModules()
|
||||
|
||||
Get all classnames of all the registered saimods
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
SYSTEM\SAI\saigui
|
||||
===============
|
||||
|
||||
|
||||
saigui Class provided by System to handle sai userinterface. Invoke (new saigui)->html()
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saigui
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\PAGE\Page](SYSTEM-PAGE-Page)
|
||||
|
||||
|
||||
|
||||
@ -32,15 +31,13 @@ Methods
|
||||
|
||||
### html
|
||||
|
||||
mixed SYSTEM\PAGE\Page::html()
|
||||
|
||||
\SYSTEM\SAI\html SYSTEM\SAI\saigui::html()
|
||||
|
||||
Generate the HTML for the SAI Userinterface
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\PAGE\Page](SYSTEM-PAGE-Page)
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\saimod_sys_api
|
||||
===============
|
||||
|
||||
|
||||
saimod_sys_api Class provided by System as saimod to manage the system_api table
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_api
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::sai_mod__SYSTEM_SAI_saimod_sys_api()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::sai_mod__SYSTEM_SAI_saimod_sys_api()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_list
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_list($group)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_list(integer $group)
|
||||
|
||||
Generate the HTML for the List of API Entries
|
||||
|
||||
|
||||
|
||||
@ -47,15 +47,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $group **integer** - <p>Group Filter of the List</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_deletedialog
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_deletedialog($ID, $group)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_deletedialog(integer $ID, integer $group)
|
||||
|
||||
Generate the HTML for the Delete Dialog of a API Entry
|
||||
|
||||
|
||||
|
||||
@ -64,16 +64,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ID **mixed**
|
||||
* $group **mixed**
|
||||
* $ID **integer** - <p>ID of the Entry</p>
|
||||
* $group **integer** - <p>Group id of the Entry</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_newdialog
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_newdialog()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_newdialog()
|
||||
|
||||
Generate the HTML for the New Dialog for a API Entry
|
||||
|
||||
|
||||
|
||||
@ -85,9 +85,9 @@ Methods
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_addcall
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_addcall($ID, $group, $type, $parentID, $parentValue, $name, $verify)
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_addcall(integer $ID, integer $group, integer $type, integer $parentID, string $parentValue, string $name, string $verify)
|
||||
|
||||
Add a new API Entry
|
||||
|
||||
|
||||
|
||||
@ -96,21 +96,21 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ID **mixed**
|
||||
* $group **mixed**
|
||||
* $type **mixed**
|
||||
* $parentID **mixed**
|
||||
* $parentValue **mixed**
|
||||
* $name **mixed**
|
||||
* $verify **mixed**
|
||||
* $ID **integer** - <p>ID of the Entry</p>
|
||||
* $group **integer** - <p>Group id of the Entry</p>
|
||||
* $type **integer** - <p>Type of the new Entry</p>
|
||||
* $parentID **integer** - <p>Parent id of the new Entry</p>
|
||||
* $parentValue **string** - <p>Parent Valze of the new Entry</p>
|
||||
* $name **string** - <p>Name of the new Entry</p>
|
||||
* $verify **string** - <p>Verifiername of the new Entry</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_deletecall
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_deletecall($ID, $group)
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_deletecall(integer $ID, integer $group)
|
||||
|
||||
Delete a API Entry
|
||||
|
||||
|
||||
|
||||
@ -119,16 +119,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ID **mixed**
|
||||
* $group **mixed**
|
||||
* $ID **integer** - <p>ID of the Entry</p>
|
||||
* $group **integer** - <p>Group id of the Entry</p>
|
||||
|
||||
|
||||
|
||||
### type_names
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::type_names($type)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::type_names(integer $type)
|
||||
|
||||
Internal Function to decode Types to Strings
|
||||
|
||||
|
||||
|
||||
@ -137,15 +137,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $type **mixed**
|
||||
* $type **integer** - <p>Type of the Page Entry</p>
|
||||
|
||||
|
||||
|
||||
### tablerow_class
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::tablerow_class($flag)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::tablerow_class(integer $flag)
|
||||
|
||||
Internal Function to generate api row classes
|
||||
|
||||
|
||||
|
||||
@ -154,15 +154,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $flag **mixed**
|
||||
* $flag **integer** - <p>Flag of the API Entry</p>
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
@ -175,11 +176,11 @@ Methods
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -190,11 +191,11 @@ Methods
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -205,9 +206,9 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::css()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_api::css()
|
||||
|
||||
Get all css System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
@ -219,9 +220,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_api::js()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_api::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
@ -233,24 +234,39 @@ Methods
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -259,52 +275,49 @@ Methods
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -314,30 +327,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -350,9 +348,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -362,16 +360,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -381,16 +379,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -400,16 +398,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -419,15 +417,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -437,15 +435,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -455,15 +453,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -473,16 +471,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -492,16 +490,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -511,17 +509,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -534,9 +532,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -549,9 +547,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -561,15 +559,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -579,9 +577,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\saimod_sys_cache
|
||||
===============
|
||||
|
||||
|
||||
saimod_sys_cache Class provided by System as saimod to manage the system_cache table
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_cache
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cache::sai_mod__SYSTEM_SAI_saimod_sys_cache()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_cache::sai_mod__SYSTEM_SAI_saimod_sys_cache()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_cache_action_clear
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cache::sai_mod__SYSTEM_SAI_saimod_sys_cache_action_clear()
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_cache::sai_mod__SYSTEM_SAI_saimod_sys_cache_action_clear()
|
||||
|
||||
Clear the Cache
|
||||
|
||||
|
||||
|
||||
@ -50,9 +50,9 @@ Methods
|
||||
|
||||
### tablerow_class
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cache::tablerow_class($cacheID)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_cache::tablerow_class(integer $cacheID)
|
||||
|
||||
internal function to map CacheID to a tr class(color)
|
||||
|
||||
|
||||
|
||||
@ -61,15 +61,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cacheID **mixed**
|
||||
* $cacheID **integer** - <p>Id of the Cache</p>
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
@ -82,11 +83,11 @@ Methods
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -97,11 +98,11 @@ Methods
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -112,9 +113,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cache::js()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_cache::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
@ -126,24 +127,39 @@ Methods
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -152,52 +168,49 @@ Methods
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -207,30 +220,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -243,9 +241,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -255,16 +253,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -274,16 +272,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -293,16 +291,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -312,15 +310,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -330,15 +328,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -348,15 +346,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -366,16 +364,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -385,16 +383,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -404,17 +402,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -427,9 +425,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -442,9 +440,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -454,15 +452,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -472,9 +470,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\saimod_sys_config
|
||||
===============
|
||||
|
||||
|
||||
saimod_sys_config Class provided by System as saimod to display the config
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_config
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_config_action_basics
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_basics()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_basics()
|
||||
|
||||
Generate HTML for Menu Basics
|
||||
|
||||
|
||||
|
||||
@ -50,9 +50,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_config_action_database
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_database()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_database()
|
||||
|
||||
Generate HTML for Menu Database
|
||||
|
||||
|
||||
|
||||
@ -64,9 +64,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_config_action_sai
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_sai()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_sai()
|
||||
|
||||
Generate HTML for Menu SAI
|
||||
|
||||
|
||||
|
||||
@ -78,9 +78,10 @@ Methods
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
@ -93,11 +94,11 @@ Methods
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -108,11 +109,11 @@ Methods
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -123,9 +124,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_config::js()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_config::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
@ -137,24 +138,39 @@ Methods
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -163,52 +179,49 @@ Methods
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -218,30 +231,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -254,9 +252,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -266,16 +264,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -285,16 +283,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -304,16 +302,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -323,15 +321,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -341,15 +339,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -359,15 +357,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -377,16 +375,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -396,16 +394,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -415,17 +413,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -438,9 +436,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -453,9 +451,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -465,15 +463,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -483,9 +481,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\saimod_sys_cron
|
||||
===============
|
||||
|
||||
|
||||
saimod_sys_cron Class provided by System as saimod to manage the system_cron table
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_cron
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cron::sai_mod__SYSTEM_SAI_saimod_sys_cron()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_cron::sai_mod__SYSTEM_SAI_saimod_sys_cron()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_cron_action_change
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_change($cls, $status)
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_change(string $cls, integer $status)
|
||||
|
||||
Change Status of a Cron Entry
|
||||
|
||||
|
||||
|
||||
@ -47,16 +47,33 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cls **mixed**
|
||||
* $status **mixed**
|
||||
* $cls **string** - <p>Classname of the Cron</p>
|
||||
* $status **integer** - <p>New Status</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_cron_action_run
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_run(string $cls)
|
||||
|
||||
Run a specifc Cron Job
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cls **string** - <p>Classname of the Cron</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_cron_action_add
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_add($cls, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_add(string $cls, integer $min, integer $hour, integer $day, integer $day_week, integer $month)
|
||||
|
||||
Add a new Cron Entry
|
||||
|
||||
|
||||
|
||||
@ -65,20 +82,20 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cls **mixed**
|
||||
* $min **mixed**
|
||||
* $hour **mixed**
|
||||
* $day **mixed**
|
||||
* $day_week **mixed**
|
||||
* $month **mixed**
|
||||
* $cls **string** - <p>Classname of the Cron</p>
|
||||
* $min **integer** - <p>Minute Value</p>
|
||||
* $hour **integer** - <p>Hour Value</p>
|
||||
* $day **integer** - <p>Day Value</p>
|
||||
* $day_week **integer** - <p>Day of the Week Value</p>
|
||||
* $month **integer** - <p>Month Value</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_cron_action_del
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_del($cls)
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_del(string $cls)
|
||||
|
||||
Delete a Cron Entry
|
||||
|
||||
|
||||
|
||||
@ -87,15 +104,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cls **mixed**
|
||||
* $cls **string** - <p>Classname of the Cron</p>
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
@ -108,11 +126,11 @@ Methods
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -123,11 +141,11 @@ Methods
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -138,9 +156,9 @@ Methods
|
||||
|
||||
### css
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cron::css()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_cron::css()
|
||||
|
||||
Get all css System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
@ -152,9 +170,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_cron::js()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_cron::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
@ -166,24 +184,39 @@ Methods
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -192,52 +225,49 @@ Methods
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -247,30 +277,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -283,9 +298,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -295,16 +310,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -314,16 +329,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -333,16 +348,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -352,15 +367,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -370,15 +385,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -388,15 +403,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -406,16 +421,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -425,16 +440,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -444,17 +459,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -467,9 +482,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -482,9 +497,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -494,15 +509,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -512,9 +527,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\saimod_sys_docu
|
||||
===============
|
||||
|
||||
|
||||
saimod_sys_docu Class provided by System as saimod to display the code documentation
|
||||
|
||||
|
||||
|
||||
@ -22,37 +22,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_docu
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_docu_action_cat
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu_action_cat($cat)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu(string $cat)
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
|
||||
@ -61,15 +33,44 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $cat **string** - <p>Docu selected</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate()
|
||||
|
||||
Generate the HTML Documentation
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate_md
|
||||
|
||||
null SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate_md()
|
||||
|
||||
Generate the MD Documentation based on the HTML Documentation
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
@ -82,11 +83,11 @@ Methods
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -97,11 +98,11 @@ Methods
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -112,9 +113,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_docu::js()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_docu::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
@ -126,24 +127,39 @@ Methods
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -152,52 +168,49 @@ Methods
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -207,30 +220,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -243,9 +241,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -255,16 +253,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -274,16 +272,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -293,16 +291,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -312,15 +310,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -330,15 +328,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -348,15 +346,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -366,16 +364,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -385,16 +383,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -404,17 +402,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -427,9 +425,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -442,9 +440,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -454,15 +452,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -472,9 +470,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\saimod_sys_files
|
||||
===============
|
||||
|
||||
|
||||
saimod_sys_files Class provided by System as saimod to manage files (files feature)
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files_action_del
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_del($cat, $id)
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_del(string $cat, string $id)
|
||||
|
||||
Delete a File in a Files Directory
|
||||
|
||||
|
||||
|
||||
@ -33,16 +33,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>Name of the Files Directory</p>
|
||||
* $id **string** - <p>Name of the File</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files_action_rn
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_rn($cat, $id, $newid)
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_rn(string $cat, string $id, string $newid)
|
||||
|
||||
Rename a File in a Files Directory
|
||||
|
||||
|
||||
|
||||
@ -51,17 +51,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $newid **mixed**
|
||||
* $cat **string** - <p>Name of the Files Directory</p>
|
||||
* $id **string** - <p>Name of the File</p>
|
||||
* $newid **string** - <p>New Name of the File</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files_action_upload
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_upload($cat)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_upload(string $cat)
|
||||
|
||||
Uploadcall to a Files Directory. Expects a File been uploaded.
|
||||
|
||||
|
||||
|
||||
@ -70,15 +70,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $cat **string** - <p>Name of the Files Directory</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
|
||||
@ -90,9 +90,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files_action_tab
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_tab($name)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_tab(string $name)
|
||||
|
||||
Generate the HTML for the one Files Directory
|
||||
|
||||
|
||||
|
||||
@ -101,15 +101,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $name **mixed**
|
||||
* $name **string** - <p>Name of the Files Directory</p>
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
@ -122,11 +123,11 @@ Methods
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -137,11 +138,11 @@ Methods
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -152,9 +153,9 @@ Methods
|
||||
|
||||
### js
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_files::js()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_files::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
@ -166,24 +167,39 @@ Methods
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -192,52 +208,49 @@ Methods
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -247,30 +260,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -283,9 +281,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -295,16 +293,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -314,16 +312,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -333,16 +331,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -352,15 +350,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -370,15 +368,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -388,15 +386,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -406,16 +404,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -425,16 +423,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -444,17 +442,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -467,9 +465,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -482,9 +480,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -494,15 +492,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -512,9 +510,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
SYSTEM\SAI\saimod_sys_git
|
||||
===============
|
||||
|
||||
|
||||
saimod_sys_git Class provided by System as saimod to display git information on the project and system
|
||||
|
||||
|
||||
|
||||
@ -22,9 +22,9 @@ Methods
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_git
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_git::sai_mod__SYSTEM_SAI_saimod_sys_git()
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_git::sai_mod__SYSTEM_SAI_saimod_sys_git()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
|
||||
@ -36,9 +36,9 @@ Methods
|
||||
|
||||
### getGitInfo
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_git::getGitInfo()
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_git::getGitInfo()
|
||||
|
||||
Read Git Information
|
||||
|
||||
|
||||
|
||||
@ -48,28 +48,12 @@ Methods
|
||||
|
||||
|
||||
|
||||
### tablerow_class
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_git::tablerow_class($cacheID)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cacheID **mixed**
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
@ -82,11 +66,11 @@ Methods
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -97,11 +81,11 @@ Methods
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
@ -112,24 +96,39 @@ Methods
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
|
||||
API Group function - implement this function and return the Groupnumber
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
@ -138,52 +137,49 @@ Methods
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_)
|
||||
|
||||
API Default Page function - implement this function and return the Default Page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
@ -193,30 +189,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
@ -229,9 +210,9 @@ Methods
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
@ -241,16 +222,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
@ -260,16 +241,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
@ -279,16 +260,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -298,15 +279,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
@ -316,15 +297,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
@ -334,15 +315,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
@ -352,16 +333,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
@ -371,16 +352,16 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
|
||||
@ -390,17 +371,17 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
@ -413,9 +394,9 @@ Methods
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
@ -428,9 +409,9 @@ Methods
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
@ -440,15 +421,15 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale)
|
||||
|
||||
System Account Create
|
||||
|
||||
|
||||
|
||||
@ -458,9 +439,97 @@ Methods
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
* $username **string** - <p>Username</p>
|
||||
* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p>
|
||||
* $email **SYSTEM\API\email** - <p>Email of the new User</p>
|
||||
* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email()
|
||||
|
||||
System Account Request Confirm EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_confirm
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token)
|
||||
|
||||
System Account Confirm Tokens
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $token **string** - <p>Token to do specifics with your Account</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_reset_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username)
|
||||
|
||||
System Account Request Reset Password Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **string** - <p>Username</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_password
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1)
|
||||
|
||||
System Account Change Password
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p>
|
||||
* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_change_email
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email)
|
||||
|
||||
System Account Request Change EMail Token
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $new_email **string** - <p>Users new EMail Address</p>
|
||||
|
||||
|
||||
|
||||
@ -1,438 +0,0 @@
|
||||
SYSTEM\SAI\saimod_sys_langswitcher
|
||||
===============
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_langswitcher
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
### right_public
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
### right_right
|
||||
|
||||
mixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
### lang_menu
|
||||
|
||||
mixed SYSTEM\SAI\saimod_sys_langswitcher::lang_menu($endpoint)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $endpoint **mixed**
|
||||
|
||||
|
||||
|
||||
### get_apigroup
|
||||
|
||||
mixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
mixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
mixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **mixed**
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
|
||||
mixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **mixed**
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
mixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
mixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed**
|
||||
* $lang **mixed**
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **mixed**
|
||||
* $id **mixed**
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **mixed**
|
||||
* $state **mixed**
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
mixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **mixed**
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
mixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **mixed**
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed**
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
mixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **mixed**
|
||||
* $data **mixed**
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **mixed**
|
||||
* $ident **mixed**
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $password_md5 **mixed**
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **mixed**
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $username **mixed**
|
||||
* $password_sha **mixed**
|
||||
* $email **mixed**
|
||||
* $locale **mixed**
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user