diff --git a/ApiIndex.md b/ApiIndex.md index db1cbd1..c50757b 100644 --- a/ApiIndex.md +++ b/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) diff --git a/DEPRECATED.md b/DEPRECATED.md index 85ffc8b..b487dd7 100644 --- a/DEPRECATED.md +++ b/DEPRECATED.md @@ -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** \ No newline at end of file diff --git a/ERROR.md b/ERROR.md index c19237b..bb3156e 100644 --- a/ERROR.md +++ b/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** \ No newline at end of file diff --git a/INFO.md b/INFO.md index fe81a98..e13a9d3 100644 --- a/INFO.md +++ b/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** \ No newline at end of file diff --git a/JsonResult.md b/JsonResult.md index 87e8bd4..db09621 100644 --- a/JsonResult.md +++ b/JsonResult.md @@ -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) \ No newline at end of file diff --git a/LIB-lib.md b/LIB-lib.md index 65b371f..8531a79 100644 --- a/LIB-lib.md +++ b/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**. \ No newline at end of file diff --git a/LIB-lib_controll.md b/LIB-lib_controll.md index 1bd3821..a2aa5c4 100644 --- a/LIB-lib_controll.md +++ b/LIB-lib_controll.md @@ -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**. \ No newline at end of file diff --git a/LIB-lib_css.md b/LIB-lib_css.md index c6e97d9..04a041b 100644 --- a/LIB-lib_css.md +++ b/LIB-lib_css.md @@ -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) \ No newline at end of file diff --git a/LIB-lib_js.md b/LIB-lib_js.md index 1cbdf16..42b4ec0 100644 --- a/LIB-lib_js.md +++ b/LIB-lib_js.md @@ -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) \ No newline at end of file diff --git a/LIB-lib_jscss.md b/LIB-lib_jscss.md index 0175850..e597b24 100644 --- a/LIB-lib_jscss.md +++ b/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) \ No newline at end of file diff --git a/LIB-lib_php.md b/LIB-lib_php.md index 6abb815..5e175a9 100644 --- a/LIB-lib_php.md +++ b/LIB-lib_php.md @@ -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) \ No newline at end of file diff --git a/LIB-lib_system.md b/LIB-lib_system.md index a22ffdd..08b5135 100644 --- a/LIB-lib_system.md +++ b/LIB-lib_system.md @@ -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) \ No newline at end of file diff --git a/LIB-lib_textillate.md b/LIB-lib_textillate.md new file mode 100644 index 0000000..de486a8 --- /dev/null +++ b/LIB-lib_textillate.md @@ -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) \ No newline at end of file diff --git a/SYSTEM-API-api.md b/SYSTEM-API-api.md index 4768fdd..d9b3809 100644 --- a/SYSTEM-API-api.md +++ b/SYSTEM-API-api.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-API-api_default.md b/SYSTEM-API-api_default.md index 0ae0da9..07e3085 100644 --- a/SYSTEM-API-api_default.md +++ b/SYSTEM-API-api_default.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-API-api_login.md b/SYSTEM-API-api_login.md index f7a3081..0ee22ec 100644 --- a/SYSTEM-API-api_login.md +++ b/SYSTEM-API-api_login.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-API-api_system.md b/SYSTEM-API-api_system.md index f23ddb4..f15aa82 100644 --- a/SYSTEM-API-api_system.md +++ b/SYSTEM-API-api_system.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-API-verify.md b/SYSTEM-API-verify.md index e661581..bae44fd 100644 --- a/SYSTEM-API-verify.md +++ b/SYSTEM-API-verify.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-CACHE-cache.md b/SYSTEM-CACHE-cache.md index aa3d40c..ceb53fd 100644 --- a/SYSTEM-CACHE-cache.md +++ b/SYSTEM-CACHE-cache.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-CACHE-cache_css.md b/SYSTEM-CACHE-cache_css.md index 127ffe5..2665867 100644 --- a/SYSTEM-CACHE-cache_css.md +++ b/SYSTEM-CACHE-cache_css.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-CACHE-cache_filemask.md b/SYSTEM-CACHE-cache_filemask.md index 3da5b29..7ada349 100644 --- a/SYSTEM-CACHE-cache_filemask.md +++ b/SYSTEM-CACHE-cache_filemask.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-CACHE-cache_js.md b/SYSTEM-CACHE-cache_js.md index a3358e3..ef83d43 100644 --- a/SYSTEM-CACHE-cache_js.md +++ b/SYSTEM-CACHE-cache_js.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-CACHE-cache_scss.md b/SYSTEM-CACHE-cache_scss.md index 6ff6986..a8f81cd 100644 --- a/SYSTEM-CACHE-cache_scss.md +++ b/SYSTEM-CACHE-cache_scss.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-CONFIG-config.md b/SYSTEM-CONFIG-config.md index d9a477a..0a3c6c1 100644 --- a/SYSTEM-CONFIG-config.md +++ b/SYSTEM-CONFIG-config.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-CONFIG-config_ids.md b/SYSTEM-CONFIG-config_ids.md index 6d1f68b..2d215b3 100644 --- a/SYSTEM-CONFIG-config_ids.md +++ b/SYSTEM-CONFIG-config_ids.md @@ -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 \ No newline at end of file diff --git a/SYSTEM-CRON-cron.md b/SYSTEM-CRON-cron.md index ee1356a..2f62f8b 100644 --- a/SYSTEM-CRON-cron.md +++ b/SYSTEM-CRON-cron.md @@ -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**. \ No newline at end of file diff --git a/SYSTEM-CRON-cron_cache_delete.md b/SYSTEM-CRON-cron_cache_delete.md index 6d01fe3..43580be 100644 --- a/SYSTEM-CRON-cron_cache_delete.md +++ b/SYSTEM-CRON-cron_cache_delete.md @@ -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) \ No newline at end of file diff --git a/SYSTEM-CRON-cron_log2sqlite.md b/SYSTEM-CRON-cron_log2sqlite.md index 1aeb9d0..f120ac7 100644 --- a/SYSTEM-CRON-cron_log2sqlite.md +++ b/SYSTEM-CRON-cron_log2sqlite.md @@ -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) \ No newline at end of file diff --git a/SYSTEM-CRON-cronjob.md b/SYSTEM-CRON-cronjob.md index 7d445d3..a86eda4 100644 --- a/SYSTEM-CRON-cronjob.md +++ b/SYSTEM-CRON-cronjob.md @@ -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**. \ No newline at end of file diff --git a/SYSTEM-CRON-cronstatus.md b/SYSTEM-CRON-cronstatus.md index ce30550..7983add 100644 --- a/SYSTEM-CRON-cronstatus.md +++ b/SYSTEM-CRON-cronstatus.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-CRON-crontime.md b/SYSTEM-CRON-crontime.md index d437450..119e8b9 100644 --- a/SYSTEM-CRON-crontime.md +++ b/SYSTEM-CRON-crontime.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-Connection.md b/SYSTEM-DB-Connection.md index 2401d9d..59be9ca 100644 --- a/SYSTEM-DB-Connection.md +++ b/SYSTEM-DB-Connection.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ConnectionAMQP.md b/SYSTEM-DB-ConnectionAMQP.md index 870a77c..125884e 100644 --- a/SYSTEM-DB-ConnectionAMQP.md +++ b/SYSTEM-DB-ConnectionAMQP.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ConnectionAbstr.md b/SYSTEM-DB-ConnectionAbstr.md index 76fd551..5e1eee9 100644 --- a/SYSTEM-DB-ConnectionAbstr.md +++ b/SYSTEM-DB-ConnectionAbstr.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ConnectionMYS.md b/SYSTEM-DB-ConnectionMYS.md index 95e5dc2..d116b15 100644 --- a/SYSTEM-DB-ConnectionMYS.md +++ b/SYSTEM-DB-ConnectionMYS.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ConnectionPG.md b/SYSTEM-DB-ConnectionPG.md index d988f13..fe2896a 100644 --- a/SYSTEM-DB-ConnectionPG.md +++ b/SYSTEM-DB-ConnectionPG.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ConnectionSQLite.md b/SYSTEM-DB-ConnectionSQLite.md index 4040b09..45e45e0 100644 --- a/SYSTEM-DB-ConnectionSQLite.md +++ b/SYSTEM-DB-ConnectionSQLite.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-DBInfo.md b/SYSTEM-DB-DBInfo.md index 4b1ba55..eb3ac6c 100644 --- a/SYSTEM-DB-DBInfo.md +++ b/SYSTEM-DB-DBInfo.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-DBInfoAMQP.md b/SYSTEM-DB-DBInfoAMQP.md index 43147b6..63312bd 100644 --- a/SYSTEM-DB-DBInfoAMQP.md +++ b/SYSTEM-DB-DBInfoAMQP.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-DBInfoMYS.md b/SYSTEM-DB-DBInfoMYS.md index b8a526f..493ff07 100644 --- a/SYSTEM-DB-DBInfoMYS.md +++ b/SYSTEM-DB-DBInfoMYS.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-DBInfoPG.md b/SYSTEM-DB-DBInfoPG.md index 4d4e3dc..085d211 100644 --- a/SYSTEM-DB-DBInfoPG.md +++ b/SYSTEM-DB-DBInfoPG.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-DBInfoSQLite.md b/SYSTEM-DB-DBInfoSQLite.md index 3aacccf..ae1bf38 100644 --- a/SYSTEM-DB-DBInfoSQLite.md +++ b/SYSTEM-DB-DBInfoSQLite.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-QI.md b/SYSTEM-DB-QI.md index db0ddd4..dbc0ba0 100644 --- a/SYSTEM-DB-QI.md +++ b/SYSTEM-DB-QI.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-QP.md b/SYSTEM-DB-QP.md index f64313a..8b2de04 100644 --- a/SYSTEM-DB-QP.md +++ b/SYSTEM-DB-QP.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-QQ.md b/SYSTEM-DB-QQ.md index f1b10df..ed86d16 100644 --- a/SYSTEM-DB-QQ.md +++ b/SYSTEM-DB-QQ.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-Result.md b/SYSTEM-DB-Result.md index 139ff5a..48dedc1 100644 --- a/SYSTEM-DB-Result.md +++ b/SYSTEM-DB-Result.md @@ -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**. \ No newline at end of file diff --git a/SYSTEM-DB-ResultAMQP.md b/SYSTEM-DB-ResultAMQP.md index f874e19..06763dc 100644 --- a/SYSTEM-DB-ResultAMQP.md +++ b/SYSTEM-DB-ResultAMQP.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ResultMysqli.md b/SYSTEM-DB-ResultMysqli.md index 2548722..e8c5eed 100644 --- a/SYSTEM-DB-ResultMysqli.md +++ b/SYSTEM-DB-ResultMysqli.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ResultMysqliPrepare.md b/SYSTEM-DB-ResultMysqliPrepare.md index 430ed15..d55fe37 100644 --- a/SYSTEM-DB-ResultMysqliPrepare.md +++ b/SYSTEM-DB-ResultMysqliPrepare.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ResultPostgres.md b/SYSTEM-DB-ResultPostgres.md index f07b249..e263244 100644 --- a/SYSTEM-DB-ResultPostgres.md +++ b/SYSTEM-DB-ResultPostgres.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DB-ResultSQLite.md b/SYSTEM-DB-ResultSQLite.md index 13c6fa4..e3c7e01 100644 --- a/SYSTEM-DB-ResultSQLite.md +++ b/SYSTEM-DB-ResultSQLite.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-DOCU-docu.md b/SYSTEM-DOCU-docu.md index 63f71ea..dd6b164 100644 --- a/SYSTEM-DOCU-docu.md +++ b/SYSTEM-DOCU-docu.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-FILES-files.md b/SYSTEM-FILES-files.md index 8c3fcb9..35a9b48 100644 --- a/SYSTEM-FILES-files.md +++ b/SYSTEM-FILES-files.md @@ -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** \ No newline at end of file diff --git a/SYSTEM-HEADER.md b/SYSTEM-HEADER.md index 7ae495f..41b0bc5 100644 --- a/SYSTEM-HEADER.md +++ b/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** \ No newline at end of file diff --git a/SYSTEM-HTML-html.md b/SYSTEM-HTML-html.md index 7e0a5c2..15deb73 100644 --- a/SYSTEM-HTML-html.md +++ b/SYSTEM-HTML-html.md @@ -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 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