new version
parent
66ca23259d
commit
a80cf8c554
GPG Key ID:
DA6B843E748679C9
47
ApiIndex.md
47
ApiIndex.md
@ -1,7 +1,5 @@
|
||||
API Index
|
||||
=========
|
||||
|
||||
* SYSTEM
|
||||
=========* SYSTEM
|
||||
* SYSTEM\DB
|
||||
* [Result](SYSTEM-DB-Result)
|
||||
* [ConnectionPG](SYSTEM-DB-ConnectionPG)
|
||||
@ -25,9 +23,7 @@ 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)
|
||||
@ -36,6 +32,8 @@ 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,21 +48,20 @@ 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)
|
||||
* [DATA_SYSTEM_API](SYSTEM-SQL-DATA_SYSTEM_API)
|
||||
* [SYS_SECURITY_LOGIN_SHA1](SYSTEM-SQL-SYS_SECURITY_LOGIN_SHA1)
|
||||
* [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)
|
||||
@ -73,6 +70,7 @@ 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,7 +78,6 @@ 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)
|
||||
@ -96,7 +93,6 @@ 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)
|
||||
@ -104,7 +100,6 @@ 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)
|
||||
@ -112,7 +107,6 @@ 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)
|
||||
@ -136,34 +130,27 @@ 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)
|
||||
@ -178,7 +165,6 @@ 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
|
||||
@ -205,11 +191,12 @@ 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
|
||||
@ -217,12 +204,9 @@ 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)
|
||||
@ -233,6 +217,7 @@ 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)
|
||||
@ -241,17 +226,10 @@ 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)
|
||||
@ -287,6 +265,7 @@ 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,64 +1,21 @@
|
||||
DEPRECATED
|
||||
===============
|
||||
|
||||
Deprecated Log Class provided by System for marking code as Deprecated.
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: DEPRECATED
|
||||
* Namespace:
|
||||
* Parent class: [SYSTEM\LOG\DEPRECATED](SYSTEM-LOG-DEPRECATED)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:DEPRECATED
|
||||
* Namespace:* Parent class:[SYSTEM\LOG\DEPRECATED](SYSTEM-LOG-DEPRECATED)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
57
ERROR.md
57
ERROR.md
@ -1,64 +1,21 @@
|
||||
ERROR
|
||||
===============
|
||||
|
||||
Error Log Class provided by System for all kinds of Errors.
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: ERROR
|
||||
* Namespace:
|
||||
* Parent class: [SYSTEM\LOG\ERROR](SYSTEM-LOG-ERROR)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ERROR
|
||||
* Namespace:* Parent class:[SYSTEM\LOG\ERROR](SYSTEM-LOG-ERROR)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
57
INFO.md
57
INFO.md
@ -1,64 +1,21 @@
|
||||
INFO
|
||||
===============
|
||||
|
||||
Info Log Class provided by System for logging Infos.
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: INFO
|
||||
* Namespace:
|
||||
* Parent class: [SYSTEM\LOG\INFO](SYSTEM-LOG-INFO)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:INFO
|
||||
* Namespace:* Parent class:[SYSTEM\LOG\INFO](SYSTEM-LOG-INFO)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,89 +1,28 @@
|
||||
JsonResult
|
||||
===============
|
||||
|
||||
JsonResult Class provided by System to return Data as JSON or MSGPACK.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: JsonResult
|
||||
* Namespace:
|
||||
* Parent class: [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:JsonResult
|
||||
* Namespace:* Parent class:[SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)Constants
|
||||
----------
|
||||
###JSONRESULT_OKconst JSONRESULT_OK = true
|
||||
###JSONRESULT_ERRORconst JSONRESULT_ERROR = falseMethods
|
||||
-------
|
||||
|
||||
|
||||
### toString
|
||||
|
||||
string SYSTEM\LOG\JsonResult::toString(array $json_array, boolean $status, integer $start_time)
|
||||
|
||||
Retun JsonResult with data given by array
|
||||
###toStringmixed SYSTEM\LOG\AbstractResult::toString($json_array, $status, $start_time)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* 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**
|
||||
###errormixed SYSTEM\LOG\AbstractResult::error(\Exception $e)
|
||||
|
||||
|
||||
|
||||
### error
|
||||
|
||||
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**
|
||||
###okmixed SYSTEM\LOG\AbstractResult::ok()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $e **Exception** - <p>Exception to be convered.</p>
|
||||
|
||||
|
||||
|
||||
### ok
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
###failmixed SYSTEM\LOG\JsonResult::fail()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult)
|
||||
72
LIB-lib.md
72
LIB-lib.md
@ -1,77 +1,25 @@
|
||||
LIB\lib
|
||||
===============
|
||||
|
||||
Lib Class provided by System to define API to load libs.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: lib
|
||||
* Namespace: LIB
|
||||
* This is an **abstract** class
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:lib
|
||||
* Namespace:LIB* This is an **abstract** classMethods
|
||||
-------
|
||||
|
||||
|
||||
### php
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
###phpmixed LIB\lib::php()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###cssmixed LIB\lib::css()
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###jsmixed LIB\lib::js()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### version
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###versionmixed LIB\lib::version()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
@ -1,82 +1,26 @@
|
||||
LIB\lib_controll
|
||||
===============
|
||||
|
||||
lib_controll Class provided by System to register libs.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: lib_controll
|
||||
* Namespace: LIB
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:lib_controll
|
||||
* Namespace:LIBProperties
|
||||
----------
|
||||
|
||||
|
||||
### $libs
|
||||
|
||||
private mixed $libs = array()
|
||||
|
||||
array Variable to store all registred libs
|
||||
###$libsprivate mixed $libs = array()
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This property is **static**.
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private*** This property is **static**.Methods
|
||||
-------
|
||||
|
||||
|
||||
### check_lib
|
||||
|
||||
boolean LIB\lib_controll::check_lib(string $lib)
|
||||
|
||||
Check if given class is a valid lib
|
||||
###check_libmixed LIB\lib_controll::check_lib($lib)
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lib **string** - <p>Lib Class</p>
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$lib **mixed**
|
||||
###registermixed LIB\lib_controll::register($classname)
|
||||
|
||||
|
||||
|
||||
### register
|
||||
|
||||
null LIB\lib_controll::register(string $classname)
|
||||
|
||||
Register given class as lib
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $classname **string** - <p>Lib Class</p>
|
||||
|
||||
|
||||
|
||||
### all
|
||||
|
||||
array LIB\lib_controll::all()
|
||||
|
||||
Get all registered libs available
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$classname **mixed**
|
||||
###allmixed LIB\lib_controll::all()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
@ -1,96 +1,30 @@
|
||||
LIB\lib_css
|
||||
===============
|
||||
|
||||
css lib Class provided by System to provide css libs.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: lib_css
|
||||
* Namespace: LIB
|
||||
* This is an **abstract** class
|
||||
* Parent class: [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:lib_css
|
||||
* Namespace:LIB* This is an **abstract** class* Parent class:[LIB\lib](LIB-lib)Methods
|
||||
-------
|
||||
|
||||
|
||||
### css_path
|
||||
|
||||
string LIB\lib_css::css_path()
|
||||
|
||||
Get Css lib include path
|
||||
###css_pathmixed LIB\lib_css::css_path()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* Visibility: **protected*** This method is **static**.
|
||||
###phpmixed LIB\lib::php()
|
||||
|
||||
|
||||
|
||||
|
||||
### php
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###cssmixed LIB\lib::css()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###jsmixed LIB\lib::js()
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### version
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###versionmixed LIB\lib::version()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
@ -1,96 +1,30 @@
|
||||
LIB\lib_js
|
||||
===============
|
||||
|
||||
js lib Class provided by System to provide js libs.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: lib_js
|
||||
* Namespace: LIB
|
||||
* This is an **abstract** class
|
||||
* Parent class: [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:lib_js
|
||||
* Namespace:LIB* This is an **abstract** class* Parent class:[LIB\lib](LIB-lib)Methods
|
||||
-------
|
||||
|
||||
|
||||
### js_path
|
||||
|
||||
string LIB\lib_js::js_path()
|
||||
|
||||
Get js lib include path
|
||||
###js_pathmixed LIB\lib_js::js_path()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* Visibility: **protected*** This method is **static**.
|
||||
###phpmixed LIB\lib::php()
|
||||
|
||||
|
||||
|
||||
|
||||
### php
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###cssmixed LIB\lib::css()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###jsmixed LIB\lib::js()
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### version
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###versionmixed LIB\lib::version()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
103
LIB-lib_jscss.md
103
LIB-lib_jscss.md
@ -1,110 +1,35 @@
|
||||
LIB\lib_jscss
|
||||
===============
|
||||
|
||||
js+css lib Class provided by System to provide js+css libs.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: lib_jscss
|
||||
* Namespace: LIB
|
||||
* This is an **abstract** class
|
||||
* Parent class: [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:lib_jscss
|
||||
* Namespace:LIB* This is an **abstract** class* Parent class:[LIB\lib](LIB-lib)Methods
|
||||
-------
|
||||
|
||||
|
||||
### js_path
|
||||
|
||||
string LIB\lib_jscss::js_path()
|
||||
|
||||
Get js lib include path
|
||||
###js_pathmixed LIB\lib_jscss::js_path()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* Visibility: **protected*** This method is **static**.
|
||||
###css_pathmixed LIB\lib_jscss::css_path()
|
||||
|
||||
|
||||
|
||||
|
||||
### css_path
|
||||
|
||||
string LIB\lib_jscss::css_path()
|
||||
|
||||
Get Css lib include path
|
||||
* Visibility: **protected*** This method is **static**.
|
||||
###phpmixed LIB\lib::php()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###cssmixed LIB\lib::css()
|
||||
|
||||
|
||||
|
||||
|
||||
### php
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###jsmixed LIB\lib::js()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### version
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###versionmixed LIB\lib::version()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
@ -1,96 +1,30 @@
|
||||
LIB\lib_php
|
||||
===============
|
||||
|
||||
php lib Class provided by System to provide php libs.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: lib_php
|
||||
* Namespace: LIB
|
||||
* This is an **abstract** class
|
||||
* Parent class: [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:lib_php
|
||||
* Namespace:LIB* This is an **abstract** class* Parent class:[LIB\lib](LIB-lib)Methods
|
||||
-------
|
||||
|
||||
|
||||
### php_autoload
|
||||
|
||||
null LIB\lib_php::php_autoload()
|
||||
|
||||
include the php files to be used
|
||||
###php_autoloadmixed LIB\lib_php::php_autoload()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* Visibility: **protected*** This method is **static**.
|
||||
###phpmixed LIB\lib::php()
|
||||
|
||||
|
||||
|
||||
|
||||
### php
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###cssmixed LIB\lib::css()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###jsmixed LIB\lib::js()
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### version
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###versionmixed LIB\lib::version()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
@ -1,125 +1,40 @@
|
||||
LIB\lib_system
|
||||
===============
|
||||
|
||||
lib_system Class provided by System to serve system.js and system.css library.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: lib_system
|
||||
* Namespace: LIB
|
||||
* Parent class: [LIB\lib_jscss](LIB-lib_jscss)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:lib_system
|
||||
* Namespace:LIB* Parent class:[LIB\lib_jscss](LIB-lib_jscss)Methods
|
||||
-------
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string LIB\lib_system::get_class()
|
||||
|
||||
Get Classname of the Library
|
||||
###get_classmixed LIB\lib_system::get_class()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###js_pathmixed LIB\lib_jscss::js_path()
|
||||
|
||||
|
||||
|
||||
|
||||
### js_path
|
||||
|
||||
string LIB\lib_jscss::js_path()
|
||||
|
||||
Get js lib include path
|
||||
* Visibility: **protected*** This method is **static**.* This method is defined by[LIB\lib_jscss](LIB-lib_jscss)
|
||||
###css_pathmixed LIB\lib_jscss::css_path()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib_jscss](LIB-lib_jscss)
|
||||
* Visibility: **protected*** This method is **static**.* This method is defined by[LIB\lib_jscss](LIB-lib_jscss)
|
||||
###versionmixed LIB\lib::version()
|
||||
|
||||
|
||||
|
||||
|
||||
### css_path
|
||||
|
||||
string LIB\lib_jscss::css_path()
|
||||
|
||||
Get Css lib include path
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###phpmixed LIB\lib::php()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib_jscss](LIB-lib_jscss)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###cssmixed LIB\lib::css()
|
||||
|
||||
|
||||
|
||||
|
||||
### version
|
||||
|
||||
string LIB\lib::version()
|
||||
|
||||
Default Version for every lib if not overritten by derived class
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### php
|
||||
|
||||
boolean LIB\lib::php()
|
||||
|
||||
Call php lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
string LIB\lib::css()
|
||||
|
||||
Call css lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
string LIB\lib::js()
|
||||
|
||||
Call js lib include
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [LIB\lib](LIB-lib)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###jsmixed LIB\lib::js()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
35
LIB-lib_textillate.md
Normal file
35
LIB-lib_textillate.md
Normal file
@ -0,0 +1,35 @@
|
||||
LIB\lib_textillate
|
||||
===============
|
||||
* Class name:lib_textillate
|
||||
* Namespace:LIB* Parent class:[LIB\lib_js](LIB-lib_js)Methods
|
||||
-------
|
||||
###get_classmixed LIB\lib_textillate::get_class()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###js_pathmixed LIB\lib_js::js_path()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected*** This method is **static**.* This method is defined by[LIB\lib_js](LIB-lib_js)
|
||||
###versionmixed LIB\lib::version()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###phpmixed LIB\lib::php()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###cssmixed LIB\lib::css()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
###jsmixed LIB\lib::js()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[LIB\lib](LIB-lib)
|
||||
@ -1,250 +1,60 @@
|
||||
SYSTEM\API\api
|
||||
===============
|
||||
|
||||
API Class provided by System for Smart API's.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: api
|
||||
* Namespace: SYSTEM\API
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:api
|
||||
* Namespace:SYSTEM\APIConstants
|
||||
----------
|
||||
|
||||
|
||||
### ROOT_PARENTID
|
||||
|
||||
const ROOT_PARENTID = -1
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### DEFAULT_GROUP
|
||||
|
||||
const DEFAULT_GROUP = 0
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### DEFAULT_STRICT
|
||||
|
||||
const DEFAULT_STRICT = true
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### DEFAULT_DEFAULT
|
||||
|
||||
const DEFAULT_DEFAULT = false
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
###ROOT_PARENTIDconst ROOT_PARENTID = -1
|
||||
###DEFAULT_GROUPconst DEFAULT_GROUP = 0
|
||||
###DEFAULT_STRICTconst DEFAULT_STRICT = true
|
||||
###DEFAULT_DEFAULTconst DEFAULT_DEFAULT = falseMethods
|
||||
-------
|
||||
###runmixed SYSTEM\API\api::run($verifyclassname, $apiclassname, $params, $group, $strict, $default)
|
||||
|
||||
|
||||
### run
|
||||
|
||||
mixed SYSTEM\API\api::run(string $verifyclassname, string $apiclassname, array $params, integer $group, boolean $strict, boolean $default)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$verifyclassname **mixed***$apiclassname **mixed***$params **mixed***$group **mixed***$strict **mixed***$default **mixed**
|
||||
###getApiTreemixed SYSTEM\API\api::getApiTree($group)
|
||||
|
||||
Run the API Mechanism with your Data.
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$group **mixed**
|
||||
###do_staticsmixed SYSTEM\API\api::do_statics($params, $tree, $apiclassname, $verifyclassname, $default)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$params **mixed***$tree **mixed***$apiclassname **mixed***$verifyclassname **mixed***$default **mixed**
|
||||
###do_defaultmixed SYSTEM\API\api::do_default($default, $apiclassname, $call_funcname)
|
||||
|
||||
|
||||
|
||||
### getApiTree
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$default **mixed***$apiclassname **mixed***$call_funcname **mixed**
|
||||
###do_strictmixed SYSTEM\API\api::do_strict($strict, $params, $statics, $commands, $parameters, $parameters_opt)
|
||||
|
||||
array SYSTEM\API\api::getApiTree(integer $group)
|
||||
|
||||
Internal API function to retrive the Databasetree for requested API
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$strict **mixed***$params **mixed***$statics **mixed***$commands **mixed***$parameters **mixed***$parameters_opt **mixed**
|
||||
###do_commandsmixed SYSTEM\API\api::do_commands($params, $tree)
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$params **mixed***$tree **mixed**
|
||||
###do_parametersmixed SYSTEM\API\api::do_parameters($params, $tree, $parentid, $lastcommandvalue, $verifyclassname)
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>API Group to be read</p>
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$params **mixed***$tree **mixed***$parentid **mixed***$lastcommandvalue **mixed***$verifyclassname **mixed**
|
||||
###do_parameters_optmixed SYSTEM\API\api::do_parameters_opt($params, $tree, $parentid, $lastcommandvalue, $verifyclassname)
|
||||
|
||||
### do_statics
|
||||
|
||||
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
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$params **mixed***$tree **mixed***$parentid **mixed***$lastcommandvalue **mixed***$verifyclassname **mixed**
|
||||
###do_func_namemixed SYSTEM\API\api::do_func_name($commands)
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$commands **mixed**
|
||||
###do_func_paramsmixed SYSTEM\API\api::do_func_params($parameters, $parameters_opt)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
array SYSTEM\API\api::do_default(boolean $default, string $apiclassname, string $call_funcname)
|
||||
|
||||
Internal API function to parse default redirect for requested API
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
array SYSTEM\API\api::do_commands(array $params, array $tree)
|
||||
|
||||
Internal API function to parse commands for requested API
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Parameters given to the API</p>
|
||||
* $tree **array** - <p>Array with API rules</p>
|
||||
|
||||
|
||||
|
||||
### do_parameters
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
string SYSTEM\API\api::do_func_name(array $commands)
|
||||
|
||||
Internal API function to build function name for requested API
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $commands **array** - <p>Array of all Commands for the given API call</p>
|
||||
|
||||
|
||||
|
||||
### do_func_params
|
||||
|
||||
array SYSTEM\API\api::do_func_params(array $parameters, array $parameters_opt)
|
||||
|
||||
Internal API function to build function paramters for requested API
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$parameters **mixed***$parameters_opt **mixed**
|
||||
@ -1,442 +1,105 @@
|
||||
SYSTEM\API\api_default
|
||||
===============
|
||||
|
||||
API Default class providing defaulting capabilities and Hashbang-Crawling-Scheme.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: 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)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:api_default
|
||||
* Namespace:SYSTEM\API* This is an **abstract** class* Parent class:[SYSTEM\API\api_system](SYSTEM-API-api_system)Methods
|
||||
-------
|
||||
###static__escaped_fragment_mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$_escaped_fragment_ **mixed**
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$params **mixed**
|
||||
###get_default_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$_escaped_fragment_ **mixed**
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
* 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_filesmixed 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)
|
||||
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
* 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed 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)
|
||||
|
||||
* 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__($_)
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
### call_files
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
* 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_cachemixed 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)
|
||||
* 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_loginmixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,187 +1,30 @@
|
||||
SYSTEM\API\api_login
|
||||
===============
|
||||
|
||||
API Login class providing System Account Functionality.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: api_login
|
||||
* Namespace: SYSTEM\API
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:api_login
|
||||
* Namespace:SYSTEM\APIMethods
|
||||
-------
|
||||
###call_account_action_loginmixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$username **mixed***$password_sha **mixed***$password_md5 **mixed**
|
||||
###call_account_action_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Login
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
|
||||
### call_account_action_logout
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$rightid **mixed**
|
||||
###call_account_action_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$username **mixed***$password_sha **mixed***$email **mixed***$locale **mixed**
|
||||
@ -1,353 +1,75 @@
|
||||
SYSTEM\API\api_system
|
||||
===============
|
||||
|
||||
API System class providing System Functionality.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: api_system
|
||||
* Namespace: SYSTEM\API
|
||||
* Parent class: [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:api_system
|
||||
* Namespace:SYSTEM\API* Parent class:[SYSTEM\API\api_login](SYSTEM-API-api_login)Methods
|
||||
-------
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$request **mixed***$lang **mixed**
|
||||
###call_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed***$id **mixed**
|
||||
###call_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$group **mixed***$state **mixed**
|
||||
###static__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $request **mixed** - <p>Request String for Text API</p>
|
||||
* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$result **mixed**
|
||||
###static__mixed SYSTEM\API\api_system::static__($_)
|
||||
|
||||
|
||||
|
||||
### call_files
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
mixed SYSTEM\API\api_system::call_files(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$message **mixed***$data **mixed**
|
||||
###call_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id **mixed***$ident **mixed**
|
||||
###call_account_action_loginmixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,258 +1,70 @@
|
||||
SYSTEM\API\verify
|
||||
===============
|
||||
|
||||
API default verify Class for Parameter validation
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: verify
|
||||
* Namespace: SYSTEM\API
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:verify
|
||||
* Namespace:SYSTEM\APIMethods
|
||||
-------
|
||||
###ALLmixed SYSTEM\API\verify::ALL($param)
|
||||
|
||||
|
||||
### ALL
|
||||
|
||||
boolean SYSTEM\API\verify::ALL(mixed $param)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###UINTmixed SYSTEM\API\verify::UINT($param)
|
||||
|
||||
Verify All - everything is allowed
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###UINT0mixed SYSTEM\API\verify::UINT0($param)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###INTmixed SYSTEM\API\verify::INT($param)
|
||||
|
||||
|
||||
|
||||
### UINT
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###TIMEUNIXmixed SYSTEM\API\verify::TIMEUNIX($param)
|
||||
|
||||
boolean SYSTEM\API\verify::UINT(mixed $param)
|
||||
|
||||
Verify UINT - Positive Integer excluding 0
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###DATEmixed SYSTEM\API\verify::DATE($param)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###STRINGmixed SYSTEM\API\verify::STRING($param)
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###BOOLmixed SYSTEM\API\verify::BOOL($param)
|
||||
|
||||
### UINT0
|
||||
|
||||
boolean SYSTEM\API\verify::UINT0(mixed $param)
|
||||
|
||||
Verify UINT0 - Positive Integer including 0
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###FLOATmixed SYSTEM\API\verify::FLOAT($param)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###JSONmixed SYSTEM\API\verify::JSON($param)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###ARYmixed SYSTEM\API\verify::ARY($param)
|
||||
|
||||
|
||||
### INT
|
||||
|
||||
boolean SYSTEM\API\verify::INT(mixed $param)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###LANGmixed SYSTEM\API\verify::LANG($param)
|
||||
|
||||
Verify INT - all integers
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
###RESULTmixed SYSTEM\API\verify::RESULT($param)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### TIMEUNIX
|
||||
|
||||
boolean SYSTEM\API\verify::TIMEUNIX(mixed $param)
|
||||
|
||||
Verify TIMEUNIX - unixtimestamp number
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### DATE
|
||||
|
||||
boolean SYSTEM\API\verify::DATE(mixed $param)
|
||||
|
||||
Verify DATE - string parseable as date
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### STRING
|
||||
|
||||
boolean SYSTEM\API\verify::STRING(mixed $param)
|
||||
|
||||
Verify STRING - allow every string - thats all
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### BOOL
|
||||
|
||||
boolean SYSTEM\API\verify::BOOL(mixed $param)
|
||||
|
||||
Verify BOOL - allow booleans
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### FLOAT
|
||||
|
||||
boolean SYSTEM\API\verify::FLOAT(mixed $param)
|
||||
|
||||
Verify FLOAT - every float value
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### JSON
|
||||
|
||||
boolean SYSTEM\API\verify::JSON(mixed $param)
|
||||
|
||||
Verify JSON - JSON format check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### ARY
|
||||
|
||||
boolean SYSTEM\API\verify::ARY(mixed $param)
|
||||
|
||||
Verify ARY - array check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### LANG
|
||||
|
||||
boolean SYSTEM\API\verify::LANG(mixed $param)
|
||||
|
||||
Verify LANG - verify supported languages
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $param **mixed** - <p>Input Paramter</p>
|
||||
|
||||
|
||||
|
||||
### RESULT
|
||||
|
||||
boolean SYSTEM\API\verify::RESULT(mixed $param)
|
||||
|
||||
Verify RESULT - verify possible resulttypes
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$param **mixed**
|
||||
@ -1,78 +1,20 @@
|
||||
SYSTEM\CACHE\cache
|
||||
===============
|
||||
|
||||
Cache Class provided by System for caching in the Database.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cache
|
||||
* Namespace: SYSTEM\CACHE
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:cache
|
||||
* Namespace:SYSTEM\CACHEMethods
|
||||
-------
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache::get(integer $cache, \SYSTEM\CACHE\sha1 $ident, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
###getmixed SYSTEM\CACHE\cache::get($cache, $ident, $header)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cache **mixed***$ident **mixed***$header **mixed**
|
||||
###putmixed SYSTEM\CACHE\cache::put($cache, $ident, $type, $data, $fail_on_exist)
|
||||
|
||||
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache::put(integer $cache, \SYSTEM\CACHE\sha1 $ident, string $type, string $data, boolean $fail_on_exist)
|
||||
|
||||
Put Data into the Cache
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cache **mixed***$ident **mixed***$type **mixed***$data **mixed***$fail_on_exist **mixed**
|
||||
###delmixed SYSTEM\CACHE\cache::del($cache, $ident)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
boolean SYSTEM\CACHE\cache::del(integer $cache, \SYSTEM\CACHE\sha1 $ident)
|
||||
|
||||
Delete Data from Cache
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cache **integer** - <p>Cache Group to delete Data from</p>
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the Content</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cache **mixed***$ident **mixed**
|
||||
@ -1,100 +1,27 @@
|
||||
SYSTEM\CACHE\cache_css
|
||||
===============
|
||||
|
||||
CSS Cache Class provided by System for caching CSS in the Database.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cache_css
|
||||
* Namespace: SYSTEM\CACHE
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:cache_css
|
||||
* Namespace:SYSTEM\CACHEConstants
|
||||
----------
|
||||
|
||||
|
||||
### CACHE_CSS
|
||||
|
||||
const CACHE_CSS = 10
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
###CACHE_CSSconst CACHE_CSS = 10Methods
|
||||
-------
|
||||
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache_css::put(\SYSTEM\CACHE\sha1 $ident, integer $data)
|
||||
|
||||
Put Data into the Cache
|
||||
###putmixed SYSTEM\CACHE\cache_css::put($ident, $data)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $data **integer** - <p>Data to cache</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ident **mixed***$data **mixed**
|
||||
###getmixed SYSTEM\CACHE\cache_css::get($ident, $header)
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache_css::get(\SYSTEM\CACHE\sha1 $ident, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ident **mixed***$header **mixed**
|
||||
###identmixed SYSTEM\CACHE\cache_css::ident($files)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$files **mixed**
|
||||
###urlmixed SYSTEM\CACHE\cache_css::url($files)
|
||||
|
||||
|
||||
|
||||
### ident
|
||||
|
||||
\SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_css::ident(array $files)
|
||||
|
||||
Calculate Ident for a list of Files
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $files **array** - <p>List of Files to be cached into one Cacheentry</p>
|
||||
|
||||
|
||||
|
||||
### minify
|
||||
|
||||
\SYSTEM\CACHE\url SYSTEM\CACHE\cache_css::minify(array $files)
|
||||
|
||||
Minify CSS and calculate URL from it
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $files **array** - <p>List of Files to be cached into one Cacheentry</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$files **mixed**
|
||||
@ -1,83 +1,22 @@
|
||||
SYSTEM\CACHE\cache_filemask
|
||||
===============
|
||||
|
||||
File Cache Class provided by System for hiding Filepaths on the Server.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cache_filemask
|
||||
* Namespace: SYSTEM\CACHE
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:cache_filemask
|
||||
* Namespace:SYSTEM\CACHEConstants
|
||||
----------
|
||||
|
||||
|
||||
### CACHE_FILEMASK
|
||||
|
||||
const CACHE_FILEMASK = 12
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
###CACHE_FILEMASKconst CACHE_FILEMASK = 12Methods
|
||||
-------
|
||||
|
||||
|
||||
### put
|
||||
|
||||
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
|
||||
###putmixed SYSTEM\CACHE\cache_filemask::put($file)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **SYSTEM\CACHE\sha1** - <p>String Filepath of Content</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$file **mixed**
|
||||
###getmixed SYSTEM\CACHE\cache_filemask::get($ident, $header)
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache_filemask::get(\SYSTEM\CACHE\sha1 $ident, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ident **mixed***$header **mixed**
|
||||
###identmixed SYSTEM\CACHE\cache_filemask::ident($file)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
|
||||
|
||||
|
||||
### ident
|
||||
|
||||
\SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_filemask::ident(array $file)
|
||||
|
||||
Calculate Ident for a File
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **array** - <p>Filepath to be cached</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$file **mixed**
|
||||
@ -1,100 +1,27 @@
|
||||
SYSTEM\CACHE\cache_js
|
||||
===============
|
||||
|
||||
JS Cache Class provided by System for caching JS in the Database.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cache_js
|
||||
* Namespace: SYSTEM\CACHE
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:cache_js
|
||||
* Namespace:SYSTEM\CACHEConstants
|
||||
----------
|
||||
|
||||
|
||||
### CACHE_JS
|
||||
|
||||
const CACHE_JS = 11
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
###CACHE_JSconst CACHE_JS = 11Methods
|
||||
-------
|
||||
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache_js::put(\SYSTEM\CACHE\sha1 $ident, integer $data)
|
||||
|
||||
Put Data into the Cache
|
||||
###putmixed SYSTEM\CACHE\cache_js::put($ident, $data)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $data **integer** - <p>Data to cache</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ident **mixed***$data **mixed**
|
||||
###getmixed SYSTEM\CACHE\cache_js::get($ident, $header)
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache_js::get(\SYSTEM\CACHE\sha1 $ident, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ident **mixed***$header **mixed**
|
||||
###identmixed SYSTEM\CACHE\cache_js::ident($files)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$files **mixed**
|
||||
###urlmixed SYSTEM\CACHE\cache_js::url($files)
|
||||
|
||||
|
||||
|
||||
### ident
|
||||
|
||||
\SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_js::ident(array $files)
|
||||
|
||||
Calculate Ident for a list of Files
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $files **array** - <p>List of Files to be cached into one Cacheentry</p>
|
||||
|
||||
|
||||
|
||||
### minify
|
||||
|
||||
\SYSTEM\CACHE\url SYSTEM\CACHE\cache_js::minify(array $files)
|
||||
|
||||
Minify JS files and calculate URL for it
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $files **array** - <p>List of Files to be cached into one Cacheentry</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$files **mixed**
|
||||
@ -1,100 +1,27 @@
|
||||
SYSTEM\CACHE\cache_scss
|
||||
===============
|
||||
|
||||
SCSS Cache Class provided by System for compiling and caching SCSS in the Database.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cache_scss
|
||||
* Namespace: SYSTEM\CACHE
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:cache_scss
|
||||
* Namespace:SYSTEM\CACHEConstants
|
||||
----------
|
||||
|
||||
|
||||
### CACHE_SCSS
|
||||
|
||||
const CACHE_SCSS = 1
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
###CACHE_SCSSconst CACHE_SCSS = 1Methods
|
||||
-------
|
||||
|
||||
|
||||
### put
|
||||
|
||||
mixed SYSTEM\CACHE\cache_scss::put(\SYSTEM\CACHE\sha1 $file, integer $data)
|
||||
|
||||
Put Data into the Cache
|
||||
###putmixed SYSTEM\CACHE\cache_scss::put($file, $data)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **SYSTEM\CACHE\sha1** - <p>Filepath of the Content</p>
|
||||
* $data **integer** - <p>Data to cache</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$file **mixed***$data **mixed**
|
||||
###getmixed SYSTEM\CACHE\cache_scss::get($file, $header)
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CACHE\cache_scss::get(\SYSTEM\CACHE\sha1 $file, boolean $header)
|
||||
|
||||
Get Data from Cache
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$file **mixed***$header **mixed**
|
||||
###identmixed SYSTEM\CACHE\cache_scss::ident($file)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **SYSTEM\CACHE\sha1** - <p>Filepath for the cached Content</p>
|
||||
* $header **boolean** - <p>Send Header</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$file **mixed**
|
||||
###urlmixed SYSTEM\CACHE\cache_scss::url($file)
|
||||
|
||||
|
||||
|
||||
### ident
|
||||
|
||||
\SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_scss::ident(string $file)
|
||||
|
||||
Calculate Ident for a File
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **string** - <p>Filepath to be cached</p>
|
||||
|
||||
|
||||
|
||||
### url
|
||||
|
||||
\SYSTEM\CACHE\url SYSTEM\CACHE\cache_scss::url(array $file)
|
||||
|
||||
Calculate URL for a File
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $file **array** - <p>Filepath to be cached</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$file **mixed**
|
||||
@ -1,86 +1,26 @@
|
||||
SYSTEM\CONFIG\config
|
||||
===============
|
||||
|
||||
Config Class provided by System for configuration of the System Environment.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: config
|
||||
* Namespace: SYSTEM\CONFIG
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:config
|
||||
* Namespace:SYSTEM\CONFIGProperties
|
||||
----------
|
||||
|
||||
|
||||
### $config
|
||||
|
||||
private mixed $config
|
||||
|
||||
array Holding all the Config Data
|
||||
###$configprivate mixed $config
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This property is **static**.
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private*** This property is **static**.Methods
|
||||
-------
|
||||
|
||||
|
||||
### get
|
||||
|
||||
mixed SYSTEM\CONFIG\config::get(integer $config_id)
|
||||
|
||||
Get Config Setting
|
||||
###getmixed SYSTEM\CONFIG\config::get($config_id)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $config_id **integer** - <p>Config ID to be retrieved</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$config_id **mixed**
|
||||
###setmixed SYSTEM\CONFIG\config::set($config_id, $value)
|
||||
|
||||
|
||||
|
||||
### set
|
||||
|
||||
NULL SYSTEM\CONFIG\config::set(integer $config_id, mixed $value)
|
||||
|
||||
Set Config Setting
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$config_id **mixed***$value **mixed**
|
||||
###setArraymixed SYSTEM\CONFIG\config::setArray($id_value_array)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $config_id **integer** - <p>Config ID to be written</p>
|
||||
* $value **mixed** - <p>Config Value to be written</p>
|
||||
|
||||
|
||||
|
||||
### setArray
|
||||
|
||||
NULL SYSTEM\CONFIG\config::setArray(array $id_value_array)
|
||||
|
||||
Set Array of Config Settings
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id_value_array **mixed**
|
||||
@ -1,180 +1,24 @@
|
||||
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
|
||||
* Namespace: SYSTEM\CONFIG
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:config_ids
|
||||
* Namespace:SYSTEM\CONFIGConstants
|
||||
----------
|
||||
|
||||
|
||||
### SYS_CONFIG_ERRORREPORTING
|
||||
|
||||
const SYS_CONFIG_ERRORREPORTING = 1
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_PATH_BASEURL
|
||||
|
||||
const SYS_CONFIG_PATH_BASEURL = 2
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_PATH_BASEPATH
|
||||
|
||||
const SYS_CONFIG_PATH_BASEPATH = 3
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_PATH_SYSTEMPATHREL
|
||||
|
||||
const SYS_CONFIG_PATH_SYSTEMPATHREL = 4
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DEFAULT_RESULT
|
||||
|
||||
const SYS_CONFIG_DEFAULT_RESULT = 5
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DEFAULT_RESULT_JSON
|
||||
|
||||
const SYS_CONFIG_DEFAULT_RESULT_JSON = 'json'
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DEFAULT_RESULT_MSGPACK
|
||||
|
||||
const SYS_CONFIG_DEFAULT_RESULT_MSGPACK = 'msgpack'
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DB_TYPE
|
||||
|
||||
const SYS_CONFIG_DB_TYPE = 11
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DB_TYPE_MYS
|
||||
|
||||
const SYS_CONFIG_DB_TYPE_MYS = 'mysql'
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DB_TYPE_PG
|
||||
|
||||
const SYS_CONFIG_DB_TYPE_PG = 'postgresql'
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DB_HOST
|
||||
|
||||
const SYS_CONFIG_DB_HOST = 12
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DB_PORT
|
||||
|
||||
const SYS_CONFIG_DB_PORT = 13
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DB_USER
|
||||
|
||||
const SYS_CONFIG_DB_USER = 14
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DB_PASSWORD
|
||||
|
||||
const SYS_CONFIG_DB_PASSWORD = 15
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DB_DBNAME
|
||||
|
||||
const SYS_CONFIG_DB_DBNAME = 16
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_LANGS
|
||||
|
||||
const SYS_CONFIG_LANGS = 21
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_DEFAULT_LANG
|
||||
|
||||
const SYS_CONFIG_DEFAULT_LANG = 22
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CRON_LOG2SQLITE_PATH
|
||||
|
||||
const SYS_CRON_LOG2SQLITE_PATH = 30
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_CONFIG_PATH_CACHE
|
||||
|
||||
const SYS_CONFIG_PATH_CACHE = 31
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### SYS_SAI_CONFIG_PROJECT
|
||||
|
||||
const SYS_SAI_CONFIG_PROJECT = 54
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
###SYS_CONFIG_ERRORREPORTINGconst SYS_CONFIG_ERRORREPORTING = 1
|
||||
###SYS_CONFIG_PATH_BASEURLconst SYS_CONFIG_PATH_BASEURL = 2
|
||||
###SYS_CONFIG_PATH_BASEPATHconst SYS_CONFIG_PATH_BASEPATH = 3
|
||||
###SYS_CONFIG_PATH_SYSTEMPATHRELconst SYS_CONFIG_PATH_SYSTEMPATHREL = 4
|
||||
###SYS_CONFIG_DEFAULT_RESULTconst SYS_CONFIG_DEFAULT_RESULT = 5
|
||||
###SYS_CONFIG_DEFAULT_RESULT_JSONconst SYS_CONFIG_DEFAULT_RESULT_JSON = 'json'
|
||||
###SYS_CONFIG_DEFAULT_RESULT_MSGPACKconst SYS_CONFIG_DEFAULT_RESULT_MSGPACK = 'msgpack'
|
||||
###SYS_CONFIG_DB_TYPEconst SYS_CONFIG_DB_TYPE = 11
|
||||
###SYS_CONFIG_DB_TYPE_MYSconst SYS_CONFIG_DB_TYPE_MYS = 'mysql'
|
||||
###SYS_CONFIG_DB_TYPE_PGconst SYS_CONFIG_DB_TYPE_PG = 'postgresql'
|
||||
###SYS_CONFIG_DB_HOSTconst SYS_CONFIG_DB_HOST = 12
|
||||
###SYS_CONFIG_DB_PORTconst SYS_CONFIG_DB_PORT = 13
|
||||
###SYS_CONFIG_DB_USERconst SYS_CONFIG_DB_USER = 14
|
||||
###SYS_CONFIG_DB_PASSWORDconst SYS_CONFIG_DB_PASSWORD = 15
|
||||
###SYS_CONFIG_DB_DBNAMEconst SYS_CONFIG_DB_DBNAME = 16
|
||||
###SYS_CONFIG_LANGSconst SYS_CONFIG_LANGS = 21
|
||||
###SYS_CONFIG_DEFAULT_LANGconst SYS_CONFIG_DEFAULT_LANG = 22
|
||||
###SYS_CRON_LOG2SQLITE_PATHconst SYS_CRON_LOG2SQLITE_PATH = 30
|
||||
###SYS_SAI_CONFIG_PROJECTconst SYS_SAI_CONFIG_PROJECT = 54
|
||||
@ -1,134 +1,35 @@
|
||||
SYSTEM\CRON\cron
|
||||
===============
|
||||
|
||||
Cron Class provided by System for Tasks occurring repeateadly.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cron
|
||||
* Namespace: SYSTEM\CRON
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:cron
|
||||
* Namespace:SYSTEM\CRONMethods
|
||||
-------
|
||||
###checkmixed SYSTEM\CRON\cron::check($class)
|
||||
|
||||
|
||||
### check
|
||||
|
||||
boolean SYSTEM\CRON\cron::check(\SYSTEM\CRON\class $class)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$class **mixed**
|
||||
###runmixed SYSTEM\CRON\cron::run()
|
||||
|
||||
Check if given Class is a compatible Cronjob
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###nextmixed SYSTEM\CRON\cron::next($class)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **SYSTEM\CRON\class** - <p>Cronclass extending cronjob</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$class **mixed**
|
||||
###lastmixed SYSTEM\CRON\cron::last($class)
|
||||
|
||||
|
||||
|
||||
### run
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$class **mixed**
|
||||
###statusmixed SYSTEM\CRON\cron::status($class, $status)
|
||||
|
||||
\SYSTEM\CRON\JSON SYSTEM\CRON\cron::run()
|
||||
|
||||
Run all registered Cronjobs if its time to do so.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\cron::next(\SYSTEM\CRON\class $class)
|
||||
|
||||
Determine next run of a given Cronjob
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **SYSTEM\CRON\class** - <p>Cronjob class</p>
|
||||
|
||||
|
||||
|
||||
### last
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\cron::last(\SYSTEM\CRON\class $class)
|
||||
|
||||
Determine last run of a given Cronjob
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **SYSTEM\CRON\class** - <p>Cronjob class</p>
|
||||
|
||||
|
||||
|
||||
### status
|
||||
|
||||
boolean SYSTEM\CRON\cron::status(\SYSTEM\CRON\class $class, integer $status)
|
||||
|
||||
Updates the Status of a Cronjob
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **SYSTEM\CRON\class** - <p>Cronjob class</p>
|
||||
* $status **integer** - <p>Status to be written</p>
|
||||
|
||||
|
||||
|
||||
### last_visit
|
||||
|
||||
\SYSTEM\CRON\time SYSTEM\CRON\cron::last_visit()
|
||||
|
||||
Determines the time when the System-Cronjobs were executed the last time.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$class **mixed***$status **mixed**
|
||||
###last_visitmixed SYSTEM\CRON\cron::last_visit()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
@ -1,35 +1,10 @@
|
||||
SYSTEM\CRON\cron_cache_delete
|
||||
===============
|
||||
|
||||
Conjob Class provided by System to delete System Cache.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cron_cache_delete
|
||||
* Namespace: SYSTEM\CRON
|
||||
* This class implements: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:cron_cache_delete
|
||||
* Namespace:SYSTEM\CRON* Parent class:[SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)Methods
|
||||
-------
|
||||
|
||||
|
||||
### run
|
||||
|
||||
integer SYSTEM\CRON\cronjob::run()
|
||||
|
||||
Run the Cronjob and execute its task
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
###runmixed SYSTEM\CRON\cronjob::run()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
@ -1,35 +1,10 @@
|
||||
SYSTEM\CRON\cron_log2sqlite
|
||||
===============
|
||||
|
||||
Conjob Class provided by System to extract Logentries into sqlite files.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cron_log2sqlite
|
||||
* Namespace: SYSTEM\CRON
|
||||
* This class implements: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:cron_log2sqlite
|
||||
* Namespace:SYSTEM\CRON* Parent class:[SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)Methods
|
||||
-------
|
||||
|
||||
|
||||
### run
|
||||
|
||||
integer SYSTEM\CRON\cronjob::run()
|
||||
|
||||
Run the Cronjob and execute its task
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
###runmixed SYSTEM\CRON\cronjob::run()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob)
|
||||
@ -1,34 +1,10 @@
|
||||
SYSTEM\CRON\cronjob
|
||||
===============
|
||||
|
||||
Conjob Class provided by System to derive from for custom Cronjobs.
|
||||
|
||||
|
||||
|
||||
|
||||
* Interface name: cronjob
|
||||
* Namespace: SYSTEM\CRON
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:cronjob
|
||||
* Namespace:SYSTEM\CRONMethods
|
||||
-------
|
||||
|
||||
|
||||
### run
|
||||
|
||||
integer SYSTEM\CRON\cronjob::run()
|
||||
|
||||
Run the Cronjob and execute its task
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
###runmixed SYSTEM\CRON\cronjob::run()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
@ -1,79 +1,16 @@
|
||||
SYSTEM\CRON\cronstatus
|
||||
===============
|
||||
|
||||
Cronstatus Class provided by System for Cronjob stati.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: cronstatus
|
||||
* Namespace: SYSTEM\CRON
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:cronstatus
|
||||
* Namespace:SYSTEM\CRONConstants
|
||||
----------
|
||||
|
||||
|
||||
### CRON_STATUS_SUCCESFULLY
|
||||
|
||||
const CRON_STATUS_SUCCESFULLY = 0
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CRON_STATUS_RUNNING
|
||||
|
||||
const CRON_STATUS_RUNNING = 1
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CRON_STATUS_FAIL
|
||||
|
||||
const CRON_STATUS_FAIL = 2
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CRON_STATUS_FAIL_CLASS
|
||||
|
||||
const CRON_STATUS_FAIL_CLASS = 3
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### CRON_STATUS_USER_STATES
|
||||
|
||||
const CRON_STATUS_USER_STATES = 99
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
###CRON_STATUS_SUCCESFULLYconst CRON_STATUS_SUCCESFULLY = 0
|
||||
###CRON_STATUS_RUNNINGconst CRON_STATUS_RUNNING = 1
|
||||
###CRON_STATUS_FAILconst CRON_STATUS_FAIL = 2
|
||||
###CRON_STATUS_FAIL_CLASSconst CRON_STATUS_FAIL_CLASS = 3
|
||||
###CRON_STATUS_USER_STATESconst CRON_STATUS_USER_STATES = 99Methods
|
||||
-------
|
||||
|
||||
|
||||
### text
|
||||
|
||||
string SYSTEM\CRON\cronstatus::text(integer $status)
|
||||
|
||||
Convert Cron Status to a text value.
|
||||
###textmixed SYSTEM\CRON\cronstatus::text($status)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $status **integer** - <p>Value from this Class</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$status **mixed**
|
||||
@ -1,153 +1,35 @@
|
||||
SYSTEM\CRON\crontime
|
||||
===============
|
||||
|
||||
Crontime Class provided by System for Cronjob time calculation.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: crontime
|
||||
* Namespace: SYSTEM\CRON
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:crontime
|
||||
* Namespace:SYSTEM\CRONMethods
|
||||
-------
|
||||
|
||||
|
||||
### next
|
||||
|
||||
\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
|
||||
###nextmixed SYSTEM\CRON\crontime::next($base_time, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$base_time **mixed***$min **mixed***$hour **mixed***$day **mixed***$day_week **mixed***$month **mixed**
|
||||
###lastmixed SYSTEM\CRON\crontime::last($base_time, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
|
||||
|
||||
### last
|
||||
|
||||
\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
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$base_time **mixed***$min **mixed***$hour **mixed***$day **mixed***$day_week **mixed***$month **mixed**
|
||||
###checkmixed SYSTEM\CRON\crontime::check($base_time, $last_run, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$base_time **mixed***$last_run **mixed***$min **mixed***$hour **mixed***$day **mixed***$day_week **mixed***$month **mixed**
|
||||
###next_nowmixed SYSTEM\CRON\crontime::next_now($min, $hour, $day, $day_week, $month)
|
||||
|
||||
|
||||
|
||||
### check
|
||||
|
||||
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
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$min **mixed***$hour **mixed***$day **mixed***$day_week **mixed***$month **mixed**
|
||||
###last_nowmixed SYSTEM\CRON\crontime::last_now($min, $hour, $day, $day_week, $month)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$min **mixed***$hour **mixed***$day **mixed***$day_week **mixed***$month **mixed**
|
||||
###check_nowmixed SYSTEM\CRON\crontime::check_now($last_run, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
|
||||
|
||||
### check_now
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$last_run **mixed***$min **mixed***$hour **mixed***$day **mixed***$day_week **mixed***$month **mixed**
|
||||
@ -1,187 +1,56 @@
|
||||
SYSTEM\DB\Connection
|
||||
===============
|
||||
|
||||
Connection Class provided by System to open a Connection to a Database.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: Connection
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:Connection
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $connection
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
ressource Variable to store then open Connection
|
||||
###$connectionprivate mixed $connection = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
###__destructmixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###preparemixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$stmtName **mixed***$stmt **mixed***$values **mixed**
|
||||
###closemixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###querymixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
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)#### Arguments*$query **mixed**
|
||||
###execmixed SYSTEM\DB\Connection::exec($query)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
* Visibility: **public**#### Arguments*$query **mixed**
|
||||
###transmixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
|
||||
|
||||
### close
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###commitmixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###getPrepareValueTypemixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### prepare
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### commit
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
* Visibility: **protected*** This method is **static**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$value **mixed**
|
||||
@ -1,203 +1,56 @@
|
||||
SYSTEM\DB\ConnectionAMQP
|
||||
===============
|
||||
|
||||
AMQP Connection Class provided by System to connect to AMQP Services.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ConnectionAMQP
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ConnectionAMQP
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $connection
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
ressource Variable to store then open Connection
|
||||
###$connectionprivate mixed $connection = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
###sendmixed SYSTEM\DB\ConnectionAMQP::send($msg)
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
* Visibility: **public**#### Arguments*$msg **mixed**
|
||||
###__destructmixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###closemixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
### send
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###querymixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
null SYSTEM\DB\ConnectionAMQP::send(array $msg)
|
||||
|
||||
Send a Message to the AMQP Server
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$query **mixed**
|
||||
###preparemixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$stmtName **mixed***$stmt **mixed***$values **mixed**
|
||||
###commitmixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
#### Arguments
|
||||
* $msg **array** - <p>Query Object</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###transmixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
### __destruct
|
||||
|
||||
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)
|
||||
###getPrepareValueTypemixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
|
||||
|
||||
* 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**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### query
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
|
||||
|
||||
|
||||
### prepare
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
* Visibility: **protected*** This method is **static**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$value **mixed**
|
||||
@ -1,165 +1,45 @@
|
||||
SYSTEM\DB\ConnectionAbstr
|
||||
===============
|
||||
|
||||
Abstract Connection Class provided by System as a PDO Controller.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ConnectionAbstr
|
||||
* Namespace: SYSTEM\DB
|
||||
* This is an **abstract** class
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:ConnectionAbstr
|
||||
* Namespace:SYSTEM\DB* This is an **abstract** classMethods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
* Visibility: **public*** This method is **abstract**.#### Arguments*$dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
###__destructmixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.
|
||||
###closemixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
* Visibility: **public*** This method is **abstract**.
|
||||
###preparemixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
* Visibility: **public*** This method is **abstract**.#### Arguments*$stmtName **mixed***$stmt **mixed***$values **mixed**
|
||||
###querymixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Destruct the Database Connection upon Destruction.
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.#### Arguments*$query **mixed**
|
||||
###commitmixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.
|
||||
###transmixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
|
||||
|
||||
### close
|
||||
* Visibility: **public*** This method is **abstract**.
|
||||
###getPrepareValueTypemixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
|
||||
|
||||
### prepare
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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**.
|
||||
|
||||
|
||||
#### 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**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
|
||||
|
||||
### commit
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
* Visibility: **protected*** This method is **static**.#### Arguments*$value **mixed**
|
||||
@ -1,187 +1,51 @@
|
||||
SYSTEM\DB\ConnectionMYS
|
||||
===============
|
||||
|
||||
MYSQL Connection Class provided by System to connect to MYSQL Database.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ConnectionMYS
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ConnectionMYS
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $connection
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
ressource Variable to store then open Connection
|
||||
###$connectionprivate mixed $connection = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
###__destructmixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###preparemixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$stmtName **mixed***$stmt **mixed***$values **mixed**
|
||||
###closemixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###querymixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
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)#### Arguments*$query **mixed**
|
||||
###commitmixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###transmixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
|
||||
|
||||
### close
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###getPrepareValueTypemixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### prepare
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### trans
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
* Visibility: **protected*** This method is **static**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$value **mixed**
|
||||
@ -1,187 +1,51 @@
|
||||
SYSTEM\DB\ConnectionPG
|
||||
===============
|
||||
|
||||
PostgreSQL Connection Class provided by System to connect to PostgreSQL Database.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ConnectionPG
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ConnectionPG
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $connection
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
ressource Variable to store then open Connection
|
||||
###$connectionprivate mixed $connection = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
###__destructmixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###preparemixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$stmtName **mixed***$stmt **mixed***$values **mixed**
|
||||
###closemixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###querymixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
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)#### Arguments*$query **mixed**
|
||||
###transmixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###commitmixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
|
||||
|
||||
### close
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###getPrepareValueTypemixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### prepare
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
* 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
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### commit
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
* Visibility: **protected*** This method is **static**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$value **mixed**
|
||||
@ -1,187 +1,56 @@
|
||||
SYSTEM\DB\ConnectionSQLite
|
||||
===============
|
||||
|
||||
SQLite Connection Class provided by System to connect to SQLite Databasefile.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ConnectionSQLite
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ConnectionSQLite
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $connection
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
ressource Variable to store the open Connection
|
||||
###$connectionprivate mixed $connection = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)**
|
||||
###__destructmixed SYSTEM\DB\ConnectionAbstr::__destruct()
|
||||
|
||||
Connect to the DB upon Construction.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###preparemixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p>
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$stmtName **mixed***$stmt **mixed***$values **mixed**
|
||||
###closemixed SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###querymixed SYSTEM\DB\ConnectionAbstr::query($query)
|
||||
|
||||
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)#### Arguments*$query **mixed**
|
||||
###execmixed SYSTEM\DB\ConnectionSQLite::exec($query)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
* Visibility: **public**#### Arguments*$query **mixed**
|
||||
###commitmixed SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
|
||||
|
||||
### close
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###transmixed SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::close()
|
||||
|
||||
Close the Database Connection.
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
###getPrepareValueTypemixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### prepare
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types)
|
||||
|
||||
Query the Connection using Prepare Statement
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query)
|
||||
|
||||
Query the Connection using normal Query Statement
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::commit()
|
||||
|
||||
Commit a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### trans
|
||||
|
||||
boolean SYSTEM\DB\ConnectionAbstr::trans()
|
||||
|
||||
Open a Transaction on the Database Connection
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
|
||||
|
||||
### getPrepareValueType
|
||||
|
||||
string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value)
|
||||
|
||||
Helperfunction to convert Prepared Values to SQL Type identifiers
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $value **string** - <p>Value to be examined regarding Type</p>
|
||||
|
||||
|
||||
* Visibility: **protected*** This method is **static**.* This method is defined by[SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr)#### Arguments*$value **mixed**
|
||||
@ -1,99 +1,36 @@
|
||||
SYSTEM\DB\DBInfo
|
||||
===============
|
||||
|
||||
DBInfo Abstract Class provided by System to hold Database Information.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: DBInfo
|
||||
* Namespace: SYSTEM\DB
|
||||
* This is an **abstract** class
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:DBInfo
|
||||
* Namespace:SYSTEM\DB* This is an **abstract** classProperties
|
||||
----------
|
||||
|
||||
|
||||
### $m_database
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
string Variable to store Database name
|
||||
###$m_databasepublic mixed $m_database = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_user
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
string Variable to store Database user
|
||||
###$m_userpublic mixed $m_user = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_password
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
string Variable to store Database password
|
||||
###$m_passwordpublic mixed $m_password = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_host
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
string Variable to store Database host
|
||||
###$m_hostpublic mixed $m_host = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_port
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
int Variable to store Database port
|
||||
###$m_portpublic mixed $m_port = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
###__constructmixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.#### Arguments*$database **mixed***$user **mixed***$password **mixed***$host **mixed***$port **mixed**
|
||||
@ -1,100 +1,36 @@
|
||||
SYSTEM\DB\DBInfoAMQP
|
||||
===============
|
||||
|
||||
DBInfoAMQP Class provided by System to hold AMQP Database Information.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: DBInfoAMQP
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:DBInfoAMQP
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $m_database
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
string Variable to store Database name
|
||||
###$m_databasepublic mixed $m_database = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_user
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
string Variable to store Database user
|
||||
###$m_userpublic mixed $m_user = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_password
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
string Variable to store Database password
|
||||
###$m_passwordpublic mixed $m_password = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_host
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
string Variable to store Database host
|
||||
###$m_hostpublic mixed $m_host = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_port
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
int Variable to store Database port
|
||||
###$m_portpublic mixed $m_port = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
###__constructmixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)#### Arguments*$database **mixed***$user **mixed***$password **mixed***$host **mixed***$port **mixed**
|
||||
@ -1,100 +1,36 @@
|
||||
SYSTEM\DB\DBInfoMYS
|
||||
===============
|
||||
|
||||
DBInfoMYS Class provided by System to hold MYSQL Database Information.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: DBInfoMYS
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:DBInfoMYS
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $m_database
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
string Variable to store Database name
|
||||
###$m_databasepublic mixed $m_database = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_user
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
string Variable to store Database user
|
||||
###$m_userpublic mixed $m_user = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_password
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
string Variable to store Database password
|
||||
###$m_passwordpublic mixed $m_password = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_host
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
string Variable to store Database host
|
||||
###$m_hostpublic mixed $m_host = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_port
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
int Variable to store Database port
|
||||
###$m_portpublic mixed $m_port = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
###__constructmixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)#### Arguments*$database **mixed***$user **mixed***$password **mixed***$host **mixed***$port **mixed**
|
||||
@ -1,100 +1,36 @@
|
||||
SYSTEM\DB\DBInfoPG
|
||||
===============
|
||||
|
||||
DBInfoPG Class provided by System to hold PostgreSQL Database Information.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: DBInfoPG
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:DBInfoPG
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $m_database
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
string Variable to store Database name
|
||||
###$m_databasepublic mixed $m_database = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_user
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
string Variable to store Database user
|
||||
###$m_userpublic mixed $m_user = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_password
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
string Variable to store Database password
|
||||
###$m_passwordpublic mixed $m_password = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_host
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
string Variable to store Database host
|
||||
###$m_hostpublic mixed $m_host = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_port
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
int Variable to store Database port
|
||||
###$m_portpublic mixed $m_port = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
###__constructmixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)#### Arguments*$database **mixed***$user **mixed***$password **mixed***$host **mixed***$port **mixed**
|
||||
@ -1,100 +1,36 @@
|
||||
SYSTEM\DB\DBInfoSQLite
|
||||
===============
|
||||
|
||||
DBInfoSQLite Class provided by System to hold SQLite File-Database Information.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: DBInfoSQLite
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:DBInfoSQLite
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $m_database
|
||||
|
||||
public mixed $m_database = null
|
||||
|
||||
string Variable to store Database name
|
||||
###$m_databasepublic mixed $m_database = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_user
|
||||
|
||||
public mixed $m_user = null
|
||||
|
||||
string Variable to store Database user
|
||||
###$m_userpublic mixed $m_user = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_password
|
||||
|
||||
public mixed $m_password = null
|
||||
|
||||
string Variable to store Database password
|
||||
###$m_passwordpublic mixed $m_password = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_host
|
||||
|
||||
public mixed $m_host = null
|
||||
|
||||
string Variable to store Database host
|
||||
###$m_hostpublic mixed $m_host = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $m_port
|
||||
|
||||
public mixed $m_port = null
|
||||
|
||||
int Variable to store Database port
|
||||
###$m_portpublic mixed $m_port = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port)
|
||||
|
||||
Store Data upon Construction.
|
||||
###__constructmixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)#### Arguments*$database **mixed***$user **mixed***$password **mixed***$host **mixed***$port **mixed**
|
||||
@ -1,38 +1,10 @@
|
||||
SYSTEM\DB\QI
|
||||
===============
|
||||
|
||||
QI Class provided by System to execute quick installation statements.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: QI
|
||||
* Namespace: SYSTEM\DB
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:QI
|
||||
* Namespace:SYSTEM\DBMethods
|
||||
-------
|
||||
|
||||
|
||||
### QI
|
||||
|
||||
array SYSTEM\DB\QI::QI(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action by calling either files_pgsql() or files_mysql()
|
||||
of inherting class
|
||||
###QImixed SYSTEM\DB\QI::QI($dbinfo)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$dbinfo **mixed**
|
||||
@ -1,92 +1,25 @@
|
||||
SYSTEM\DB\QP
|
||||
===============
|
||||
|
||||
QQ Class provided by System to execute quick prepare statements.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: QP
|
||||
* Namespace: SYSTEM\DB
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:QP
|
||||
* Namespace:SYSTEM\DBMethods
|
||||
-------
|
||||
|
||||
|
||||
### QQ
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\QP::QQ(array $params, \SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return Database Object
|
||||
###QQmixed SYSTEM\DB\QP::QQ($params, $dbinfo)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Parameter passed to the prepare-query</p>
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$params **mixed***$dbinfo **mixed**
|
||||
###QAmixed SYSTEM\DB\QP::QA($params, $dbinfo)
|
||||
|
||||
|
||||
|
||||
### QA
|
||||
|
||||
array SYSTEM\DB\QP::QA(array $params, \SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return all Data found
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$params **mixed***$dbinfo **mixed**
|
||||
###Q1mixed SYSTEM\DB\QP::Q1($params, $dbinfo)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Parameter passed to the prepare-query</p>
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$params **mixed***$dbinfo **mixed**
|
||||
###QImixed SYSTEM\DB\QP::QI($params, $dbinfo)
|
||||
|
||||
|
||||
|
||||
### Q1
|
||||
|
||||
array SYSTEM\DB\QP::Q1(array $params, \SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return one line of Data found
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Parameter passed to the prepare-query</p>
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
### QI
|
||||
|
||||
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 **array** - <p>Parameter passed to the prepare-query</p>
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$params **mixed***$dbinfo **mixed**
|
||||
@ -1,88 +1,25 @@
|
||||
SYSTEM\DB\QQ
|
||||
===============
|
||||
|
||||
QQ Class provided by System to execute quick query statements.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: QQ
|
||||
* Namespace: SYSTEM\DB
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:QQ
|
||||
* Namespace:SYSTEM\DBMethods
|
||||
-------
|
||||
|
||||
|
||||
### QQ
|
||||
|
||||
\SYSTEM\DB\Result SYSTEM\DB\QQ::QQ(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return Database Object
|
||||
###QQmixed SYSTEM\DB\QQ::QQ($dbinfo)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$dbinfo **mixed**
|
||||
###QAmixed SYSTEM\DB\QQ::QA($dbinfo)
|
||||
|
||||
|
||||
|
||||
### QA
|
||||
|
||||
array SYSTEM\DB\QQ::QA(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return all Data found
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$dbinfo **mixed**
|
||||
###Q1mixed SYSTEM\DB\QQ::Q1($dbinfo)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$dbinfo **mixed**
|
||||
###QImixed SYSTEM\DB\QQ::QI($dbinfo)
|
||||
|
||||
|
||||
|
||||
### Q1
|
||||
|
||||
array SYSTEM\DB\QQ::Q1(\SYSTEM\DB\DBINFO $dbinfo)
|
||||
|
||||
Executes stored action and return one line of Data found
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
|
||||
### QI
|
||||
|
||||
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 **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$dbinfo **mixed**
|
||||
@ -1,97 +1,30 @@
|
||||
SYSTEM\DB\Result
|
||||
===============
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: Result
|
||||
* Namespace: SYSTEM\DB
|
||||
* This is an **abstract** class
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:Result
|
||||
* Namespace:SYSTEM\DB* This is an **abstract** classMethods
|
||||
-------
|
||||
|
||||
|
||||
### count
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
###countmixed SYSTEM\DB\Result::count()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* Visibility: **public*** This method is **abstract**.
|
||||
###affectedRowsmixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
|
||||
|
||||
|
||||
### affectedRows
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
* Visibility: **public*** This method is **abstract**.
|
||||
###nextmixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* Visibility: **public*** This method is **abstract**.#### Arguments*$object **mixed**
|
||||
###seekmixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
|
||||
|
||||
|
||||
### next
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* Visibility: **public*** This method is **abstract**.#### Arguments*$row_number **mixed**
|
||||
###closemixed SYSTEM\DB\Result::close()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.
|
||||
@ -1,155 +1,51 @@
|
||||
SYSTEM\DB\ResultAMQP
|
||||
===============
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of AMQP Querys.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ResultAMQP
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ResultAMQP
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\Result](SYSTEM-DB-Result)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $res
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
###$resprivate mixed $res = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $current
|
||||
|
||||
private mixed $current = NULL
|
||||
|
||||
ressource Variable to store current Line either as array or object
|
||||
###$currentprivate mixed $current = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ResultAMQP::__construct($res)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultAMQP::__construct(\SYSTEM\DB\ressource $res)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
* Visibility: **public**#### Arguments*$res **mixed**
|
||||
###__destructmixed SYSTEM\DB\ResultAMQP::__destruct()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p>
|
||||
###closemixed SYSTEM\DB\Result::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
|
||||
mixed SYSTEM\DB\ResultAMQP::__destruct()
|
||||
|
||||
Close Resultset upon destruction
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###countmixed SYSTEM\DB\Result::count()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###affectedRowsmixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###nextmixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$object **mixed**
|
||||
###seekmixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
|
||||
|
||||
|
||||
### count
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### affectedRows
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### next
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$row_number **mixed**
|
||||
@ -1,155 +1,51 @@
|
||||
SYSTEM\DB\ResultMysqli
|
||||
===============
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of MYSQL Querys.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ResultMysqli
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ResultMysqli
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\Result](SYSTEM-DB-Result)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $res
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
###$resprivate mixed $res = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $current
|
||||
|
||||
private mixed $current = NULL
|
||||
|
||||
ressource Variable to store current Line either as array or object
|
||||
###$currentprivate mixed $current = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ResultMysqli::__construct($res)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqli::__construct(\SYSTEM\DB\ressource $res)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
* Visibility: **public**#### Arguments*$res **mixed**
|
||||
###__destructmixed SYSTEM\DB\ResultMysqli::__destruct()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p>
|
||||
###closemixed SYSTEM\DB\Result::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqli::__destruct()
|
||||
|
||||
Close Resultset upon destruction
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###countmixed SYSTEM\DB\Result::count()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###affectedRowsmixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###nextmixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$object **mixed**
|
||||
###seekmixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
|
||||
|
||||
|
||||
### count
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### affectedRows
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### next
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$row_number **mixed**
|
||||
@ -1,178 +1,61 @@
|
||||
SYSTEM\DB\ResultMysqliPrepare
|
||||
===============
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of MYSQL prepare Querys.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ResultMysqliPrepare
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ResultMysqliPrepare
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\Result](SYSTEM-DB-Result)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $res
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
###$resprivate mixed $res = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $meta
|
||||
|
||||
private mixed $meta = NULL
|
||||
|
||||
ressource Variable to store Metadata of Colums
|
||||
###$metaprivate mixed $meta = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $binds
|
||||
|
||||
private mixed $binds = array()
|
||||
|
||||
ressource Variable to store Binding Variables
|
||||
###$bindsprivate mixed $binds = array()
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $connection
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
ressource Variable to store Database Connection
|
||||
###$connectionprivate mixed $connection = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ResultMysqliPrepare::__construct($res, $connection)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqliPrepare::__construct(\SYSTEM\DB\ressource $res, \SYSTEM\DB\ressource $connection)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
* Visibility: **public**#### Arguments*$res **mixed***$connection **mixed**
|
||||
###__destructmixed SYSTEM\DB\ResultMysqliPrepare::__destruct()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
###closemixed SYSTEM\DB\Result::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
|
||||
mixed SYSTEM\DB\ResultMysqliPrepare::__destruct()
|
||||
|
||||
Close Resultset upon destruction
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###countmixed SYSTEM\DB\Result::count()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###affectedRowsmixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###nextmixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$object **mixed**
|
||||
###seekmixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
|
||||
|
||||
|
||||
### count
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### affectedRows
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### next
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$row_number **mixed**
|
||||
@ -1,167 +1,56 @@
|
||||
SYSTEM\DB\ResultPostgres
|
||||
===============
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of PostgreSQL Querys.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ResultPostgres
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ResultPostgres
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\Result](SYSTEM-DB-Result)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $res
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
###$resprivate mixed $res = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $current
|
||||
|
||||
private mixed $current = NULL
|
||||
|
||||
ressource Variable to store current Line either as array or object
|
||||
###$currentprivate mixed $current = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $connection
|
||||
|
||||
private mixed $connection = NULL
|
||||
|
||||
ressource Variable to store Database Connection
|
||||
###$connectionprivate mixed $connection = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ResultPostgres::__construct($res, $connection)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultPostgres::__construct(\SYSTEM\DB\ressource $res, \SYSTEM\DB\ressource $connection)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
* Visibility: **public**#### Arguments*$res **mixed***$connection **mixed**
|
||||
###__destructmixed SYSTEM\DB\ResultPostgres::__destruct()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
###closemixed SYSTEM\DB\Result::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
|
||||
mixed SYSTEM\DB\ResultPostgres::__destruct()
|
||||
|
||||
Close Resultset upon destruction
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###countmixed SYSTEM\DB\Result::count()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###affectedRowsmixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###nextmixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$object **mixed**
|
||||
###seekmixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
|
||||
|
||||
|
||||
### count
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### affectedRows
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### next
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$row_number **mixed**
|
||||
@ -1,167 +1,56 @@
|
||||
SYSTEM\DB\ResultSQLite
|
||||
===============
|
||||
|
||||
Result Class provided by System to hold Database Query Result Ressources of SQLite File Querys.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ResultSQLite
|
||||
* Namespace: SYSTEM\DB
|
||||
* Parent class: [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ResultSQLite
|
||||
* Namespace:SYSTEM\DB* Parent class:[SYSTEM\DB\Result](SYSTEM-DB-Result)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $res
|
||||
|
||||
private mixed $res = NULL
|
||||
|
||||
ressource Variable to store Database Result-ressource
|
||||
###$resprivate mixed $res = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $stmt
|
||||
|
||||
private mixed $stmt = NULL
|
||||
|
||||
ressource Variable to store query statement
|
||||
###$stmtprivate mixed $stmt = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $current
|
||||
|
||||
private mixed $current = NULL
|
||||
|
||||
ressource Variable to store current Line either as array or object
|
||||
###$currentprivate mixed $current = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\DB\ResultSQLite::__construct($res, $stmt)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\DB\ResultSQLite::__construct(\SYSTEM\DB\ressource $res, string $stmt)
|
||||
|
||||
Construct the Resultset with a database ressource
|
||||
* Visibility: **public**#### Arguments*$res **mixed***$stmt **mixed**
|
||||
###__destructmixed SYSTEM\DB\ResultSQLite::__destruct()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p>
|
||||
* $stmt **string** - <p>Query Statement which produced the result set</p>
|
||||
###closemixed SYSTEM\DB\Result::close()
|
||||
|
||||
|
||||
|
||||
### __destruct
|
||||
|
||||
mixed SYSTEM\DB\ResultSQLite::__destruct()
|
||||
|
||||
Close Resultset upon destruction
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###countmixed SYSTEM\DB\Result::count()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###affectedRowsmixed SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
|
||||
|
||||
|
||||
### close
|
||||
|
||||
null SYSTEM\DB\Result::close()
|
||||
|
||||
Closes the Resultset
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
###nextmixed SYSTEM\DB\Result::next($object)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$object **mixed**
|
||||
###seekmixed SYSTEM\DB\Result::seek($row_number)
|
||||
|
||||
|
||||
|
||||
|
||||
### count
|
||||
|
||||
integer SYSTEM\DB\Result::count()
|
||||
|
||||
Counts the Lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### affectedRows
|
||||
|
||||
integer SYSTEM\DB\Result::affectedRows()
|
||||
|
||||
Counts the affected lines in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
|
||||
|
||||
### next
|
||||
|
||||
array SYSTEM\DB\Result::next(boolean $object)
|
||||
|
||||
Returns the next line in the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $object **boolean** - <p>Determines if the result will be an object or array</p>
|
||||
|
||||
|
||||
|
||||
### seek
|
||||
|
||||
boolean SYSTEM\DB\Result::seek(integer $row_number)
|
||||
|
||||
Seeks an amount of lines within the Resultset
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **abstract**.
|
||||
* This method is defined by [SYSTEM\DB\Result](SYSTEM-DB-Result)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $row_number **integer** - <p>Lines to seek over</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\DB\Result](SYSTEM-DB-Result)#### Arguments*$row_number **mixed**
|
||||
@ -1,116 +1,26 @@
|
||||
SYSTEM\DOCU\docu
|
||||
===============
|
||||
|
||||
Docu Class provided by System to register docu_packages.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: docu
|
||||
* Namespace: SYSTEM\DOCU
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:docu
|
||||
* Namespace:SYSTEM\DOCUProperties
|
||||
----------
|
||||
|
||||
|
||||
### $docu_packages
|
||||
|
||||
private mixed $docu_packages = array()
|
||||
|
||||
array Variable to store all registred docu_package classes
|
||||
###$phpdocconfigsprivate mixed $phpdocconfigs = array()
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This property is **static**.
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private*** This property is **static**.Methods
|
||||
-------
|
||||
|
||||
|
||||
### register
|
||||
|
||||
null SYSTEM\DOCU\docu::register(string $docu_package)
|
||||
|
||||
Register a docu package
|
||||
###registermixed SYSTEM\DOCU\docu::register($phpdocconfig)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $docu_package **string** - <p>Classname of Docu Package to be registered</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$phpdocconfig **mixed**
|
||||
###getAllmixed SYSTEM\DOCU\docu::getAll()
|
||||
|
||||
|
||||
|
||||
### getAll
|
||||
|
||||
array SYSTEM\DOCU\docu::getAll()
|
||||
|
||||
Get all registered docu packages
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###getmixed SYSTEM\DOCU\docu::get($id)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### get
|
||||
|
||||
array SYSTEM\DOCU\docu::get(string $id)
|
||||
|
||||
Get a specific docu package by classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id **mixed**
|
||||
@ -1,182 +1,51 @@
|
||||
SYSTEM\FILES\files
|
||||
===============
|
||||
|
||||
Files Class provided by System to register folders and serve files.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: files
|
||||
* Namespace: SYSTEM\FILES
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:files
|
||||
* Namespace:SYSTEM\FILESProperties
|
||||
----------
|
||||
|
||||
|
||||
### $folders
|
||||
|
||||
private mixed $folders = array()
|
||||
|
||||
array Variable to store all registred file folders
|
||||
###$foldersprivate mixed $folders = array()
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This property is **static**.
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private*** This property is **static**.Methods
|
||||
-------
|
||||
###registerFoldermixed SYSTEM\FILES\files::registerFolder($path, $cat)
|
||||
|
||||
|
||||
### registerFolder
|
||||
|
||||
null SYSTEM\FILES\files::registerFolder(string $path, string $cat)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$path **mixed***$cat **mixed**
|
||||
###getmixed SYSTEM\FILES\files::get($cat, $id, $returnasjson)
|
||||
|
||||
Register a filefolder
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed***$id **mixed***$returnasjson **mixed**
|
||||
###putmixed SYSTEM\FILES\files::put($cat, $id, $contents)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $path **string** - <p>Path of the Folder</p>
|
||||
* $cat **string** - <p>Category to register that folder to</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed***$id **mixed***$contents **mixed**
|
||||
###deletemixed SYSTEM\FILES\files::delete($cat, $id)
|
||||
|
||||
|
||||
|
||||
### get
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed***$id **mixed**
|
||||
###renamemixed SYSTEM\FILES\files::rename($cat, $id, $newid)
|
||||
|
||||
mixed SYSTEM\FILES\files::get(string $cat, string $id, boolean $returnasjson)
|
||||
|
||||
Retrieve a File
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed***$id **mixed***$newid **mixed**
|
||||
###getFoldermixed SYSTEM\FILES\files::getFolder($folder)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$folder **mixed**
|
||||
###getURLmixed SYSTEM\FILES\files::getURL($cat, $id)
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed***$id **mixed**
|
||||
###file_get_contents_chunkedmixed SYSTEM\FILES\files::file_get_contents_chunked($file, $chunk_size, $callback)
|
||||
|
||||
### put
|
||||
|
||||
boolean SYSTEM\FILES\files::put(string $cat, string $id, \SYSTEM\FILES\ressource $contents)
|
||||
|
||||
Move a uploaded File into a Directtory
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
boolean SYSTEM\FILES\files::delete(string $cat, string $id)
|
||||
|
||||
Delete a File
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>Category of the File</p>
|
||||
* $id **string** - <p>ID of the File</p>
|
||||
|
||||
|
||||
|
||||
### rename
|
||||
|
||||
boolean SYSTEM\FILES\files::rename(string $cat, string $id, string $newid)
|
||||
|
||||
Rename a File
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
array SYSTEM\FILES\files::getFolder(string $folder)
|
||||
|
||||
Returns the contents of a Folder
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $folder **string** - <p>Path to the Folder</p>
|
||||
|
||||
|
||||
|
||||
### getURL
|
||||
|
||||
string SYSTEM\FILES\files::getURL(string $cat, string $id)
|
||||
|
||||
Returns a URL for a File
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>Category of the File</p>
|
||||
* $id **string** - <p>ID of the File</p>
|
||||
|
||||
|
||||
|
||||
### file_get_contents_chunked
|
||||
|
||||
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)
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$file **mixed***$chunk_size **mixed***$callback **mixed**
|
||||
169
SYSTEM-HEADER.md
169
SYSTEM-HEADER.md
@ -1,181 +1,60 @@
|
||||
SYSTEM\HEADER
|
||||
===============
|
||||
|
||||
HEADER Class provided by System Send HTML Headers
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: HEADER
|
||||
* Namespace: SYSTEM
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:HEADER
|
||||
* Namespace:SYSTEMMethods
|
||||
-------
|
||||
###checkHeadermixed SYSTEM\HEADER::checkHeader()
|
||||
|
||||
|
||||
### checkHeader
|
||||
|
||||
boolean SYSTEM\HEADER::checkHeader()
|
||||
* Visibility: **private*** This method is **static**.
|
||||
###JSONmixed SYSTEM\HEADER::JSON()
|
||||
|
||||
Check if Header was already sent
|
||||
Writes Warning into Database on failure if Database logging is enabled.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###PNGmixed SYSTEM\HEADER::PNG()
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###JPGmixed SYSTEM\HEADER::JPG()
|
||||
|
||||
|
||||
### available
|
||||
|
||||
boolean SYSTEM\HEADER::available(string $datatype)
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###JPEGmixed SYSTEM\HEADER::JPEG()
|
||||
|
||||
Check if a given Datatype has a handler within this class.
|
||||
|
||||
Not Case sensitive.
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###GIFmixed SYSTEM\HEADER::GIF()
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $datatype **string** - <p>Datatype to be checked eg. 'jpg'</p>
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###JSmixed SYSTEM\HEADER::JS()
|
||||
|
||||
|
||||
### JSON
|
||||
|
||||
null SYSTEM\HEADER::JSON()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###CSSmixed SYSTEM\HEADER::CSS()
|
||||
|
||||
Send JSON Headers, if Header was not sent yet
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###LESSmixed SYSTEM\HEADER::LESS()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###FILEmixed SYSTEM\HEADER::FILE($filename)
|
||||
|
||||
|
||||
### PNG
|
||||
|
||||
null SYSTEM\HEADER::PNG()
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filename **mixed**
|
||||
###availablemixed SYSTEM\HEADER::available($datatype)
|
||||
|
||||
Send PNG Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### JPG
|
||||
|
||||
null SYSTEM\HEADER::JPG()
|
||||
|
||||
Send JPG Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### JPEG
|
||||
|
||||
null SYSTEM\HEADER::JPEG()
|
||||
|
||||
Send JPEG Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### GIF
|
||||
|
||||
null SYSTEM\HEADER::GIF()
|
||||
|
||||
Send GIF Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### JS
|
||||
|
||||
null SYSTEM\HEADER::JS()
|
||||
|
||||
Send JS Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### CSS
|
||||
|
||||
null SYSTEM\HEADER::CSS()
|
||||
|
||||
Send CSS Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### LESS
|
||||
|
||||
null SYSTEM\HEADER::LESS()
|
||||
|
||||
Send LESS Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### FILE
|
||||
|
||||
null SYSTEM\HEADER::FILE(string $filename)
|
||||
|
||||
Send FILE(download) Headers, if Header was not sent yet
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filename **string** - <p>Filename which should be transmitted with the Filetransfere</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$datatype **mixed**
|
||||
@ -1,76 +1,20 @@
|
||||
SYSTEM\HTML\html
|
||||
===============
|
||||
|
||||
HTML Class provided by System to generate common HTML tags.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: html
|
||||
* Namespace: SYSTEM\HTML
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:html
|
||||
* Namespace:SYSTEM\HTMLMethods
|
||||
-------
|
||||
|
||||
|
||||
### link
|
||||
|
||||
string SYSTEM\HTML\html::link(string $href, string $rel, string $type)
|
||||
|
||||
Generate <link> tag
|
||||
###linkmixed SYSTEM\HTML\html::link($href, $rel, $type)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $href **string** - <p>href attribute</p>
|
||||
* $rel **string** - <p>rel attribute</p>
|
||||
* $type **string** - <p>type attribute</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$href **mixed***$rel **mixed***$type **mixed**
|
||||
###scriptmixed SYSTEM\HTML\html::script($src, $type, $rel, $language, $script)
|
||||
|
||||
|
||||
|
||||
### script
|
||||
|
||||
string SYSTEM\HTML\html::script(string $src, string $type, string $rel, string $script)
|
||||
|
||||
Generate <script> tag
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$src **mixed***$type **mixed***$rel **mixed***$language **mixed***$script **mixed**
|
||||
###stylemixed SYSTEM\HTML\html::style($style)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
string SYSTEM\HTML\html::style(string $style)
|
||||
|
||||
Generate <style> tag
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $style **string** - <p>style contents</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$style **mixed**
|
||||
20
SYSTEM-LOG-AbstractResult.md
Normal file
20
SYSTEM-LOG-AbstractResult.md
Normal file
@ -0,0 +1,20 @@
|
||||
SYSTEM\LOG\AbstractResult
|
||||
===============
|
||||
* Class name:AbstractResult
|
||||
* Namespace:SYSTEM\LOGMethods
|
||||
-------
|
||||
###toStringmixed SYSTEM\LOG\AbstractResult::toString($json_array, $status, $start_time)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$json_array **mixed***$status **mixed***$start_time **mixed**
|
||||
###errormixed SYSTEM\LOG\AbstractResult::error(\Exception $e)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$e **Exception**
|
||||
###okmixed SYSTEM\LOG\AbstractResult::ok()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
@ -1,64 +1,21 @@
|
||||
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
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\INFO](SYSTEM-LOG-INFO)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:COUNTER
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\INFO](SYSTEM-LOG-INFO)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,64 +1,21 @@
|
||||
SYSTEM\LOG\CRON
|
||||
===============
|
||||
|
||||
Cron Log Class provided by System for Cron Messages.
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: CRON
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\INFO](SYSTEM-LOG-INFO)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:CRON
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\INFO](SYSTEM-LOG-INFO)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,64 +1,21 @@
|
||||
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
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\TODO](SYSTEM-LOG-TODO)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:DEPRECATED
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\TODO](SYSTEM-LOG-TODO)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,64 +1,21 @@
|
||||
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
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\TODO](SYSTEM-LOG-TODO)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ERROR
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\TODO](SYSTEM-LOG-TODO)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,56 +1,16 @@
|
||||
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
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION](SYSTEM-LOG-SYSTEM_ERROR_EXCEPTION)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ERROR_EXCEPTION
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION](SYSTEM-LOG-SYSTEM_ERROR_EXCEPTION)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct(string $message, integer $code, integer $severity, string $filename, integer $lineno, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct($message, $code, $severity, $filename, $lineno, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION](SYSTEM-LOG-SYSTEM_ERROR_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION](SYSTEM-LOG-SYSTEM_ERROR_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$severity **mixed***$filename **mixed***$lineno **mixed***$previous **mixed**
|
||||
@ -1,64 +1,21 @@
|
||||
SYSTEM\LOG\INFO
|
||||
===============
|
||||
|
||||
Info Log Class provided by System for logging Infos.
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: INFO
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:INFO
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,84 +1,28 @@
|
||||
SYSTEM\LOG\JsonResult
|
||||
===============
|
||||
|
||||
JsonResult Class provided by System to return Data as JSON or MSGPACK.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: JsonResult
|
||||
* Namespace: SYSTEM\LOG
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:JsonResult
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)Constants
|
||||
----------
|
||||
###JSONRESULT_OKconst JSONRESULT_OK = true
|
||||
###JSONRESULT_ERRORconst JSONRESULT_ERROR = falseMethods
|
||||
-------
|
||||
|
||||
|
||||
### toString
|
||||
|
||||
string SYSTEM\LOG\JsonResult::toString(array $json_array, boolean $status, integer $start_time)
|
||||
|
||||
Retun JsonResult with data given by array
|
||||
###toStringmixed SYSTEM\LOG\AbstractResult::toString($json_array, $status, $start_time)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* 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**
|
||||
###errormixed SYSTEM\LOG\AbstractResult::error(\Exception $e)
|
||||
|
||||
|
||||
|
||||
### error
|
||||
|
||||
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**
|
||||
###okmixed SYSTEM\LOG\AbstractResult::ok()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $e **Exception** - <p>Exception to be convered.</p>
|
||||
|
||||
|
||||
|
||||
### ok
|
||||
|
||||
string SYSTEM\LOG\JsonResult::ok()
|
||||
|
||||
Retun JsonResult with success status
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### fail
|
||||
|
||||
string SYSTEM\LOG\JsonResult::fail()
|
||||
|
||||
Retun JsonResult with failure status
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult)
|
||||
###failmixed SYSTEM\LOG\JsonResult::fail()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
@ -1,56 +1,16 @@
|
||||
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
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION](SYSTEM-LOG-SYSTEM_ERROR_EXCEPTION)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:SHUTDOWN_EXCEPTION
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION](SYSTEM-LOG-SYSTEM_ERROR_EXCEPTION)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct(string $message, integer $code, integer $severity, string $filename, integer $lineno, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct($message, $code, $severity, $filename, $lineno, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION](SYSTEM-LOG-SYSTEM_ERROR_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION](SYSTEM-LOG-SYSTEM_ERROR_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$severity **mixed***$filename **mixed***$lineno **mixed***$previous **mixed**
|
||||
@ -1,55 +1,16 @@
|
||||
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
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: ErrorException
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:SYSTEM_ERROR_EXCEPTION
|
||||
* Namespace:SYSTEM\LOG* Parent class:ErrorExceptionProperties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct(string $message, integer $code, integer $severity, string $filename, integer $lineno, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_ERROR_EXCEPTION::__construct($message, $code, $severity, $filename, $lineno, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public**#### Arguments*$message **mixed***$code **mixed***$severity **mixed***$filename **mixed***$lineno **mixed***$previous **mixed**
|
||||
@ -1,63 +1,21 @@
|
||||
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
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: Exception
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:SYSTEM_EXCEPTION
|
||||
* Namespace:SYSTEM\LOG* Parent class:ExceptionProperties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public**#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,64 +1,21 @@
|
||||
SYSTEM\LOG\TODO
|
||||
===============
|
||||
|
||||
Todo Class provided by System for logging todos.
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: TODO
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:TODO
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,64 +1,21 @@
|
||||
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
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\ERROR](SYSTEM-LOG-ERROR)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:TranslatableError
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\ERROR](SYSTEM-LOG-ERROR)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,64 +1,21 @@
|
||||
SYSTEM\LOG\WARNING
|
||||
===============
|
||||
|
||||
Warning Class provided by System for logging Warnings.
|
||||
|
||||
All other log Classes are derived from this.
|
||||
|
||||
|
||||
* Class name: WARNING
|
||||
* Namespace: SYSTEM\LOG
|
||||
* Parent class: [SYSTEM\LOG\TODO](SYSTEM-LOG-TODO)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:WARNING
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\TODO](SYSTEM-LOG-TODO)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $logged
|
||||
|
||||
public mixed $logged = false
|
||||
|
||||
bool Variable to store if the Exception was logged already
|
||||
###$loggedpublic mixed $logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
### $todo_logged
|
||||
|
||||
public mixed $todo_logged = false
|
||||
|
||||
bool Variable to store if the Exceptions was logged as Todo
|
||||
###$todo_loggedpublic mixed $todo_logged = false
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **public**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous)
|
||||
|
||||
Construct the Error
|
||||
###__constructmixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Error Message</p>
|
||||
* $code **integer** - <p>Error Code</p>
|
||||
* $previous **Exception** - <p>Previous Error leading to this one.</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\LOG\SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION)#### Arguments*$message **mixed***$code **mixed***$previous **mixed**
|
||||
@ -1,38 +1,15 @@
|
||||
SYSTEM\LOG\error_handler
|
||||
===============
|
||||
|
||||
Error handler Interface provided by System to derive your own loghandlers from.
|
||||
|
||||
|
||||
|
||||
|
||||
* Interface name: error_handler
|
||||
* Namespace: SYSTEM\LOG
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:error_handler
|
||||
* Namespace:SYSTEM\LOGMethods
|
||||
-------
|
||||
|
||||
|
||||
### CALL
|
||||
|
||||
boolean SYSTEM\LOG\error_handler::CALL(\Exception $E, boolean $thrown)
|
||||
|
||||
Call function to handle exceptions
|
||||
###MASKmixed SYSTEM\LOG\error_handler::MASK()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###CALLmixed SYSTEM\LOG\error_handler::CALL(\Exception $E, $thrown)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$E **Exception***$thrown **mixed**
|
||||
@ -1,39 +1,15 @@
|
||||
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
|
||||
* This class implements: [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:error_handler_dbwriter
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)Methods
|
||||
-------
|
||||
|
||||
|
||||
### CALL
|
||||
|
||||
boolean SYSTEM\LOG\error_handler::CALL(\Exception $E, boolean $thrown)
|
||||
|
||||
Call function to handle exceptions
|
||||
###CALLmixed SYSTEM\LOG\error_handler::CALL(\Exception $E, $thrown)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)#### Arguments*$E **Exception***$thrown **mixed**
|
||||
###MASKmixed SYSTEM\LOG\error_handler::MASK()
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
@ -1,39 +1,15 @@
|
||||
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
|
||||
* This class implements: [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:error_handler_jsonoutput
|
||||
* Namespace:SYSTEM\LOG* Parent class:[SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)Methods
|
||||
-------
|
||||
|
||||
|
||||
### CALL
|
||||
|
||||
boolean SYSTEM\LOG\error_handler::CALL(\Exception $E, boolean $thrown)
|
||||
|
||||
Call function to handle exceptions
|
||||
###CALLmixed SYSTEM\LOG\error_handler::CALL(\Exception $E, $thrown)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)#### Arguments*$E **Exception***$thrown **mixed**
|
||||
###MASKmixed SYSTEM\LOG\error_handler::MASK()
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\LOG\error_handler](SYSTEM-LOG-error_handler)
|
||||
@ -1,154 +1,43 @@
|
||||
SYSTEM\LOG\log
|
||||
===============
|
||||
|
||||
Log Class provided by System to manage log handlers.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: log
|
||||
* Namespace: SYSTEM\LOG
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:log
|
||||
* Namespace:SYSTEM\LOGConstants
|
||||
----------
|
||||
|
||||
|
||||
### HANDLER_FUNC_CALL
|
||||
|
||||
const HANDLER_FUNC_CALL = 'CALL'
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
###HANDLER_FUNC_CALLconst HANDLER_FUNC_CALL = 'CALL'Properties
|
||||
----------
|
||||
|
||||
|
||||
### $handlers
|
||||
|
||||
private mixed $handlers = array()
|
||||
|
||||
array Variable to store all registred log handlers
|
||||
###$handlersprivate mixed $handlers = array()
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This property is **static**.
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private*** This property is **static**.Methods
|
||||
-------
|
||||
|
||||
|
||||
### registerHandler
|
||||
|
||||
null SYSTEM\LOG\log::registerHandler(\SYSTEM\LOG\class $handler)
|
||||
|
||||
Register a Log Handler
|
||||
###registerHandlermixed SYSTEM\LOG\log::registerHandler($handler)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $handler **SYSTEM\LOG\class** - <p>Classname of the handler to be registered</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$handler **mixed**
|
||||
###call_handlersmixed SYSTEM\LOG\log::call_handlers(\Exception $E, $thrown)
|
||||
|
||||
|
||||
|
||||
### call_handlers
|
||||
|
||||
boolean SYSTEM\LOG\log::call_handlers(\Exception $E, boolean $thrown)
|
||||
|
||||
Call handlers function upon error
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$E **Exception***$thrown **mixed**
|
||||
###__exception_handlermixed SYSTEM\LOG\log::__exception_handler(\Exception $E, $thrown)
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$E **Exception***$thrown **mixed**
|
||||
###__error_handlermixed SYSTEM\LOG\log::__error_handler($code, $message, $file, $line, $thrown)
|
||||
|
||||
|
||||
|
||||
### __exception_handler
|
||||
|
||||
boolean SYSTEM\LOG\log::__exception_handler(\Exception $E, boolean $thrown)
|
||||
|
||||
Exception Handler for System-log handling
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$code **mixed***$message **mixed***$file **mixed***$line **mixed***$thrown **mixed**
|
||||
###__shutdown_handlermixed SYSTEM\LOG\log::__shutdown_handler($thrown)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $E **Exception** - <p>Thrown Execption to be handled</p>
|
||||
* $thrown **boolean** - <p>Was the Exception thrown?</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$thrown **mixed**
|
||||
###__fatal_error_handlermixed SYSTEM\LOG\log::__fatal_error_handler($bufferContent, $thrown)
|
||||
|
||||
|
||||
|
||||
### __error_handler
|
||||
|
||||
boolean SYSTEM\LOG\log::__error_handler(integer $code, string $message, string $file, string $line, boolean $thrown)
|
||||
|
||||
Error Handler for System-log handling
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
boolean SYSTEM\LOG\log::__shutdown_handler(boolean $thrown)
|
||||
|
||||
Shutdown Handler for System-log handling
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $thrown **boolean** - <p>Was the Error thrown?</p>
|
||||
|
||||
|
||||
|
||||
### __fatal_error_handler
|
||||
|
||||
string SYSTEM\LOG\log::__fatal_error_handler(string $bufferContent, boolean $thrown)
|
||||
|
||||
Fatal Error Handler for System-log handling
|
||||
(unused - experimental)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $bufferContent **string** - <p>Website contens before sent to user</p>
|
||||
* $thrown **boolean** - <p>Was the Error thrown?</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$bufferContent **mixed***$thrown **mixed**
|
||||
@ -1,91 +1,10 @@
|
||||
SYSTEM\PAGE\Page
|
||||
===============
|
||||
|
||||
Page Interface provided by System to describe page functions.
|
||||
|
||||
|
||||
|
||||
|
||||
* Interface name: Page
|
||||
* Namespace: SYSTEM\PAGE
|
||||
* This is an **interface**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:Page
|
||||
* Namespace:SYSTEM\PAGE* This is an **abstract** classMethods
|
||||
-------
|
||||
|
||||
|
||||
### html
|
||||
|
||||
string SYSTEM\PAGE\Page::html()
|
||||
|
||||
Html content of the page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
|
||||
|
||||
### 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**.
|
||||
###htmlmixed SYSTEM\PAGE\Page::html()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.
|
||||
@ -1,106 +1,41 @@
|
||||
SYSTEM\PAGE\ParensParser
|
||||
===============
|
||||
|
||||
ParensParser Class provided by System to parse Statestring.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: ParensParser
|
||||
* Namespace: SYSTEM\PAGE
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:ParensParser
|
||||
* Namespace:SYSTEM\PAGEProperties
|
||||
----------
|
||||
|
||||
|
||||
### $stack
|
||||
|
||||
protected mixed $stack = null
|
||||
|
||||
something to keep track of parens nesting
|
||||
###$stackprotected mixed $stack = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
|
||||
|
||||
### $current
|
||||
|
||||
protected mixed $current = null
|
||||
|
||||
current level
|
||||
###$currentprotected mixed $current = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
|
||||
|
||||
### $string
|
||||
|
||||
protected mixed $string = null
|
||||
|
||||
input string to parse
|
||||
###$stringprotected mixed $string = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
|
||||
|
||||
### $position
|
||||
|
||||
protected mixed $position = null
|
||||
|
||||
current character offset in string
|
||||
###$positionprotected mixed $position = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
|
||||
|
||||
### $buffer_start
|
||||
|
||||
protected mixed $buffer_start = null
|
||||
|
||||
start of text-buffer
|
||||
###$buffer_startprotected mixed $buffer_start = null
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **protected**Methods
|
||||
-------
|
||||
|
||||
|
||||
### parse
|
||||
|
||||
array SYSTEM\PAGE\ParensParser::parse(string $string)
|
||||
|
||||
Parse the given string and split by () brackets and |
|
||||
###parsemixed SYSTEM\PAGE\ParensParser::parse($string)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $string **string** - <p>String to be parsed</p>
|
||||
|
||||
|
||||
|
||||
### push
|
||||
|
||||
null SYSTEM\PAGE\ParensParser::push()
|
||||
|
||||
Internal Function to push onto the stack
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
* Visibility: **public**#### Arguments*$string **mixed**
|
||||
###pushmixed SYSTEM\PAGE\ParensParser::push()
|
||||
|
||||
|
||||
|
||||
* Visibility: **protected**
|
||||
@ -1,77 +1,20 @@
|
||||
SYSTEM\PAGE\State
|
||||
===============
|
||||
|
||||
State Class provided by System to get State information.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: State
|
||||
* Namespace: SYSTEM\PAGE
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:State
|
||||
* Namespace:SYSTEM\PAGEMethods
|
||||
-------
|
||||
|
||||
|
||||
### get
|
||||
|
||||
\SYSTEM\PAGE\json SYSTEM\PAGE\State::get(integer $group, string $state, boolean $returnasjson)
|
||||
|
||||
Get a State
|
||||
###getmixed SYSTEM\PAGE\State::get($group, $state, $returnasjson)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$group **mixed***$state **mixed***$returnasjson **mixed**
|
||||
###parse_substatemixed SYSTEM\PAGE\State::parse_substate($substate)
|
||||
|
||||
|
||||
|
||||
### parse_substate
|
||||
|
||||
array SYSTEM\PAGE\State::parse_substate(string $substate)
|
||||
|
||||
Get Substates out of State string
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$substate **mixed**
|
||||
###is_loadedmixed SYSTEM\PAGE\State::is_loaded($row, $substate, $state_name, $parent_id)
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$row **mixed***$substate **mixed***$state_name **mixed***$parent_id **mixed**
|
||||
@ -1,83 +1,20 @@
|
||||
SYSTEM\PAGE\replace
|
||||
===============
|
||||
|
||||
Replace Class provided by System to replace placeholders in text and files ${placeholder}.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: replace
|
||||
* Namespace: SYSTEM\PAGE
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:replace
|
||||
* Namespace:SYSTEM\PAGEMethods
|
||||
-------
|
||||
|
||||
|
||||
### replace
|
||||
|
||||
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 **string** - <p>text to be subject of replacements</p>
|
||||
* $vars **array** - <p>Array with Placeholders.</p>
|
||||
###replacemixed SYSTEM\PAGE\replace::replace($text, $vars)
|
||||
|
||||
|
||||
|
||||
### replaceFile
|
||||
|
||||
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 **string** - <p>Filepath of file to be subject of replacements</p>
|
||||
* $vars **array** - <p>Array with Placeholders.</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$text **mixed***$vars **mixed**
|
||||
###replaceFilemixed SYSTEM\PAGE\replace::replaceFile($path, $vars)
|
||||
|
||||
|
||||
|
||||
### clean
|
||||
|
||||
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**.
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$path **mixed***$vars **mixed**
|
||||
###cleanmixed SYSTEM\PAGE\replace::clean($text)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $text **string** - <p>text to be subject of replacements</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$text **mixed**
|
||||
@ -1,216 +1,57 @@
|
||||
SYSTEM\PAGE\text
|
||||
===============
|
||||
|
||||
Text Class provided by System to get Texts from the Database.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: text
|
||||
* Namespace: SYSTEM\PAGE
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:text
|
||||
* Namespace:SYSTEM\PAGEConstants
|
||||
----------
|
||||
|
||||
|
||||
### NEW_ENTRY
|
||||
|
||||
const NEW_ENTRY = 'new_text_entry'
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
###NEW_ENTRYconst NEW_ENTRY = 'new_text_entry'Methods
|
||||
-------
|
||||
###id_tagsmixed SYSTEM\PAGE\text::id_tags($id)
|
||||
|
||||
|
||||
### id_tags
|
||||
|
||||
array SYSTEM\PAGE\text::id_tags(string $id)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id **mixed**
|
||||
###tagmixed SYSTEM\PAGE\text::tag($tag, $lang, $fallback)
|
||||
|
||||
Get the tags of a textid
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$tag **mixed***$lang **mixed***$fallback **mixed**
|
||||
###tag_advmixed SYSTEM\PAGE\text::tag_adv($tag, $lang, $fallback)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **string** - <p>textid to be checked upon</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$tag **mixed***$lang **mixed***$fallback **mixed**
|
||||
###getmixed SYSTEM\PAGE\text::get($id, $lang, $fallback)
|
||||
|
||||
|
||||
|
||||
### tag
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id **mixed***$lang **mixed***$fallback **mixed**
|
||||
###get_advmixed SYSTEM\PAGE\text::get_adv($id, $lang, $fallback)
|
||||
|
||||
array SYSTEM\PAGE\text::tag(string $tag, string $lang, boolean $fallback)
|
||||
|
||||
Get the texts with certain tag and language
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id **mixed***$lang **mixed***$fallback **mixed**
|
||||
###get_tagsmixed SYSTEM\PAGE\text::get_tags($id, $limit)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id **mixed***$limit **mixed**
|
||||
###get_latestmixed SYSTEM\PAGE\text::get_latest($tag, $limit)
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$tag **mixed***$limit **mixed**
|
||||
###searchmixed SYSTEM\PAGE\text::search($search, $tag)
|
||||
|
||||
### tag_adv
|
||||
|
||||
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
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$search **mixed***$tag **mixed**
|
||||
###savemixed SYSTEM\PAGE\text::save($id, $new_id, $lang, $tags, $text)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id **mixed***$new_id **mixed***$lang **mixed***$tags **mixed***$text **mixed**
|
||||
###deletemixed SYSTEM\PAGE\text::delete($id, $lang)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
string SYSTEM\PAGE\text::get(string $id, string $lang, boolean $fallback)
|
||||
|
||||
Get a text with certain id and language
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
array SYSTEM\PAGE\text::get_tags(string $id, integer $limit)
|
||||
|
||||
Get a tags of a text with certain id and limit the results
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **string** - <p>Id of the text requested</p>
|
||||
* $limit **integer** - <p>Amount of Tags to be requested</p>
|
||||
|
||||
|
||||
|
||||
### get_latest
|
||||
|
||||
array SYSTEM\PAGE\text::get_latest(string $tag, integer $limit)
|
||||
|
||||
Get latest texts from database by tag and limit
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $tag **string** - <p>Id of the tag requested</p>
|
||||
* $limit **integer** - <p>Amount of Texts to be requested</p>
|
||||
|
||||
|
||||
|
||||
### search
|
||||
|
||||
array SYSTEM\PAGE\text::search(string $search, string $tag)
|
||||
|
||||
Search with content of texts with given tag
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $search **string** - <p>Searchstring "%" are added inside</p>
|
||||
* $tag **string** - <p>Search only texts with given tag</p>
|
||||
|
||||
|
||||
|
||||
### save
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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
|
||||
|
||||
boolean SYSTEM\PAGE\text::delete(string $id, string $lang)
|
||||
|
||||
Delete a text from the Database.
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **string** - <p>Id of the text</p>
|
||||
* $lang **string** - <p>Language of the text</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$id **mixed***$lang **mixed**
|
||||
@ -1,102 +1,36 @@
|
||||
SYSTEM\PATH
|
||||
===============
|
||||
|
||||
Path Class provided by System to provide a unified path approach.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: PATH
|
||||
* Namespace: SYSTEM
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:PATH
|
||||
* Namespace:SYSTEMProperties
|
||||
----------
|
||||
|
||||
|
||||
### $basepath
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
###$basepathprivate mixed $basepath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $path
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
array Variable to store the path of the path object
|
||||
###$pathprivate mixed $path = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $subpath
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
###$subpathprivate mixed $subpath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
###__constructmixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
* Visibility: **public**#### Arguments*$basepath **[SYSTEM\PATH](SYSTEM-PATH)***$path **mixed***$subpath **mixed**
|
||||
###SERVERPATHmixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
###WEBPATHmixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
|
||||
|
||||
### WEBPATH
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
* Visibility: **public**#### Arguments*$mask **mixed**
|
||||
@ -1,106 +1,36 @@
|
||||
SYSTEM\PLIB
|
||||
===============
|
||||
|
||||
System Lib Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: PLIB
|
||||
* Namespace: SYSTEM
|
||||
* Parent class: [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:PLIB
|
||||
* Namespace:SYSTEM* Parent class:[SYSTEM\PATH](SYSTEM-PATH)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $basepath
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
###$basepathprivate mixed $basepath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $path
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
array Variable to store the path of the path object
|
||||
###$pathprivate mixed $path = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $subpath
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
###$subpathprivate mixed $subpath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
###__constructmixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$basepath **[SYSTEM\PATH](SYSTEM-PATH)***$path **mixed***$subpath **mixed**
|
||||
###SERVERPATHmixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)
|
||||
###WEBPATHmixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
### WEBPATH
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$mask **mixed**
|
||||
@ -1,106 +1,36 @@
|
||||
SYSTEM\PROOT
|
||||
===============
|
||||
|
||||
Root Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: PROOT
|
||||
* Namespace: SYSTEM
|
||||
* Parent class: [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:PROOT
|
||||
* Namespace:SYSTEM* Parent class:[SYSTEM\PATH](SYSTEM-PATH)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $basepath
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
###$basepathprivate mixed $basepath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $path
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
array Variable to store the path of the path object
|
||||
###$pathprivate mixed $path = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $subpath
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
###$subpathprivate mixed $subpath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
###__constructmixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$basepath **[SYSTEM\PATH](SYSTEM-PATH)***$path **mixed***$subpath **mixed**
|
||||
###SERVERPATHmixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)
|
||||
###WEBPATHmixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
### WEBPATH
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$mask **mixed**
|
||||
@ -1,106 +1,36 @@
|
||||
SYSTEM\PSAI
|
||||
===============
|
||||
|
||||
System SAI Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: PSAI
|
||||
* Namespace: SYSTEM
|
||||
* Parent class: [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:PSAI
|
||||
* Namespace:SYSTEM* Parent class:[SYSTEM\PATH](SYSTEM-PATH)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $basepath
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
###$basepathprivate mixed $basepath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $path
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
array Variable to store the path of the path object
|
||||
###$pathprivate mixed $path = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $subpath
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
###$subpathprivate mixed $subpath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
###__constructmixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$basepath **[SYSTEM\PATH](SYSTEM-PATH)***$path **mixed***$subpath **mixed**
|
||||
###SERVERPATHmixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)
|
||||
###WEBPATHmixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
### WEBPATH
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$mask **mixed**
|
||||
@ -1,106 +1,36 @@
|
||||
SYSTEM\PSQL
|
||||
===============
|
||||
|
||||
System SQL Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: PSQL
|
||||
* Namespace: SYSTEM
|
||||
* Parent class: [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:PSQL
|
||||
* Namespace:SYSTEM* Parent class:[SYSTEM\PATH](SYSTEM-PATH)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $basepath
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
###$basepathprivate mixed $basepath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $path
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
array Variable to store the path of the path object
|
||||
###$pathprivate mixed $path = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $subpath
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
###$subpathprivate mixed $subpath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
###__constructmixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$basepath **[SYSTEM\PATH](SYSTEM-PATH)***$path **mixed***$subpath **mixed**
|
||||
###SERVERPATHmixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)
|
||||
###WEBPATHmixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
### WEBPATH
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$mask **mixed**
|
||||
@ -1,106 +1,36 @@
|
||||
SYSTEM\PSYSTEM
|
||||
===============
|
||||
|
||||
System Path Class provided by System.
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: PSYSTEM
|
||||
* Namespace: SYSTEM
|
||||
* Parent class: [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:PSYSTEM
|
||||
* Namespace:SYSTEM* Parent class:[SYSTEM\PATH](SYSTEM-PATH)Properties
|
||||
----------
|
||||
|
||||
|
||||
### $basepath
|
||||
|
||||
private mixed $basepath = NULL
|
||||
|
||||
array Variable to store the base path object of the path object
|
||||
###$basepathprivate mixed $basepath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $path
|
||||
|
||||
private mixed $path = NULL
|
||||
|
||||
array Variable to store the path of the path object
|
||||
###$pathprivate mixed $path = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
### $subpath
|
||||
|
||||
private mixed $subpath = NULL
|
||||
|
||||
array Variable to store the sub path of the path object
|
||||
###$subpathprivate mixed $subpath = NULL
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private**Methods
|
||||
-------
|
||||
|
||||
|
||||
### __construct
|
||||
|
||||
mixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, string $path, string $subpath)
|
||||
|
||||
Construct the path with given basepath, path and subpath
|
||||
###__constructmixed SYSTEM\PATH::__construct(\SYSTEM\PATH $basepath, $path, $subpath)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $basepath **[SYSTEM\PATH](SYSTEM-PATH)** - <p>Basepath</p>
|
||||
* $path **string** - <p>Path</p>
|
||||
* $subpath **string** - <p>Subpath</p>
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$basepath **[SYSTEM\PATH](SYSTEM-PATH)***$path **mixed***$subpath **mixed**
|
||||
###SERVERPATHmixed SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
|
||||
|
||||
### SERVERPATH
|
||||
|
||||
string SYSTEM\PATH::SERVERPATH()
|
||||
|
||||
Calculate Serverpath of the given pathobject
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)
|
||||
###WEBPATHmixed SYSTEM\PATH::WEBPATH($mask)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
|
||||
|
||||
### WEBPATH
|
||||
|
||||
string SYSTEM\PATH::WEBPATH(boolean $mask)
|
||||
|
||||
Calculate Webpath of the given pathobject
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is defined by [SYSTEM\PATH](SYSTEM-PATH)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $mask **boolean** - <p>Mask the path using System cache functionality</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is defined by[SYSTEM\PATH](SYSTEM-PATH)#### Arguments*$mask **mixed**
|
||||
@ -1,503 +1,120 @@
|
||||
SYSTEM\SAI\SaiModule
|
||||
===============
|
||||
|
||||
SaiModule Class provided by System to be etended by Saimods
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: SaiModule
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:SaiModule
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\API\api_default](SYSTEM-API-api_default)Methods
|
||||
-------
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
|
||||
### get_apigroup
|
||||
|
||||
integer SYSTEM\API\api_default_interface::get_apigroup()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
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)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
### get_default_state
|
||||
|
||||
string SYSTEM\API\api_default_interface::get_default_state()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$_escaped_fragment_ **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
API Default State function - implement this function and return the String of the default-state
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###static__escaped_fragment_mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_)
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
* 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_statemixed 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)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
|
||||
### get_params
|
||||
|
||||
array SYSTEM\SAI\SaiModule::get_params(array $params)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
Fixes Classnames for sai postfield
|
||||
|
||||
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
|
||||
|
||||
### default_page
|
||||
* 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
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_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
* 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__($_)
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
### html_li_menu
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* 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_loginmixed 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
### right_public
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
|
||||
### right_right
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,123 +1,35 @@
|
||||
SYSTEM\SAI\default_page
|
||||
===============
|
||||
|
||||
Sai default_page Class provided by System to construct the Sai Environment
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: default_page
|
||||
* Namespace: SYSTEM\SAI
|
||||
* This class implements: [SYSTEM\PAGE\DefaultPage](SYSTEM-PAGE-DefaultPage)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:default_page
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\PAGE\Page](SYSTEM-PAGE-Page)Methods
|
||||
-------
|
||||
###menu_sysmixed SYSTEM\SAI\default_page::menu_sys()
|
||||
|
||||
|
||||
### menu_sys
|
||||
|
||||
string SYSTEM\SAI\default_page::menu_sys()
|
||||
* Visibility: **private*** This method is **static**.
|
||||
###menu_projmixed SYSTEM\SAI\default_page::menu_proj()
|
||||
|
||||
Get the System Saimod Menu
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.
|
||||
###menu_startmixed SYSTEM\SAI\default_page::menu_start()
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.
|
||||
###cssmixed SYSTEM\SAI\default_page::css()
|
||||
|
||||
|
||||
### menu_proj
|
||||
|
||||
string SYSTEM\SAI\default_page::menu_proj()
|
||||
* Visibility: **private*** This method is **static**.
|
||||
###jsmixed SYSTEM\SAI\default_page::js()
|
||||
|
||||
Get the Users Saimod Menu
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.
|
||||
###htmlmixed SYSTEM\PAGE\Page::html()
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### menu_start
|
||||
|
||||
string SYSTEM\SAI\default_page::menu_start()
|
||||
|
||||
Get the Start Saimod Menu
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
array SYSTEM\PAGE\DefaultPage::css()
|
||||
|
||||
Css files to be loaded for this page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\PAGE\DefaultPage](SYSTEM-PAGE-DefaultPage)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\PAGE\DefaultPage::js()
|
||||
|
||||
Js files to be loaded for this page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\PAGE\DefaultPage](SYSTEM-PAGE-DefaultPage)
|
||||
|
||||
|
||||
|
||||
|
||||
### html
|
||||
|
||||
string SYSTEM\PAGE\DefaultPage::html()
|
||||
|
||||
Html content of the page
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* 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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\PAGE\Page](SYSTEM-PAGE-Page)
|
||||
@ -1,182 +1,61 @@
|
||||
SYSTEM\SAI\sai
|
||||
===============
|
||||
|
||||
sai Class provided by System to register and manage saimods
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: sai
|
||||
* Namespace: SYSTEM\SAI
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
* Class name:sai
|
||||
* Namespace:SYSTEM\SAIProperties
|
||||
----------
|
||||
|
||||
|
||||
### $module_start
|
||||
|
||||
private mixed $module_start = '\SYSTEM\SAI\saistart_sys_sai'
|
||||
|
||||
string Classname of the Module which should be loaded at start
|
||||
###$module_startprivate mixed $module_start = '\SYSTEM\SAI\saistart_sys_sai'
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This property is **static**.
|
||||
|
||||
|
||||
### $modules
|
||||
|
||||
private mixed $modules = array()
|
||||
|
||||
array Classnames of all registered Sai user Modules
|
||||
* Visibility: **private*** This property is **static**.
|
||||
###$modulesprivate mixed $modules = array()
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This property is **static**.
|
||||
|
||||
|
||||
### $modules_sys
|
||||
|
||||
private mixed $modules_sys = array()
|
||||
|
||||
array Classnames of all registered Sai system Modules
|
||||
* Visibility: **private*** This property is **static**.
|
||||
###$modules_sysprivate mixed $modules_sys = array()
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This property is **static**.
|
||||
|
||||
|
||||
Methods
|
||||
* Visibility: **private*** This property is **static**.Methods
|
||||
-------
|
||||
###check_modulemixed SYSTEM\SAI\sai::check_module($module)
|
||||
|
||||
|
||||
### check_module
|
||||
|
||||
boolean SYSTEM\SAI\sai::check_module(string $module)
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$module **mixed**
|
||||
###register_startmixed SYSTEM\SAI\sai::register_start($module)
|
||||
|
||||
Check if a given SaiModuleClass is valid
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$module **mixed**
|
||||
###registermixed SYSTEM\SAI\sai::register($module)
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $module **string** - <p>Classname of the Module to be checked</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$module **mixed**
|
||||
###register_sysmixed SYSTEM\SAI\sai::register_sys($module)
|
||||
|
||||
|
||||
|
||||
### register_start
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$module **mixed**
|
||||
###getStartModulemixed SYSTEM\SAI\sai::getStartModule()
|
||||
|
||||
null SYSTEM\SAI\sai::register_start(string $module)
|
||||
|
||||
Sets the Sai Startmodule
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###getModulesmixed SYSTEM\SAI\sai::getModules()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###getSysModulesmixed SYSTEM\SAI\sai::getSysModules()
|
||||
|
||||
#### Arguments
|
||||
* $module **string** - <p>Classname of the Module to be Startmodule</p>
|
||||
|
||||
|
||||
|
||||
### register
|
||||
|
||||
null SYSTEM\SAI\sai::register(string $module)
|
||||
|
||||
Register a Sai user Module
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $module **string** - <p>Classname of the Module</p>
|
||||
|
||||
|
||||
|
||||
### register_sys
|
||||
|
||||
null SYSTEM\SAI\sai::register_sys(string $module)
|
||||
|
||||
Register a Sai system Module
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $module **string** - <p>Classname of the Module</p>
|
||||
|
||||
|
||||
|
||||
### getStartModule
|
||||
|
||||
string SYSTEM\SAI\sai::getStartModule()
|
||||
|
||||
Get the classname of the Startmodule
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### getModules
|
||||
|
||||
array SYSTEM\SAI\sai::getModules()
|
||||
|
||||
Get all classnames of the registered user saimods
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### getSysModules
|
||||
|
||||
array SYSTEM\SAI\sai::getSysModules()
|
||||
|
||||
Get all classnames of the registered system saimods
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### getAllModules
|
||||
|
||||
array SYSTEM\SAI\sai::getAllModules()
|
||||
|
||||
Get all classnames of all the registered saimods
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###getAllModulesmixed SYSTEM\SAI\sai::getAllModules()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
@ -1,43 +1,12 @@
|
||||
SYSTEM\SAI\saigui
|
||||
===============
|
||||
|
||||
saigui Class provided by System to handle sai userinterface. Invoke (new saigui)->html()
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saigui
|
||||
* Namespace: SYSTEM\SAI
|
||||
|
||||
|
||||
|
||||
Constants
|
||||
* Class name:saigui
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\PAGE\Page](SYSTEM-PAGE-Page)Constants
|
||||
----------
|
||||
|
||||
|
||||
### SAI_MOD_POSTFIELD
|
||||
|
||||
const SAI_MOD_POSTFIELD = 'sai_mod'
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
###SAI_MOD_POSTFIELDconst SAI_MOD_POSTFIELD = 'sai_mod'Methods
|
||||
-------
|
||||
|
||||
|
||||
### html
|
||||
|
||||
\SYSTEM\SAI\html SYSTEM\SAI\saigui::html()
|
||||
|
||||
Generate the HTML for the SAI Userinterface
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
###htmlmixed SYSTEM\PAGE\Page::html()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **abstract**.* This method is defined by[SYSTEM\PAGE\Page](SYSTEM-PAGE-Page)
|
||||
@ -1,673 +1,170 @@
|
||||
SYSTEM\SAI\saimod_sys_api
|
||||
===============
|
||||
|
||||
saimod_sys_api Class provided by System as saimod to manage the system_api table
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_api
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_api
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_apimixed SYSTEM\SAI\saimod_sys_api::sai_mod__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()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__system_sai_saimod_sys_api_action_listmixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_list($group)
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$group **mixed**
|
||||
###sai_mod__system_sai_saimod_sys_api_action_deletedialogmixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_deletedialog($ID, $group)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ID **mixed***$group **mixed**
|
||||
###sai_mod__system_sai_saimod_sys_api_action_newdialogmixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_newdialog()
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_list
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_list(integer $group)
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__system_sai_saimod_sys_api_action_addcallmixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_addcall($ID, $group, $type, $parentID, $parentValue, $name, $verify)
|
||||
|
||||
Generate the HTML for the List of API Entries
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ID **mixed***$group **mixed***$type **mixed***$parentID **mixed***$parentValue **mixed***$name **mixed***$verify **mixed**
|
||||
###sai_mod__system_sai_saimod_sys_api_action_deletecallmixed SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_deletecall($ID, $group)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Group Filter of the List</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ID **mixed***$group **mixed**
|
||||
###type_namesmixed SYSTEM\SAI\saimod_sys_api::type_names($type)
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_deletedialog
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$type **mixed**
|
||||
###tablerow_classmixed SYSTEM\SAI\saimod_sys_api::tablerow_class($flag)
|
||||
|
||||
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
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$flag **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
#### Arguments
|
||||
* $ID **integer** - <p>ID of the Entry</p>
|
||||
* $group **integer** - <p>Group id of the Entry</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
### 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
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###cssmixed SYSTEM\SAI\saimod_sys_api::css()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_api::js()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_addcall
|
||||
|
||||
\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
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_api_action_deletecall
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_api::sai_mod__system_sai_saimod_sys_api_action_deletecall(integer $ID, integer $group)
|
||||
* 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_)
|
||||
|
||||
Delete a API Entry
|
||||
|
||||
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ID **integer** - <p>ID of the Entry</p>
|
||||
* $group **integer** - <p>Group id of the Entry</p>
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
|
||||
|
||||
### type_names
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::type_names(integer $type)
|
||||
|
||||
Internal Function to decode Types to Strings
|
||||
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
#### Arguments
|
||||
* $type **integer** - <p>Type of the Page Entry</p>
|
||||
|
||||
|
||||
* 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
### tablerow_class
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_api::tablerow_class(integer $flag)
|
||||
|
||||
Internal Function to generate api row classes
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
* 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__($_)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $flag **integer** - <p>Flag of the API Entry</p>
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
* 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_loginmixed 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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
|
||||
### right_public
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_api::css()
|
||||
|
||||
Get all css System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_api::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,566 +1,140 @@
|
||||
SYSTEM\SAI\saimod_sys_cache
|
||||
===============
|
||||
|
||||
saimod_sys_cache Class provided by System as saimod to manage the system_cache table
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_cache
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_cache
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_cachemixed SYSTEM\SAI\saimod_sys_cache::sai_mod__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()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_cache_action_clearmixed SYSTEM\SAI\saimod_sys_cache::sai_mod__SYSTEM_SAI_saimod_sys_cache_action_clear()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###tablerow_classmixed SYSTEM\SAI\saimod_sys_cache::tablerow_class($cacheID)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$cacheID **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
### 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()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Clear the Cache
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_cache::js()
|
||||
|
||||
|
||||
### tablerow_class
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_cache::tablerow_class(integer $cacheID)
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
internal function to map CacheID to a tr class(color)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cacheID **integer** - <p>Id of the Cache</p>
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
* 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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
### right_public
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* 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__langmixed 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__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_cache::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
* 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**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
### 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_system](SYSTEM-API-api_system)#### Arguments*$id **mixed***$ident **mixed**
|
||||
###call_account_action_loginmixed 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_default_interface](SYSTEM-API-api_default_interface)
|
||||
* 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_logoutmixed 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_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
### 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_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,577 +1,145 @@
|
||||
SYSTEM\SAI\saimod_sys_config
|
||||
===============
|
||||
|
||||
saimod_sys_config Class provided by System as saimod to display the config
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_config
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_config
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_configmixed SYSTEM\SAI\saimod_sys_config::sai_mod__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()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_config_action_basicsmixed SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_basics()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_config_action_databasemixed SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_database()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_config_action_saimixed SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_sai()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_config_action_basics
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_basics()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate HTML for Menu Basics
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_config_action_database
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_database()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_config::js()
|
||||
|
||||
Generate HTML for Menu Database
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_config_action_sai
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_config::sai_mod__SYSTEM_SAI_saimod_sys_config_action_sai()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
Generate HTML for Menu SAI
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* 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_)
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
|
||||
### right_public
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* 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_pagesmixed 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
* 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__($_)
|
||||
|
||||
|
||||
|
||||
### js
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_config::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* 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_loginmixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
|
||||
|
||||
### get_apigroup
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
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_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
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
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,623 +1,150 @@
|
||||
SYSTEM\SAI\saimod_sys_cron
|
||||
===============
|
||||
|
||||
saimod_sys_cron Class provided by System as saimod to manage the system_cron table
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_cron
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_cron
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_cronmixed SYSTEM\SAI\saimod_sys_cron::sai_mod__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()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__system_sai_saimod_sys_cron_action_changemixed SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_change($cls, $status)
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cls **mixed***$status **mixed**
|
||||
###sai_mod__system_sai_saimod_sys_cron_action_addmixed SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_add($cls, $min, $hour, $day, $day_week, $month)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cls **mixed***$min **mixed***$hour **mixed***$day **mixed***$day_week **mixed***$month **mixed**
|
||||
###sai_mod__system_sai_saimod_sys_cron_action_delmixed SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_del($cls)
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_cron_action_change
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_change(string $cls, integer $status)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cls **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Change Status of a Cron Entry
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cls **string** - <p>Classname of the Cron</p>
|
||||
* $status **integer** - <p>New Status</p>
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_cron_action_run
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###cssmixed SYSTEM\SAI\saimod_sys_cron::css()
|
||||
|
||||
\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**.
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_cron::js()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
#### Arguments
|
||||
* $cls **string** - <p>Classname of the Cron</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_cron_action_add
|
||||
|
||||
\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
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
* 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_)
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_cron_action_del
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_cron::sai_mod__system_sai_saimod_sys_cron_action_del(string $cls)
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
Delete a Cron Entry
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cls **string** - <p>Classname of the Cron</p>
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
* 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
|
||||
|
||||
### right_public
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
* 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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* 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_loginmixed 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
### css
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_cron::css()
|
||||
|
||||
Get all css System Paths required for this Saimod
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_cron::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,566 +1,140 @@
|
||||
SYSTEM\SAI\saimod_sys_docu
|
||||
===============
|
||||
|
||||
saimod_sys_docu Class provided by System as saimod to display the code documentation
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_docu
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_docu
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_documixed SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_docu
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu(string $cat)
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generatemixed SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_docu_action_catmixed SYSTEM\SAI\saimod_sys_docu::sai_mod__SYSTEM_SAI_saimod_sys_docu_action_cat($cat)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>Docu selected</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
\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**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_docu::js()
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_docu_action_generate_md
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
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**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
* 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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
|
||||
### right_public
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* 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__langmixed 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__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_docu::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
* 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**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
### 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_system](SYSTEM-API-api_system)#### Arguments*$id **mixed***$ident **mixed**
|
||||
###call_account_action_loginmixed 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_default_interface](SYSTEM-API-api_default_interface)
|
||||
* 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_logoutmixed 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_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
### 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_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,606 +1,150 @@
|
||||
SYSTEM\SAI\saimod_sys_files
|
||||
===============
|
||||
|
||||
saimod_sys_files Class provided by System as saimod to manage files (files feature)
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_files
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_files
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_files_action_delmixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_del($cat, $id)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files_action_del
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_del(string $cat, string $id)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed***$id **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_files_action_rnmixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_rn($cat, $id, $newid)
|
||||
|
||||
Delete a File in a Files Directory
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed***$id **mixed***$newid **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_files_action_uploadmixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_upload($cat)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>Name of the Files Directory</p>
|
||||
* $id **string** - <p>Name of the File</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$cat **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_filesmixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files()
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files_action_rn
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_files_action_tabmixed SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_tab($name)
|
||||
|
||||
\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
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$name **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files_action_upload
|
||||
|
||||
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.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_files::js()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>Name of the Files Directory</p>
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* 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_)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_files_action_tab
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_files::sai_mod__SYSTEM_SAI_saimod_sys_files_action_tab(string $name)
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
Generate the HTML for the one Files Directory
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $name **string** - <p>Name of the Files Directory</p>
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
* 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
|
||||
|
||||
### right_public
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
* 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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* 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_loginmixed 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_files::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,535 +1,135 @@
|
||||
SYSTEM\SAI\saimod_sys_git
|
||||
===============
|
||||
|
||||
saimod_sys_git Class provided by System as saimod to display git information on the project and system
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_git
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_git
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_gitmixed SYSTEM\SAI\saimod_sys_git::sai_mod__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()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###getGitInfomixed SYSTEM\SAI\saimod_sys_git::getGitInfo()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###tablerow_classmixed SYSTEM\SAI\saimod_sys_git::tablerow_class($cacheID)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$cacheID **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
### getGitInfo
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_git::getGitInfo()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Read Git Information
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
### right_public
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
* 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_)
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* 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_statemixed 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_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
|
||||
|
||||
### get_apigroup
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
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_system](SYSTEM-API-api_system)#### Arguments*$group **mixed***$state **mixed**
|
||||
###static__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
* 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__($_)
|
||||
|
||||
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_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
* 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_loginmixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
|
||||
|
||||
### get_params
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
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_login](SYSTEM-API-api_login)#### Arguments*$rightid **mixed**
|
||||
###call_account_action_createmixed 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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
125
SYSTEM-SAI-saimod_sys_langswitcher.md
Normal file
125
SYSTEM-SAI-saimod_sys_langswitcher.md
Normal file
@ -0,0 +1,125 @@
|
||||
SYSTEM\SAI\saimod_sys_langswitcher
|
||||
===============
|
||||
* Class name:saimod_sys_langswitcher
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###lang_menumixed SYSTEM\SAI\saimod_sys_langswitcher::lang_menu($endpoint)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$endpoint **mixed**
|
||||
###get_apigroupmixed 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_classmixed 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_paramsmixed 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_pagemixed 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_statemixed 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_cronmixed 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_textmixed 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_filesmixed 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_pagesmixed 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__langmixed 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__resultmixed 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_bugmixed 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_cachemixed 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_loginmixed 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_logoutmixed 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_isloggedinmixed 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_checkmixed 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_createmixed 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**
|
||||
@ -1,810 +1,210 @@
|
||||
SYSTEM\SAI\saimod_sys_log
|
||||
===============
|
||||
|
||||
saimod_sys_log Class provided by System as saimod to manage the system_log table
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_log
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_log
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_truncatemixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_truncate()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_truncate
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_truncate()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###analyticsmixed SYSTEM\SAI\saimod_sys_log::analytics()
|
||||
|
||||
Deletes the Log Entries
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_statsmixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_systemmixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_system($filter, $db)
|
||||
|
||||
|
||||
### analytics
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_log::analytics()
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_othermixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_other($filter, $db)
|
||||
|
||||
Generates HTML for one Log Analytics Entry
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_basicmixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_basic($filter, $db)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_basicmixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_basic($filter, $db)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats()
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_requestmixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_request($filter, $db)
|
||||
|
||||
Generates HTML for the Log Analytics
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_exceptionmixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_exception($filter, $db)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_referermixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_referer($filter, $db)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_system
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_system(integer $filter, string $db)
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_visitormixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_visitor($filter, $db)
|
||||
|
||||
Get Log Analytics Data for class system
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_sucessmixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_sucess($filter, $db)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_querytimemixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_querytime($filter, $db)
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_other
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$db **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_errormixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_error($error)
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_other(integer $filter, string $db)
|
||||
|
||||
Get Log Analytics Data for class other
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$error **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_log_action_filtermixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_filter($filter, $search, $page)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$filter **mixed***$search **mixed***$page **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_logmixed SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log()
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###tablerow_classmixed SYSTEM\SAI\saimod_sys_log::tablerow_class($class)
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_basic
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_class_basic(integer $filter, string $db)
|
||||
|
||||
Get Log Analytics Data for class basic
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$class **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_basic
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_basic(integer $filter, string $db)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_log::js()
|
||||
|
||||
Get Log Analytics Data for unique basic
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_request
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_request(integer $filter, string $db)
|
||||
|
||||
Get Log Analytics Data for unique request
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* 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_)
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
|
||||
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_exception
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_exception(integer $filter, string $db)
|
||||
|
||||
Get Log Analytics Data for unqiue exception
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_referer
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_unique_referer(integer $filter, string $db)
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
Get Log Analytics Data for unique referer
|
||||
|
||||
|
||||
* 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_visitor
|
||||
* 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__($_)
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_visitor(integer $filter, string $db)
|
||||
|
||||
Get Log Analytics Data for basic visitor
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
|
||||
|
||||
* 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_loginmixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_sucess
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_sucess(integer $filter, string $db)
|
||||
|
||||
Get Log Analytics Data for basic success
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_querytime
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_stats_name_basic_querytime(integer $filter, string $db)
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
Get Log Analytics Data for basic querytime
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filter **integer** - <p>Timeiterval in seconds to cluster upon</p>
|
||||
* $db **string** - <p>DB to operate on</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_error
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_error(integer $error)
|
||||
|
||||
Generates HTML for a Log Entry
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $error **integer** - <p>ID of the Error</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log_action_filter
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log_action_filter(string $filter, string $search, integer $page)
|
||||
|
||||
Generates HTML for the Log List
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $filter **string** - <p>Classfilter</p>
|
||||
* $search **string** - <p>SearchFilter</p>
|
||||
* $page **integer** - <p>Page of the List(100 are displayed)</p>
|
||||
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_log
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_log::sai_mod__SYSTEM_SAI_saimod_sys_log()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### tablerow_class
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_log::tablerow_class(string $class)
|
||||
|
||||
Internal function to map log class to a tr class(color)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $class **string** - <p>Name of a Class</p>
|
||||
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](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**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_log::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,577 +1,155 @@
|
||||
SYSTEM\SAI\saimod_sys_login
|
||||
===============
|
||||
|
||||
saimod_sys_login Class provided by System as saimod to provide login/register functionality
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_login
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_login
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_loginmixed SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_login
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_login_action_logoutmixed SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login_action_logout()
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_login_action_loginmixed SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$username **mixed***$password_sha **mixed***$password_md5 **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_login_action_registermixed SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login_action_register($username, $password, $email, $locale)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_login_action_userinfo
|
||||
|
||||
\SYSTEM\SAI\json SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login_action_userinfo()
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$username **mixed***$password **mixed***$email **mixed***$locale **mixed**
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_login_action_userinfomixed SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login_action_userinfo()
|
||||
|
||||
Returns Users Info or NULL if not logged in
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_login_action_registerformmixed SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login_action_registerform()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_login_action_registerform
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login_action_registerform()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
Generate the HTML for the Registerform
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_login::js()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_login_action_resetpassword
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_login::sai_mod__SYSTEM_SAI_saimod_sys_login_action_resetpassword()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
Request Password Reset
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
* 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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
|
||||
### right_public
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
* 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
|
||||
|
||||
### js
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_login::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
* 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**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
|
||||
|
||||
### get_apigroup
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
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_system](SYSTEM-API-api_system)#### Arguments*$id **mixed***$ident **mixed**
|
||||
###call_account_action_loginmixed 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_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
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_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,577 +1,145 @@
|
||||
SYSTEM\SAI\saimod_sys_mod
|
||||
===============
|
||||
|
||||
saimod_sys_mod Class provided by System as saimod to display all registered saimods & libraries
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_mod
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_mod
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_mod_action_systemmixed SYSTEM\SAI\saimod_sys_mod::sai_mod__SYSTEM_SAI_saimod_sys_mod_action_system()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_mod_action_system
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_mod::sai_mod__SYSTEM_SAI_saimod_sys_mod_action_system()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_mod_action_projectmixed SYSTEM\SAI\saimod_sys_mod::sai_mod__SYSTEM_SAI_saimod_sys_mod_action_project()
|
||||
|
||||
Generate the HTML for the System Page
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_mod_action_libmixed SYSTEM\SAI\saimod_sys_mod::sai_mod__SYSTEM_SAI_saimod_sys_mod_action_lib()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_modmixed SYSTEM\SAI\saimod_sys_mod::sai_mod__SYSTEM_SAI_saimod_sys_mod()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_mod_action_project
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_mod::sai_mod__SYSTEM_SAI_saimod_sys_mod_action_project()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
Generate the HTML for the Project Page
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_mod_action_lib
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_mod::sai_mod__SYSTEM_SAI_saimod_sys_mod_action_lib()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_mod::js()
|
||||
|
||||
Generate the HTML for the Lib Page
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_mod
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_mod::sai_mod__SYSTEM_SAI_saimod_sys_mod()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* 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_)
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
|
||||
### right_public
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* 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_pagesmixed 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
* 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__($_)
|
||||
|
||||
|
||||
|
||||
### js
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_mod::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* 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_loginmixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5)
|
||||
|
||||
|
||||
|
||||
### get_apigroup
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
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_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface)
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed SYSTEM\API\api_login::call_account_action_check($rightid)
|
||||
|
||||
|
||||
|
||||
### get_default_state
|
||||
* 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
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
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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**
|
||||
@ -1,673 +1,170 @@
|
||||
SYSTEM\SAI\saimod_sys_page
|
||||
===============
|
||||
|
||||
saimod_sys_page Class provided by System as saimod to manage the system_page table
|
||||
|
||||
|
||||
|
||||
|
||||
* Class name: saimod_sys_page
|
||||
* Namespace: SYSTEM\SAI
|
||||
* Parent class: [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Methods
|
||||
* Class name:saimod_sys_page
|
||||
* Namespace:SYSTEM\SAI* Parent class:[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)Methods
|
||||
-------
|
||||
###sai_mod__SYSTEM_SAI_saimod_sys_pagemixed SYSTEM\SAI\saimod_sys_page::sai_mod__SYSTEM_SAI_saimod_sys_page()
|
||||
|
||||
|
||||
### sai_mod__SYSTEM_SAI_saimod_sys_page
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_page::sai_mod__SYSTEM_SAI_saimod_sys_page()
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__system_sai_saimod_sys_page_action_listmixed SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_list($group)
|
||||
|
||||
Generate the HTML for the Saimods startpage
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$group **mixed**
|
||||
###sai_mod__system_sai_saimod_sys_page_action_deletedialogmixed SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_deletedialog($ID, $group)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ID **mixed***$group **mixed**
|
||||
###sai_mod__system_sai_saimod_sys_page_action_newdialogmixed SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_newdialog()
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_page_action_list
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_list(integer $group)
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###sai_mod__system_sai_saimod_sys_page_action_addcallmixed SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_addcall($ID, $group, $type, $parentID, $parentValue, $name, $verify)
|
||||
|
||||
Generate the HTML for the List of Page Entries
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ID **mixed***$group **mixed***$type **mixed***$parentID **mixed***$parentValue **mixed***$name **mixed***$verify **mixed**
|
||||
###sai_mod__system_sai_saimod_sys_page_action_deletecallmixed SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_deletecall($ID, $group)
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Group Filter of the List</p>
|
||||
* Visibility: **public*** This method is **static**.#### Arguments*$ID **mixed***$group **mixed**
|
||||
###type_namesmixed SYSTEM\SAI\saimod_sys_page::type_names($type)
|
||||
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_page_action_deletedialog
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$type **mixed**
|
||||
###tablerow_classmixed SYSTEM\SAI\saimod_sys_page::tablerow_class($flag)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_deletedialog(integer $ID, integer $group)
|
||||
|
||||
Generate the HTML for the Delete Dialog of a Page Entry
|
||||
|
||||
* Visibility: **private*** This method is **static**.#### Arguments*$flag **mixed**
|
||||
###html_li_menumixed SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_publicmixed SYSTEM\SAI\SaiModule::right_public()
|
||||
|
||||
#### Arguments
|
||||
* $ID **integer** - <p>ID of the Entry</p>
|
||||
* $group **integer** - <p>Group id of the Entry</p>
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###right_rightmixed SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_page_action_newdialog
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_newdialog()
|
||||
|
||||
Generate the HTML for the New Dialog for a Page Entry
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
###cssmixed SYSTEM\SAI\saimod_sys_page::css()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###jsmixed SYSTEM\SAI\saimod_sys_page::js()
|
||||
|
||||
|
||||
|
||||
* Visibility: **public*** This method is **static**.
|
||||
###get_apigroupmixed SYSTEM\API\api_default::get_apigroup()
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_page_action_addcall
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_addcall(integer $ID, integer $group, integer $type, integer $parentID, string $parentValue, string $name, string $verify)
|
||||
|
||||
Add a new Page Entry
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###get_classmixed SYSTEM\API\api_default::get_class($params)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###get_paramsmixed SYSTEM\API\api_default::get_params($params)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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>
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)#### Arguments*$params **mixed**
|
||||
###default_pagemixed SYSTEM\API\api_default::default_page($_escaped_fragment_)
|
||||
|
||||
|
||||
### sai_mod__system_sai_saimod_sys_page_action_deletecall
|
||||
|
||||
\SYSTEM\SAI\JSON SYSTEM\SAI\saimod_sys_page::sai_mod__system_sai_saimod_sys_page_action_deletecall(integer $ID, integer $group)
|
||||
* 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_)
|
||||
|
||||
Delete a Page Entry
|
||||
|
||||
|
||||
* 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_statemixed SYSTEM\API\api_default::get_default_state()
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $ID **integer** - <p>ID of the Entry</p>
|
||||
* $group **integer** - <p>Group id of the Entry</p>
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
###call_cronmixed SYSTEM\API\api_system::call_cron()
|
||||
|
||||
|
||||
|
||||
### type_names
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
###call_textmixed SYSTEM\API\api_system::call_text($request, $lang)
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_page::type_names(integer $type)
|
||||
|
||||
Internal Function to decode Types to Strings
|
||||
|
||||
* 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_filesmixed SYSTEM\API\api_system::call_files($cat, $id)
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
|
||||
* 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_pagesmixed SYSTEM\API\api_system::call_pages($group, $state)
|
||||
|
||||
#### Arguments
|
||||
* $type **integer** - <p>Type of the Page Entry</p>
|
||||
|
||||
|
||||
* 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__langmixed SYSTEM\API\api_system::static__lang($lang)
|
||||
|
||||
### tablerow_class
|
||||
|
||||
string SYSTEM\SAI\saimod_sys_page::tablerow_class(integer $flag)
|
||||
|
||||
Internal Function to generate page row classes
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$lang **mixed**
|
||||
###static__resultmixed SYSTEM\API\api_system::static__result($result)
|
||||
|
||||
|
||||
|
||||
* Visibility: **private**
|
||||
* This method is **static**.
|
||||
* 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__($_)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $flag **integer** - <p>Flag of the Page Entry</p>
|
||||
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_system](SYSTEM-API-api_system)#### Arguments*$_ **mixed**
|
||||
###call_bugmixed SYSTEM\API\api_system::call_bug($message, $data)
|
||||
|
||||
|
||||
### html_li_menu
|
||||
|
||||
string SYSTEM\SAI\SaiModule::html_li_menu()
|
||||
* 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_cachemixed SYSTEM\API\api_system::call_cache($id, $ident)
|
||||
|
||||
Generate the <li> menu for the Saimod
|
||||
Override this
|
||||
|
||||
|
||||
* 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_loginmixed 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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
* 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_logoutmixed SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
|
||||
### right_public
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_public()
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_isloggedinmixed SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
Check public state for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
* Visibility: **public*** This method is **static**.* This method is defined by[SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
###call_account_action_checkmixed 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_createmixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale)
|
||||
|
||||
### right_right
|
||||
|
||||
boolean SYSTEM\SAI\SaiModule::right_right()
|
||||
|
||||
Check rights for the Saimod.
|
||||
|
||||
Override this
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
|
||||
|
||||
### css
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_page::css()
|
||||
|
||||
Get all css System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### js
|
||||
|
||||
array SYSTEM\SAI\saimod_sys_page::js()
|
||||
|
||||
Get all js System Paths required for this Saimod
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
|
||||
|
||||
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_class
|
||||
|
||||
string SYSTEM\API\api_default::get_class()
|
||||
|
||||
API Class function - implement this function and return the Classname
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
|
||||
|
||||
### get_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\SAI\SaiModule](SYSTEM-SAI-SaiModule)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $params **array** - <p>Params to be corrected</p>
|
||||
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
|
||||
|
||||
### static__escaped_fragment_
|
||||
|
||||
string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_)
|
||||
|
||||
Static Call handler for Hashbang-Crawling Requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_default](SYSTEM-API-api_default)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p>
|
||||
|
||||
|
||||
|
||||
### call_cron
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_cron()
|
||||
|
||||
System run Cron Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_text
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang)
|
||||
|
||||
System Text Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $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(string $cat, string $id)
|
||||
|
||||
System File Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $cat **string** - <p>File category</p>
|
||||
* $id **string** - <p>File name</p>
|
||||
|
||||
|
||||
|
||||
### call_pages
|
||||
|
||||
mixed SYSTEM\API\api_system::call_pages(integer $group, string $state)
|
||||
|
||||
System State-Pages Request Call
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $group **integer** - <p>Page Group for Statesystem</p>
|
||||
* $state **string** - <p>Full name of the State.</p>
|
||||
|
||||
|
||||
|
||||
### static__lang
|
||||
|
||||
null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang)
|
||||
|
||||
Static Call to change Language for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $lang **SYSTEM\API\lang** - <p>Language requested</p>
|
||||
|
||||
|
||||
|
||||
### static__result
|
||||
|
||||
null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result)
|
||||
|
||||
Static Call to change Result-Type for the current Session/User
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $result **SYSTEM\API\result** - <p>Resulttype</p>
|
||||
|
||||
|
||||
|
||||
### static__
|
||||
|
||||
null SYSTEM\API\api_system::static__(mixed $_)
|
||||
|
||||
Static Time-Parameter _ Call to avoid caching and API Errors for JS requests
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p>
|
||||
|
||||
|
||||
|
||||
### call_bug
|
||||
|
||||
null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data)
|
||||
|
||||
API Bug Call to report Bugs
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $message **string** - <p>Bugreport Message</p>
|
||||
* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p>
|
||||
|
||||
|
||||
|
||||
### call_cache
|
||||
|
||||
mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident)
|
||||
|
||||
API Cache Call to request cached Data (usually js and css)
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_system](SYSTEM-API-api_system)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $id **integer** - <p>Cache id to be queried</p>
|
||||
* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_login
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout()
|
||||
|
||||
System Account Logout
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_isloggedin
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin()
|
||||
|
||||
System Account isloggedin check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
|
||||
|
||||
### call_account_action_check
|
||||
|
||||
\SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid)
|
||||
|
||||
System Account Right Check
|
||||
|
||||
|
||||
|
||||
* Visibility: **public**
|
||||
* This method is **static**.
|
||||
* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login)
|
||||
|
||||
|
||||
#### Arguments
|
||||
* $rightid **integer** - <p>RightID of the right to be checked</p>
|
||||
|
||||
|
||||
|
||||
### call_account_action_create
|
||||
|
||||
\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
|
||||
|
||||
|
||||
|
||||
* 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>
|
||||
* $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>
|
||||
|
||||
|
||||
* 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