diff --git a/ApiIndex.md b/ApiIndex.md index b6ee0a4..db1cbd1 100644 --- a/ApiIndex.md +++ b/ApiIndex.md @@ -25,7 +25,9 @@ API Index * [DBInfoMYS](SYSTEM-DB-DBInfoMYS) * SYSTEM\SQL * [SYS_TEXT_GET_ID_ADV](SYSTEM-SQL-SYS_TEXT_GET_ID_ADV) + * [SYS_SECURITY_AVAILABLE_EMAIL](SYSTEM-SQL-SYS_SECURITY_AVAILABLE_EMAIL) * [SYS_SAIMOD_CRON_SINGLE_SELECT](SYSTEM-SQL-SYS_SAIMOD_CRON_SINGLE_SELECT) + * [SYS_SECURITY_CONFIRM_EMAIL](SYSTEM-SQL-SYS_SECURITY_CONFIRM_EMAIL) * [SYS_PAGE_GROUP](SYSTEM-SQL-SYS_PAGE_GROUP) * [SYS_SAIMOD_TEXT_COUNT_TAG](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_TAG) * [system_text](SYSTEM-SQL-system_text) @@ -34,8 +36,6 @@ API Index * [SYS_TEXT_GET_ID_TAGS](SYSTEM-SQL-SYS_TEXT_GET_ID_TAGS) * [system_user_to_rights](SYSTEM-SQL-system_user_to_rights) * [SYS_SAIMOD_TODO_LIST_FREE](SYSTEM-SQL-SYS_SAIMOD_TODO_LIST_FREE) - * [DATA_SYSTEM_PAGE](SYSTEM-SQL-DATA_SYSTEM_PAGE) - * [DATA_SYSTEM_RIGHTS](SYSTEM-SQL-DATA_SYSTEM_RIGHTS) * [SYS_SAIMOD_LOG_UNIQUE_REQUEST](SYSTEM-SQL-SYS_SAIMOD_LOG_UNIQUE_REQUEST) * [SYS_SAIMOD_TODO_EDIT](SYSTEM-SQL-SYS_SAIMOD_TODO_EDIT) * [SYS_TEXT_GET_TAG](SYSTEM-SQL-SYS_TEXT_GET_TAG) @@ -50,20 +50,21 @@ API Index * [SYS_SAIMOD_SECURITY_USER_LOG](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_LOG) * [SYS_SAIMOD_API_SINGLE_SELECT](SYSTEM-SQL-SYS_SAIMOD_API_SINGLE_SELECT) * [SYS_SAIMOD_LOG_UNIQUE_EXCEPTION](SYSTEM-SQL-SYS_SAIMOD_LOG_UNIQUE_EXCEPTION) + * [DATA_SYSTEM_TEXT](SYSTEM-SQL-DATA_SYSTEM_TEXT) + * [SYS_SAIMOD_SECURITY_RENAME_USER](SYSTEM-SQL-SYS_SAIMOD_SECURITY_RENAME_USER) * [SYS_CRON_LAST_VISIT](SYSTEM-SQL-SYS_CRON_LAST_VISIT) * [SYS_SAIMOD_TODO_STATS_USERS](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_USERS) * [SYS_TEXT_DELETE_TAGS](SYSTEM-SQL-SYS_TEXT_DELETE_TAGS) * [SYS_SAIMOD_LOG_FILTERS](SYSTEM-SQL-SYS_SAIMOD_LOG_FILTERS) * [SYS_TEXT_RENAME_TAGS](SYSTEM-SQL-SYS_TEXT_RENAME_TAGS) * [SYS_SAIMOD_TEXT_COUNT_NOTAG](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_NOTAG) - * [SCHEMA_SYSTEM](SYSTEM-SQL-SCHEMA_SYSTEM) * [SYS_SAIMOD_TODO_STATS_COUNT_TODO_NOT_ASSIGNED](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_COUNT_TODO_NOT_ASSIGNED) - * [SYS_SECURITY_LOGIN_SHA1](SYSTEM-SQL-SYS_SECURITY_LOGIN_SHA1) + * [DATA_SYSTEM_API](SYSTEM-SQL-DATA_SYSTEM_API) * [SYS_SAIMOD_LOG_UNIQUE_REFERER](SYSTEM-SQL-SYS_SAIMOD_LOG_UNIQUE_REFERER) * [SYS_SAIMOD_TODO_STATS_COUNT_DOTO_GEN](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_COUNT_DOTO_GEN) * [SYS_TEXT_GET_ID](SYSTEM-SQL-SYS_TEXT_GET_ID) + * [SYS_SAIMOD_SECURITY_DELETE_USER](SYSTEM-SQL-SYS_SAIMOD_SECURITY_DELETE_USER) * [SYS_SAIMOD_LOG_ANALYTICS](SYSTEM-SQL-SYS_SAIMOD_LOG_ANALYTICS) - * [DATA_SYSTEM_CRON](SYSTEM-SQL-DATA_SYSTEM_CRON) * [SYS_SAIMOD_TEXT_TEXT_TAG_FILTER](SYSTEM-SQL-SYS_SAIMOD_TEXT_TEXT_TAG_FILTER) * [SYS_SAIMOD_TODO_TODO](SYSTEM-SQL-SYS_SAIMOD_TODO_TODO) * [SYS_SAIMOD_TODO_DEASSIGN](SYSTEM-SQL-SYS_SAIMOD_TODO_DEASSIGN) @@ -72,7 +73,6 @@ API Index * [SYS_SAIMOD_TODO_COUNT_FREE](SYSTEM-SQL-SYS_SAIMOD_TODO_COUNT_FREE) * [SYS_SAIMOD_TEXT_COUNT_NOTAG_FILTER](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_NOTAG_FILTER) * [SYS_API_TREE](SYSTEM-SQL-SYS_API_TREE) - * [DATA_SYSTEM_TEXT](SYSTEM-SQL-DATA_SYSTEM_TEXT) * [SYS_CACHE_CHECK](SYSTEM-SQL-SYS_CACHE_CHECK) * [system_user](SYSTEM-SQL-system_user) * [SYS_SAIMOD_TEXT_COUNT](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT) @@ -80,6 +80,7 @@ API Index * [SYS_TEXT_GET_ID_COUNT](SYSTEM-SQL-SYS_TEXT_GET_ID_COUNT) * [SYS_SAIMOD_PAGE_ADD](SYSTEM-SQL-SYS_SAIMOD_PAGE_ADD) * [setup](SYSTEM-SQL-setup) + * [SYS_SECURITY_RESET_PASSWORD](SYSTEM-SQL-SYS_SECURITY_RESET_PASSWORD) * [SYS_SECURITY_UPDATE_PW](SYSTEM-SQL-SYS_SECURITY_UPDATE_PW) * [SYS_SAIMOD_LOG_ERROR](SYSTEM-SQL-SYS_SAIMOD_LOG_ERROR) * [system_cron](SYSTEM-SQL-system_cron) @@ -95,6 +96,7 @@ API Index * [SYS_SAIMOD_SECURITY_USERS_FILTER](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USERS_FILTER) * [SYS_SAIMOD_TEXT_TEXT](SYSTEM-SQL-SYS_SAIMOD_TEXT_TEXT) * [SYS_SAIMOD_TODO_COUNT](SYSTEM-SQL-SYS_SAIMOD_TODO_COUNT) + * [DATA_SYSTEM_RIGHTS](SYSTEM-SQL-DATA_SYSTEM_RIGHTS) * [SYS_SECURITY_CREATE](SYSTEM-SQL-SYS_SECURITY_CREATE) * [SYS_SECURITY_UPDATE_LASTACTIVE](SYSTEM-SQL-SYS_SECURITY_UPDATE_LASTACTIVE) * [SYS_SAIMOD_TEXT_TEXT_NOTAG](SYSTEM-SQL-SYS_SAIMOD_TEXT_TEXT_NOTAG) @@ -102,6 +104,7 @@ API Index * [SYS_SAIMOD_CACHE_CLEAR](SYSTEM-SQL-SYS_SAIMOD_CACHE_CLEAR) * [SYS_SAIMOD_TODO_STATS_COUNT_DOTO_REPORT](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_COUNT_DOTO_REPORT) * [SYS_SAIMOD_TODO_COUNT_TYPE](SYSTEM-SQL-SYS_SAIMOD_TODO_COUNT_TYPE) + * [DATA_SYSTEM_CRON](SYSTEM-SQL-DATA_SYSTEM_CRON) * [SYS_SAIMOD_CACHE_COUNT](SYSTEM-SQL-SYS_SAIMOD_CACHE_COUNT) * [SYS_SAIMOD_TODO_CLOSE_ALL](SYSTEM-SQL-SYS_SAIMOD_TODO_CLOSE_ALL) * [SYS_SAIMOD_LOG_BASIC_QUERYTIME](SYSTEM-SQL-SYS_SAIMOD_LOG_BASIC_QUERYTIME) @@ -109,6 +112,7 @@ API Index * [SYS_SAIMOD_TODO_CLOSE](SYSTEM-SQL-SYS_SAIMOD_TODO_CLOSE) * [SYS_TEXT_DELETE](SYSTEM-SQL-SYS_TEXT_DELETE) * [SYS_SAIMOD_SECURITY_USER_COUNT_FILTER](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_COUNT_FILTER) + * [SYS_SECURITY_USER_INFO](SYSTEM-SQL-SYS_SECURITY_USER_INFO) * [SYS_SAIMOD_SECURITY_USER_RIGHTS](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_RIGHTS) * [SYS_CACHE_PUT](SYSTEM-SQL-SYS_CACHE_PUT) * [SYS_LOG_INSERT](SYSTEM-SQL-SYS_LOG_INSERT) @@ -132,27 +136,34 @@ API Index * [SYS_SAIMOD_TODO_STATS_COUNT_DOTO_USER](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_COUNT_DOTO_USER) * [SYS_SAIMOD_LOG_UNIQUE_BASIC](SYSTEM-SQL-SYS_SAIMOD_LOG_UNIQUE_BASIC) * [SYS_SAIMOD_TODO_STATS_CLOSED](SYSTEM-SQL-SYS_SAIMOD_TODO_STATS_CLOSED) + * [SYS_TOKEN_INSERT](SYSTEM-SQL-SYS_TOKEN_INSERT) * [SYS_SAIMOD_LOG_TRUNCATE](SYSTEM-SQL-SYS_SAIMOD_LOG_TRUNCATE) * [SYS_SAIMOD_TODO_ASSIGNEES](SYSTEM-SQL-SYS_SAIMOD_TODO_ASSIGNEES) * [SYS_SAIMOD_SECURITY_RIGHT_DELETE](SYSTEM-SQL-SYS_SAIMOD_SECURITY_RIGHT_DELETE) - * [DATA_SYSTEM_API](SYSTEM-SQL-DATA_SYSTEM_API) * [SYS_SAIMOD_LOG_BASIC_SUCCESS](SYSTEM-SQL-SYS_SAIMOD_LOG_BASIC_SUCCESS) * [SYS_SAIMOD_LOG_CLASS_OTHER](SYSTEM-SQL-SYS_SAIMOD_LOG_CLASS_OTHER) * [SYS_CRON_GET](SYSTEM-SQL-SYS_CRON_GET) + * [SCHEMA_SYSTEM](SYSTEM-SQL-SCHEMA_SYSTEM) * [SYS_SAIMOD_CRON_CHANGE](SYSTEM-SQL-SYS_SAIMOD_CRON_CHANGE) * [SYS_SAIMOD_TODO_ASSIGN](SYSTEM-SQL-SYS_SAIMOD_TODO_ASSIGN) * [system_log](SYSTEM-SQL-system_log) * [SYS_CRON_UPD](SYSTEM-SQL-SYS_CRON_UPD) + * [SYS_SECURITY_CHANGE_EMAIL](SYSTEM-SQL-SYS_SECURITY_CHANGE_EMAIL) + * [SYS_TOKEN_GET](SYSTEM-SQL-SYS_TOKEN_GET) + * [SYS_TOKEN_CONFIRM](SYSTEM-SQL-SYS_TOKEN_CONFIRM) * [SYS_SAIMOD_API_GROUPS](SYSTEM-SQL-SYS_SAIMOD_API_GROUPS) * [SYS_SAIMOD_SECURITY_USER_COUNT](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_COUNT) * [SYS_TEXT_SAVE_TAG](SYSTEM-SQL-SYS_TEXT_SAVE_TAG) * [SYS_TEXT_GET_TAG_ADV](SYSTEM-SQL-SYS_TEXT_GET_TAG_ADV) + * [SYS_SECURITY_USER_SESSIONID](SYSTEM-SQL-SYS_SECURITY_USER_SESSIONID) * [SYS_SAIMOD_TEXT_COUNT_FILTER](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_FILTER) + * [DATA_SYSTEM_PAGE](SYSTEM-SQL-DATA_SYSTEM_PAGE) * [SYS_LOG_OLDEST](SYSTEM-SQL-SYS_LOG_OLDEST) - * [SYS_SECURITY_LOGIN_MD5](SYSTEM-SQL-SYS_SECURITY_LOGIN_MD5) * [SYS_TEXT_SEARCH_TAG](SYSTEM-SQL-SYS_TEXT_SEARCH_TAG) + * [SYS_SAIMOD_SECURITY_DELETE_USER_RIGHTS](SYSTEM-SQL-SYS_SAIMOD_SECURITY_DELETE_USER_RIGHTS) * [SYS_SAIMOD_TEXT_COUNT_TAG_FILTER](SYSTEM-SQL-SYS_SAIMOD_TEXT_COUNT_TAG_FILTER) * [SYS_SAIMOD_LOG_BASIC_VISITOR](SYSTEM-SQL-SYS_SAIMOD_LOG_BASIC_VISITOR) + * [SYS_SECURITY_LOGIN_USER_SHA1](SYSTEM-SQL-SYS_SECURITY_LOGIN_USER_SHA1) * [SYS_LOCALE_SET_LOCALE](SYSTEM-SQL-SYS_LOCALE_SET_LOCALE) * [SYS_SAIMOD_LOG_FILTER](SYSTEM-SQL-SYS_SAIMOD_LOG_FILTER) * [SYS_SAIMOD_SECURITY_USER_RIGHT_DELETE](SYSTEM-SQL-SYS_SAIMOD_SECURITY_USER_RIGHT_DELETE) @@ -167,6 +178,7 @@ API Index * [SYS_SAIMOD_CRON](SYSTEM-SQL-SYS_SAIMOD_CRON) * [SYS_SAIMOD_CRON_DEL](SYSTEM-SQL-SYS_SAIMOD_CRON_DEL) * [SYS_SAIMOD_API_GET](SYSTEM-SQL-SYS_SAIMOD_API_GET) + * [DATA_DEFAULT](SYSTEM-SQL-DATA_DEFAULT) * [SYS_CACHE_DELETE](SYSTEM-SQL-SYS_CACHE_DELETE) * [SYS_SAIMOD_TODO_LIST_MINE](SYSTEM-SQL-SYS_SAIMOD_TODO_LIST_MINE) * SYSTEM\SAI @@ -193,12 +205,11 @@ API Index * [SaiModule](SYSTEM-SAI-SaiModule) * [saimod_sys_git](SYSTEM-SAI-saimod_sys_git) * [todo_stats](SYSTEM-SAI-todo_stats) - * [saimod_sys_langswitcher](SYSTEM-SAI-saimod_sys_langswitcher) * [saimod_sys_text](SYSTEM-SAI-saimod_sys_text) * [saimod_sys_config](SYSTEM-SAI-saimod_sys_config) * SYSTEM\SECURITY * [RIGHTS](SYSTEM-SECURITY-RIGHTS) - * [Security](SYSTEM-SECURITY-Security) + * [security](SYSTEM-SECURITY-security) * [User](SYSTEM-SECURITY-User) * [system](SYSTEM-system) * SYSTEM\PAGE @@ -206,9 +217,12 @@ API Index * [Page](SYSTEM-PAGE-Page) * [State](SYSTEM-PAGE-State) * [ParensParser](SYSTEM-PAGE-ParensParser) + * [DefaultPage](SYSTEM-PAGE-DefaultPage) * [replace](SYSTEM-PAGE-replace) * SYSTEM\DOCU * [docu](SYSTEM-DOCU-docu) + * [docu_system](SYSTEM-DOCU-docu_system) + * [docu_package](SYSTEM-DOCU-docu_package) * SYSTEM\LOG * [error_handler_jsonoutput](SYSTEM-LOG-error_handler_jsonoutput) * [ERROR_EXCEPTION](SYSTEM-LOG-ERROR_EXCEPTION) @@ -219,7 +233,6 @@ API Index * [TranslatableError](SYSTEM-LOG-TranslatableError) * [SYSTEM_EXCEPTION](SYSTEM-LOG-SYSTEM_EXCEPTION) * [error_handler](SYSTEM-LOG-error_handler) - * [AbstractResult](SYSTEM-LOG-AbstractResult) * [INFO](SYSTEM-LOG-INFO) * [TODO](SYSTEM-LOG-TODO) * [COUNTER](SYSTEM-LOG-COUNTER) @@ -228,10 +241,17 @@ API Index * [error_handler_dbwriter](SYSTEM-LOG-error_handler_dbwriter) * [CRON](SYSTEM-LOG-CRON) * [WARNING](SYSTEM-LOG-WARNING) + * SYSTEM\TOKEN + * [token](SYSTEM-TOKEN-token) + * [token_change_email](SYSTEM-TOKEN-token_change_email) + * [token_confirm_email](SYSTEM-TOKEN-token_confirm_email) + * [token_handler](SYSTEM-TOKEN-token_handler) + * [token_reset_password](SYSTEM-TOKEN-token_reset_password) * SYSTEM\API * [api_system](SYSTEM-API-api_system) * [api](SYSTEM-API-api) * [api_login](SYSTEM-API-api_login) + * [api_default_interface](SYSTEM-API-api_default_interface) * [api_default](SYSTEM-API-api_default) * [verify](SYSTEM-API-verify) * [PATH](SYSTEM-PATH) @@ -267,7 +287,6 @@ API Index * [TODO](TODO) * [ERROR](ERROR) * LIB - * [lib_textillate](LIB-lib_textillate) * [lib_css](LIB-lib_css) * [lib_jscss](LIB-lib_jscss) * [lib_php](LIB-lib_php) diff --git a/DEPRECATED.md b/DEPRECATED.md index f7e4503..85ffc8b 100644 --- a/DEPRECATED.md +++ b/DEPRECATED.md @@ -1,9 +1,9 @@ DEPRECATED =============== +Deprecated Log Class provided by System for marking code as Deprecated. - - +All other log Classes are derived from this. * Class name: DEPRECATED @@ -22,7 +22,7 @@ Properties public mixed $logged = false - +bool Variable to store if the Exception was logged already @@ -33,7 +33,7 @@ Properties public mixed $todo_logged = false - +bool Variable to store if the Exceptions was logged as Todo @@ -46,9 +46,9 @@ Methods ### __construct - mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous) - + mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous) +Construct the Error @@ -57,8 +57,8 @@ Methods #### Arguments -* $message **mixed** -* $code **mixed** -* $previous **mixed** +* $message **string** - <p>Error Message</p> +* $code **integer** - <p>Error Code</p> +* $previous **Exception** - <p>Previous Error leading to this one.</p> diff --git a/ERROR.md b/ERROR.md index 4f8374d..c19237b 100644 --- a/ERROR.md +++ b/ERROR.md @@ -1,9 +1,9 @@ ERROR =============== +Error Log Class provided by System for all kinds of Errors. - - +All other log Classes are derived from this. * Class name: ERROR @@ -22,7 +22,7 @@ Properties public mixed $logged = false - +bool Variable to store if the Exception was logged already @@ -33,7 +33,7 @@ Properties public mixed $todo_logged = false - +bool Variable to store if the Exceptions was logged as Todo @@ -46,9 +46,9 @@ Methods ### __construct - mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous) - + mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous) +Construct the Error @@ -57,8 +57,8 @@ Methods #### Arguments -* $message **mixed** -* $code **mixed** -* $previous **mixed** +* $message **string** - <p>Error Message</p> +* $code **integer** - <p>Error Code</p> +* $previous **Exception** - <p>Previous Error leading to this one.</p> diff --git a/INFO.md b/INFO.md index b7570a0..fe81a98 100644 --- a/INFO.md +++ b/INFO.md @@ -1,9 +1,9 @@ INFO =============== +Info Log Class provided by System for logging Infos. - - +All other log Classes are derived from this. * Class name: INFO @@ -22,7 +22,7 @@ Properties public mixed $logged = false - +bool Variable to store if the Exception was logged already @@ -33,7 +33,7 @@ Properties public mixed $todo_logged = false - +bool Variable to store if the Exceptions was logged as Todo @@ -46,9 +46,9 @@ Methods ### __construct - mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct($message, $code, $previous) - + mixed SYSTEM\LOG\SYSTEM_EXCEPTION::__construct(string $message, integer $code, \Exception $previous) +Construct the Error @@ -57,8 +57,8 @@ Methods #### Arguments -* $message **mixed** -* $code **mixed** -* $previous **mixed** +* $message **string** - <p>Error Message</p> +* $code **integer** - <p>Error Code</p> +* $previous **Exception** - <p>Previous Error leading to this one.</p> diff --git a/JsonResult.md b/JsonResult.md index 45bbc49..87e8bd4 100644 --- a/JsonResult.md +++ b/JsonResult.md @@ -1,7 +1,7 @@ JsonResult =============== - +JsonResult Class provided by System to return Data as JSON or MSGPACK. @@ -12,24 +12,6 @@ JsonResult -Constants ----------- - - -### JSONRESULT_OK - - const JSONRESULT_OK = true - - - - - -### JSONRESULT_ERROR - - const JSONRESULT_ERROR = false - - - @@ -40,62 +22,62 @@ Methods ### toString - mixed SYSTEM\LOG\AbstractResult::toString($json_array, $status, $start_time) - + string SYSTEM\LOG\JsonResult::toString(array $json_array, boolean $status, integer $start_time) +Retun JsonResult with data given by array * Visibility: **public** * This method is **static**. -* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult) +* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult) #### Arguments -* $json_array **mixed** -* $status **mixed** -* $start_time **mixed** +* $json_array **array** - <p>Data which should be included in the JSOn Result.</p> +* $status **boolean** - <p>true or false depending on success</p> +* $start_time **integer** - <p>To calculate Querytime - if Null System time is used.</p> ### error - mixed SYSTEM\LOG\AbstractResult::error(\Exception $e) - + string SYSTEM\LOG\JsonResult::error(\Exception $e) +Retun JsonResult for given Exception * Visibility: **public** * This method is **static**. -* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult) +* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult) #### Arguments -* $e **Exception** +* $e **Exception** - <p>Exception to be convered.</p> ### ok - mixed SYSTEM\LOG\AbstractResult::ok() - - - - - -* Visibility: **public** -* This method is **static**. -* This method is defined by [SYSTEM\LOG\AbstractResult](SYSTEM-LOG-AbstractResult) - - - - -### fail - - mixed SYSTEM\LOG\JsonResult::fail() - + string SYSTEM\LOG\JsonResult::ok() +Retun JsonResult with success status + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\LOG\JsonResult](SYSTEM-LOG-JsonResult) + + + + +### fail + + string SYSTEM\LOG\JsonResult::fail() + +Retun JsonResult with failure status diff --git a/LIB-lib.md b/LIB-lib.md index d8b258d..65b371f 100644 --- a/LIB-lib.md +++ b/LIB-lib.md @@ -1,7 +1,7 @@ LIB\lib =============== - +Lib Class provided by System to define API to load libs. @@ -22,9 +22,9 @@ Methods ### php - mixed LIB\lib::php() - + boolean LIB\lib::php() +Call php lib include @@ -36,9 +36,9 @@ Methods ### css - mixed LIB\lib::css() - + string LIB\lib::css() +Call css lib include @@ -50,9 +50,9 @@ Methods ### js - mixed LIB\lib::js() - + string LIB\lib::js() +Call js lib include @@ -64,9 +64,9 @@ Methods ### version - mixed LIB\lib::version() - + string LIB\lib::version() +Default Version for every lib if not overritten by derived class diff --git a/LIB-lib_controll.md b/LIB-lib_controll.md index a1b5a9d..1bd3821 100644 --- a/LIB-lib_controll.md +++ b/LIB-lib_controll.md @@ -1,7 +1,7 @@ LIB\lib_controll =============== - +lib_controll Class provided by System to register libs. @@ -21,7 +21,7 @@ Properties private mixed $libs = array() - +array Variable to store all registred libs @@ -35,9 +35,9 @@ Methods ### check_lib - mixed LIB\lib_controll::check_lib($lib) - + boolean LIB\lib_controll::check_lib(string $lib) +Check if given class is a valid lib @@ -46,15 +46,15 @@ Methods #### Arguments -* $lib **mixed** +* $lib **string** - <p>Lib Class</p> ### register - mixed LIB\lib_controll::register($classname) - + null LIB\lib_controll::register(string $classname) +Register given class as lib @@ -63,15 +63,15 @@ Methods #### Arguments -* $classname **mixed** +* $classname **string** - <p>Lib Class</p> ### all - mixed LIB\lib_controll::all() - + array LIB\lib_controll::all() +Get all registered libs available diff --git a/LIB-lib_css.md b/LIB-lib_css.md index 74654b6..c6e97d9 100644 --- a/LIB-lib_css.md +++ b/LIB-lib_css.md @@ -1,7 +1,7 @@ LIB\lib_css =============== - +css lib Class provided by System to provide css libs. @@ -23,9 +23,9 @@ Methods ### css_path - mixed LIB\lib_css::css_path() - + string LIB\lib_css::css_path() +Get Css lib include path @@ -37,9 +37,9 @@ Methods ### php - mixed LIB\lib::php() - + boolean LIB\lib::php() +Call php lib include @@ -52,9 +52,9 @@ Methods ### css - mixed LIB\lib::css() - + string LIB\lib::css() +Call css lib include @@ -67,9 +67,9 @@ Methods ### js - mixed LIB\lib::js() - + string LIB\lib::js() +Call js lib include @@ -82,9 +82,9 @@ Methods ### version - mixed LIB\lib::version() - + string LIB\lib::version() +Default Version for every lib if not overritten by derived class diff --git a/LIB-lib_js.md b/LIB-lib_js.md index 793083a..1cbdf16 100644 --- a/LIB-lib_js.md +++ b/LIB-lib_js.md @@ -1,7 +1,7 @@ LIB\lib_js =============== - +js lib Class provided by System to provide js libs. @@ -23,9 +23,9 @@ Methods ### js_path - mixed LIB\lib_js::js_path() - + string LIB\lib_js::js_path() +Get js lib include path @@ -37,9 +37,9 @@ Methods ### php - mixed LIB\lib::php() - + boolean LIB\lib::php() +Call php lib include @@ -52,9 +52,9 @@ Methods ### css - mixed LIB\lib::css() - + string LIB\lib::css() +Call css lib include @@ -67,9 +67,9 @@ Methods ### js - mixed LIB\lib::js() - + string LIB\lib::js() +Call js lib include @@ -82,9 +82,9 @@ Methods ### version - mixed LIB\lib::version() - + string LIB\lib::version() +Default Version for every lib if not overritten by derived class diff --git a/LIB-lib_jscss.md b/LIB-lib_jscss.md index 036f725..0175850 100644 --- a/LIB-lib_jscss.md +++ b/LIB-lib_jscss.md @@ -1,7 +1,7 @@ LIB\lib_jscss =============== - +js+css lib Class provided by System to provide js+css libs. @@ -23,9 +23,9 @@ Methods ### js_path - mixed LIB\lib_jscss::js_path() - + string LIB\lib_jscss::js_path() +Get js lib include path @@ -37,9 +37,9 @@ Methods ### css_path - mixed LIB\lib_jscss::css_path() - + string LIB\lib_jscss::css_path() +Get Css lib include path @@ -51,9 +51,9 @@ Methods ### php - mixed LIB\lib::php() - + boolean LIB\lib::php() +Call php lib include @@ -66,9 +66,9 @@ Methods ### css - mixed LIB\lib::css() - + string LIB\lib::css() +Call css lib include @@ -81,9 +81,9 @@ Methods ### js - mixed LIB\lib::js() - + string LIB\lib::js() +Call js lib include @@ -96,9 +96,9 @@ Methods ### version - mixed LIB\lib::version() - + string LIB\lib::version() +Default Version for every lib if not overritten by derived class diff --git a/LIB-lib_php.md b/LIB-lib_php.md index 93dd2c2..6abb815 100644 --- a/LIB-lib_php.md +++ b/LIB-lib_php.md @@ -1,7 +1,7 @@ LIB\lib_php =============== - +php lib Class provided by System to provide php libs. @@ -23,9 +23,9 @@ Methods ### php_autoload - mixed LIB\lib_php::php_autoload() - + null LIB\lib_php::php_autoload() +include the php files to be used @@ -37,9 +37,9 @@ Methods ### php - mixed LIB\lib::php() - + boolean LIB\lib::php() +Call php lib include @@ -52,9 +52,9 @@ Methods ### css - mixed LIB\lib::css() - + string LIB\lib::css() +Call css lib include @@ -67,9 +67,9 @@ Methods ### js - mixed LIB\lib::js() - + string LIB\lib::js() +Call js lib include @@ -82,9 +82,9 @@ Methods ### version - mixed LIB\lib::version() - + string LIB\lib::version() +Default Version for every lib if not overritten by derived class diff --git a/LIB-lib_system.md b/LIB-lib_system.md index 537db23..a22ffdd 100644 --- a/LIB-lib_system.md +++ b/LIB-lib_system.md @@ -1,7 +1,7 @@ LIB\lib_system =============== - +lib_system Class provided by System to serve system.js and system.css library. @@ -22,9 +22,9 @@ Methods ### get_class - mixed LIB\lib_system::get_class() - + string LIB\lib_system::get_class() +Get Classname of the Library @@ -36,9 +36,9 @@ Methods ### js_path - mixed LIB\lib_jscss::js_path() - + string LIB\lib_jscss::js_path() +Get js lib include path @@ -51,9 +51,9 @@ Methods ### css_path - mixed LIB\lib_jscss::css_path() - + string LIB\lib_jscss::css_path() +Get Css lib include path @@ -66,9 +66,9 @@ Methods ### version - mixed LIB\lib::version() - + string LIB\lib::version() +Default Version for every lib if not overritten by derived class @@ -81,9 +81,9 @@ Methods ### php - mixed LIB\lib::php() - + boolean LIB\lib::php() +Call php lib include @@ -96,9 +96,9 @@ Methods ### css - mixed LIB\lib::css() - + string LIB\lib::css() +Call css lib include @@ -111,9 +111,9 @@ Methods ### js - mixed LIB\lib::js() - + string LIB\lib::js() +Call js lib include diff --git a/LIB-lib_textillate.md b/LIB-lib_textillate.md deleted file mode 100644 index adb7547..0000000 --- a/LIB-lib_textillate.md +++ /dev/null @@ -1,110 +0,0 @@ -LIB\lib_textillate -=============== - - - - - - -* Class name: lib_textillate -* Namespace: LIB -* Parent class: [LIB\lib_js](LIB-lib_js) - - - - - - - -Methods -------- - - -### get_class - - mixed LIB\lib_textillate::get_class() - - - - - -* Visibility: **public** -* This method is **static**. - - - - -### js_path - - mixed LIB\lib_js::js_path() - - - - - -* Visibility: **protected** -* This method is **static**. -* This method is defined by [LIB\lib_js](LIB-lib_js) - - - - -### version - - mixed LIB\lib::version() - - - - - -* Visibility: **public** -* This method is **static**. -* This method is defined by [LIB\lib](LIB-lib) - - - - -### php - - mixed LIB\lib::php() - - - - - -* Visibility: **public** -* This method is **static**. -* This method is defined by [LIB\lib](LIB-lib) - - - - -### css - - mixed LIB\lib::css() - - - - - -* Visibility: **public** -* This method is **static**. -* This method is defined by [LIB\lib](LIB-lib) - - - - -### js - - mixed LIB\lib::js() - - - - - -* Visibility: **public** -* This method is **static**. -* This method is defined by [LIB\lib](LIB-lib) - - - diff --git a/SYSTEM-API-api.md b/SYSTEM-API-api.md index d1af27e..4768fdd 100644 --- a/SYSTEM-API-api.md +++ b/SYSTEM-API-api.md @@ -1,7 +1,7 @@ SYSTEM\API\api =============== - +API Class provided by System for Smart API's. @@ -55,9 +55,9 @@ Methods ### run - mixed SYSTEM\API\api::run($verifyclassname, $apiclassname, $params, $group, $strict, $default) - + mixed SYSTEM\API\api::run(string $verifyclassname, string $apiclassname, array $params, integer $group, boolean $strict, boolean $default) +Run the API Mechanism with your Data. @@ -66,20 +66,20 @@ Methods #### Arguments -* $verifyclassname **mixed** -* $apiclassname **mixed** -* $params **mixed** -* $group **mixed** -* $strict **mixed** -* $default **mixed** +* $verifyclassname **string** - <p>Your class on which the parameter restriction is parsed upon</p> +* $apiclassname **string** - <p>Your class which provides your API</p> +* $params **array** - <p>Parameters given to the API</p> +* $group **integer** - <p>API Group to be used to parse Call</p> +* $strict **boolean** - <p>Parse the API in a strict way</p> +* $default **boolean** - <p>Defaulting to default_page setting</p> ### getApiTree - mixed SYSTEM\API\api::getApiTree($group) - + array SYSTEM\API\api::getApiTree(integer $group) +Internal API function to retrive the Databasetree for requested API @@ -88,15 +88,15 @@ Methods #### Arguments -* $group **mixed** +* $group **integer** - <p>API Group to be read</p> ### do_statics - mixed SYSTEM\API\api::do_statics($params, $tree, $apiclassname, $verifyclassname, $default) - + array SYSTEM\API\api::do_statics(array $params, array $tree, string $apiclassname, string $verifyclassname, boolean $default) +Internal API function to parse statics for requested API @@ -105,19 +105,19 @@ Methods #### Arguments -* $params **mixed** -* $tree **mixed** -* $apiclassname **mixed** -* $verifyclassname **mixed** -* $default **mixed** +* $params **array** - <p>Array of Params given to the API</p> +* $tree **array** - <p>Array of Rules for given API</p> +* $apiclassname **string** - <p>Classname of the users API class</p> +* $verifyclassname **string** - <p>Classname of the users Verify Class</p> +* $default **boolean** - <p>Defaulting to default_page setting</p> ### do_default - mixed SYSTEM\API\api::do_default($default, $apiclassname, $call_funcname) - + array SYSTEM\API\api::do_default(boolean $default, string $apiclassname, string $call_funcname) +Internal API function to parse default redirect for requested API @@ -126,17 +126,17 @@ Methods #### Arguments -* $default **mixed** -* $apiclassname **mixed** -* $call_funcname **mixed** +* $default **boolean** - <p>Defaulting to default_page setting</p> +* $apiclassname **string** - <p>Classname of the users API class</p> +* $call_funcname **string** - <p>Functionname which was called</p> ### do_strict - mixed SYSTEM\API\api::do_strict($strict, $params, $statics, $commands, $parameters, $parameters_opt) - + null SYSTEM\API\api::do_strict(boolean $strict, array $params, array $statics, array $commands, array $parameters, array $parameters_opt) +Internal API function to strict parse the API @@ -145,20 +145,20 @@ Methods #### Arguments -* $strict **mixed** -* $params **mixed** -* $statics **mixed** -* $commands **mixed** -* $parameters **mixed** -* $parameters_opt **mixed** +* $strict **boolean** - <p>Strict settings</p> +* $params **array** - <p>Parameters given to the API</p> +* $statics **array** - <p>Array with API statics</p> +* $commands **array** - <p>Array with API commands</p> +* $parameters **array** - <p>Array with API parameters</p> +* $parameters_opt **array** - <p>Array with API optional parameters</p> ### do_commands - mixed SYSTEM\API\api::do_commands($params, $tree) - + array SYSTEM\API\api::do_commands(array $params, array $tree) +Internal API function to parse commands for requested API @@ -167,16 +167,16 @@ Methods #### Arguments -* $params **mixed** -* $tree **mixed** +* $params **array** - <p>Parameters given to the API</p> +* $tree **array** - <p>Array with API rules</p> ### do_parameters - mixed SYSTEM\API\api::do_parameters($params, $tree, $parentid, $lastcommandvalue, $verifyclassname) - + array SYSTEM\API\api::do_parameters(array $params, array $tree, integer $parentid, string $lastcommandvalue, string $verifyclassname) +Internal API function to parse parameters for requested API @@ -185,19 +185,19 @@ Methods #### Arguments -* $params **mixed** -* $tree **mixed** -* $parentid **mixed** -* $lastcommandvalue **mixed** -* $verifyclassname **mixed** +* $params **array** - <p>Parameters given to the API</p> +* $tree **array** - <p>Array with API rules</p> +* $parentid **integer** - <p>Parentid of last Tree Element</p> +* $lastcommandvalue **string** - <p>Last value of last Command</p> +* $verifyclassname **string** - <p>Verify Class given to the API</p> ### do_parameters_opt - mixed SYSTEM\API\api::do_parameters_opt($params, $tree, $parentid, $lastcommandvalue, $verifyclassname) - + array SYSTEM\API\api::do_parameters_opt(array $params, array $tree, integer $parentid, string $lastcommandvalue, string $verifyclassname) +Internal API function to parse optional parameters for requested API @@ -206,19 +206,19 @@ Methods #### Arguments -* $params **mixed** -* $tree **mixed** -* $parentid **mixed** -* $lastcommandvalue **mixed** -* $verifyclassname **mixed** +* $params **array** - <p>Parameters given to the API</p> +* $tree **array** - <p>Array with API rules</p> +* $parentid **integer** - <p>Parentid of last Tree Element</p> +* $lastcommandvalue **string** - <p>Last value of last Command</p> +* $verifyclassname **string** - <p>Verify Class given to the API</p> ### do_func_name - mixed SYSTEM\API\api::do_func_name($commands) - + string SYSTEM\API\api::do_func_name(array $commands) +Internal API function to build function name for requested API @@ -227,15 +227,15 @@ Methods #### Arguments -* $commands **mixed** +* $commands **array** - <p>Array of all Commands for the given API call</p> ### do_func_params - mixed SYSTEM\API\api::do_func_params($parameters, $parameters_opt) - + array SYSTEM\API\api::do_func_params(array $parameters, array $parameters_opt) +Internal API function to build function paramters for requested API @@ -244,7 +244,7 @@ Methods #### Arguments -* $parameters **mixed** -* $parameters_opt **mixed** +* $parameters **array** - <p>Array of all Paramters for the given API call</p> +* $parameters_opt **array** - <p>Array of all optional Paramters for the given API call</p> diff --git a/SYSTEM-API-api_default.md b/SYSTEM-API-api_default.md index 0b4210e..0ae0da9 100644 --- a/SYSTEM-API-api_default.md +++ b/SYSTEM-API-api_default.md @@ -1,7 +1,7 @@ SYSTEM\API\api_default =============== - +API Default class providing defaulting capabilities and Hashbang-Crawling-Scheme. @@ -10,7 +10,7 @@ SYSTEM\API\api_default * Namespace: SYSTEM\API * This is an **abstract** class * Parent class: [SYSTEM\API\api_system](SYSTEM-API-api_system) - +* This class implements: [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface) @@ -23,9 +23,9 @@ Methods ### static__escaped_fragment_ - mixed SYSTEM\API\api_default::static__escaped_fragment_($_escaped_fragment_) - + string SYSTEM\API\api_default::static__escaped_fragment_(string $_escaped_fragment_) +Static Call handler for Hashbang-Crawling Requests @@ -34,29 +34,15 @@ Methods #### Arguments -* $_escaped_fragment_ **mixed** - - - -### get_apigroup - - mixed SYSTEM\API\api_default::get_apigroup() - - - - - -* Visibility: **public** -* This method is **static**. - +* $_escaped_fragment_ **string** - <p>Hashbang-Encoded State</p> ### get_class - mixed SYSTEM\API\api_default::get_class($params) - + string SYSTEM\API\api_default::get_class() +API Class function - implement this function and return the Classname @@ -64,64 +50,13 @@ Methods * This method is **static**. -#### Arguments -* $params **mixed** - - - -### get_params - - mixed SYSTEM\API\api_default::get_params($params) - - - - - -* Visibility: **public** -* This method is **static**. - - -#### Arguments -* $params **mixed** - - - -### get_default_state - - mixed SYSTEM\API\api_default::get_default_state() - - - - - -* Visibility: **public** -* This method is **static**. - - - - -### default_page - - mixed SYSTEM\API\api_default::default_page($_escaped_fragment_) - - - - - -* Visibility: **public** -* This method is **static**. - - -#### Arguments -* $_escaped_fragment_ **mixed** - ### call_cron - mixed SYSTEM\API\api_system::call_cron() - + \SYSTEM\API\JSON SYSTEM\API\api_system::call_cron() +System run Cron Call @@ -134,9 +69,9 @@ Methods ### call_text - mixed SYSTEM\API\api_system::call_text($request, $lang) - + \SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang) +System Text Request Call @@ -146,16 +81,16 @@ Methods #### Arguments -* $request **mixed** -* $lang **mixed** +* $request **mixed** - <p>Request String for Text API</p> +* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p> ### call_files - mixed SYSTEM\API\api_system::call_files($cat, $id) - + mixed SYSTEM\API\api_system::call_files(string $cat, string $id) +System File Request Call @@ -165,16 +100,16 @@ Methods #### Arguments -* $cat **mixed** -* $id **mixed** +* $cat **string** - <p>File category</p> +* $id **string** - <p>File name</p> ### call_pages - mixed SYSTEM\API\api_system::call_pages($group, $state) - + mixed SYSTEM\API\api_system::call_pages(integer $group, string $state) +System State-Pages Request Call @@ -184,16 +119,16 @@ Methods #### Arguments -* $group **mixed** -* $state **mixed** +* $group **integer** - <p>Page Group for Statesystem</p> +* $state **string** - <p>Full name of the State.</p> ### static__lang - mixed SYSTEM\API\api_system::static__lang($lang) - + null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang) +Static Call to change Language for the current Session/User @@ -203,15 +138,15 @@ Methods #### Arguments -* $lang **mixed** +* $lang **SYSTEM\API\lang** - <p>Language requested</p> ### static__result - mixed SYSTEM\API\api_system::static__result($result) - + null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result) +Static Call to change Result-Type for the current Session/User @@ -221,15 +156,15 @@ Methods #### Arguments -* $result **mixed** +* $result **SYSTEM\API\result** - <p>Resulttype</p> ### static__ - mixed SYSTEM\API\api_system::static__($_) - + null SYSTEM\API\api_system::static__(mixed $_) +Static Time-Parameter _ Call to avoid caching and API Errors for JS requests @@ -239,15 +174,15 @@ Methods #### Arguments -* $_ **mixed** +* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p> ### call_bug - mixed SYSTEM\API\api_system::call_bug($message, $data) - + null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data) +API Bug Call to report Bugs @@ -257,16 +192,16 @@ Methods #### Arguments -* $message **mixed** -* $data **mixed** +* $message **string** - <p>Bugreport Message</p> +* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p> ### call_cache - mixed SYSTEM\API\api_system::call_cache($id, $ident) - + mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident) +API Cache Call to request cached Data (usually js and css) @@ -276,16 +211,16 @@ Methods #### Arguments -* $id **mixed** -* $ident **mixed** +* $id **integer** - <p>Cache id to be queried</p> +* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p> ### call_account_action_login - mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale) +System Account Login @@ -295,17 +230,17 @@ Methods #### Arguments -* $username **mixed** -* $password_sha **mixed** -* $password_md5 **mixed** +* $username **string** - <p>Username</p> +* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p> +* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p> ### call_account_action_logout - mixed SYSTEM\API\api_login::call_account_action_logout() - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout() +System Account Logout @@ -318,9 +253,9 @@ Methods ### call_account_action_isloggedin - mixed SYSTEM\API\api_login::call_account_action_isloggedin() - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin() +System Account isloggedin check @@ -333,9 +268,9 @@ Methods ### call_account_action_check - mixed SYSTEM\API\api_login::call_account_action_check($rightid) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid) +System Account Right Check @@ -345,15 +280,15 @@ Methods #### Arguments -* $rightid **mixed** +* $rightid **integer** - <p>RightID of the right to be checked</p> ### call_account_action_create - mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale) +System Account Create @@ -363,9 +298,145 @@ Methods #### Arguments -* $username **mixed** -* $password_sha **mixed** -* $email **mixed** -* $locale **mixed** +* $username **string** - <p>Username</p> +* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p> +* $email **SYSTEM\API\email** - <p>Email of the new User</p> +* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p> + + + +### call_account_action_confirm_email + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email() + +System Account Request Confirm EMail Token + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + + + +### call_account_action_confirm + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token) + +System Account Confirm Tokens + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + +#### Arguments +* $token **string** - <p>Token to do specifics with your Account</p> + + + +### call_account_action_reset_password + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username) + +System Account Request Reset Password Token + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + +#### Arguments +* $username **string** - <p>Username</p> + + + +### call_account_action_change_password + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1) + +System Account Change Password + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + +#### Arguments +* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p> +* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p> + + + +### call_account_action_change_email + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email) + +System Account Request Change EMail Token + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + +#### Arguments +* $new_email **string** - <p>Users new EMail Address</p> + + + +### get_apigroup + + integer SYSTEM\API\api_default_interface::get_apigroup() + +API Group function - implement this function and return the Groupnumber + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface) + + + + +### get_default_state + + string SYSTEM\API\api_default_interface::get_default_state() + +API Default State function - implement this function and return the String of the default-state + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface) + + + + +### default_page + + string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_) + +API Default Page function - implement this function and return the Default Page + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_default_interface](SYSTEM-API-api_default_interface) + + +#### Arguments +* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p> diff --git a/SYSTEM-API-api_default_interface.md b/SYSTEM-API-api_default_interface.md new file mode 100644 index 0000000..20adbed --- /dev/null +++ b/SYSTEM-API-api_default_interface.md @@ -0,0 +1,66 @@ +SYSTEM\API\api_default_interface +=============== + +api_default Interface used internally in api_default Class +can be used insted of api_default if hashbang mechanic should not be used. + + + + +* Interface name: api_default_interface +* Namespace: SYSTEM\API +* This is an **interface** + + + + + + +Methods +------- + + +### get_apigroup + + integer SYSTEM\API\api_default_interface::get_apigroup() + +API Group function - implement this function and return the Groupnumber + + + +* Visibility: **public** +* This method is **static**. + + + + +### get_default_state + + string SYSTEM\API\api_default_interface::get_default_state() + +API Default State function - implement this function and return the String of the default-state + + + +* Visibility: **public** +* This method is **static**. + + + + +### default_page + + string SYSTEM\API\api_default_interface::default_page(string $_escaped_fragment_) + +API Default Page function - implement this function and return the Default Page + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $_escaped_fragment_ **string** - <p>Fragment from Hashbang Crawling</p> + + diff --git a/SYSTEM-API-api_login.md b/SYSTEM-API-api_login.md index a4c14f3..f7a3081 100644 --- a/SYSTEM-API-api_login.md +++ b/SYSTEM-API-api_login.md @@ -1,7 +1,7 @@ SYSTEM\API\api_login =============== - +API Login class providing System Account Functionality. @@ -21,9 +21,9 @@ Methods ### call_account_action_login - mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale) +System Account Login @@ -32,17 +32,17 @@ Methods #### Arguments -* $username **mixed** -* $password_sha **mixed** -* $password_md5 **mixed** +* $username **string** - <p>Username</p> +* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p> +* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p> ### call_account_action_logout - mixed SYSTEM\API\api_login::call_account_action_logout() - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout() +System Account Logout @@ -54,9 +54,9 @@ Methods ### call_account_action_isloggedin - mixed SYSTEM\API\api_login::call_account_action_isloggedin() - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin() +System Account isloggedin check @@ -68,9 +68,9 @@ Methods ### call_account_action_check - mixed SYSTEM\API\api_login::call_account_action_check($rightid) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid) +System Account Right Check @@ -79,15 +79,15 @@ Methods #### Arguments -* $rightid **mixed** +* $rightid **integer** - <p>RightID of the right to be checked</p> ### call_account_action_create - mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale) +System Account Create @@ -96,9 +96,92 @@ Methods #### Arguments -* $username **mixed** -* $password_sha **mixed** -* $email **mixed** -* $locale **mixed** +* $username **string** - <p>Username</p> +* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p> +* $email **SYSTEM\API\email** - <p>Email of the new User</p> +* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p> + + + +### call_account_action_confirm_email + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email() + +System Account Request Confirm EMail Token + + + +* Visibility: **public** +* This method is **static**. + + + + +### call_account_action_confirm + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token) + +System Account Confirm Tokens + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $token **string** - <p>Token to do specifics with your Account</p> + + + +### call_account_action_reset_password + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username) + +System Account Request Reset Password Token + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $username **string** - <p>Username</p> + + + +### call_account_action_change_password + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1) + +System Account Change Password + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p> +* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p> + + + +### call_account_action_change_email + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email) + +System Account Request Change EMail Token + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $new_email **string** - <p>Users new EMail Address</p> diff --git a/SYSTEM-API-api_system.md b/SYSTEM-API-api_system.md index dbb775c..f23ddb4 100644 --- a/SYSTEM-API-api_system.md +++ b/SYSTEM-API-api_system.md @@ -1,7 +1,7 @@ SYSTEM\API\api_system =============== - +API System class providing System Functionality. @@ -22,9 +22,9 @@ Methods ### call_cron - mixed SYSTEM\API\api_system::call_cron() - + \SYSTEM\API\JSON SYSTEM\API\api_system::call_cron() +System run Cron Call @@ -36,9 +36,9 @@ Methods ### call_text - mixed SYSTEM\API\api_system::call_text($request, $lang) - + \SYSTEM\API\JSON SYSTEM\API\api_system::call_text(mixed $request, \SYSTEM\API\lang $lang) +System Text Request Call @@ -47,16 +47,16 @@ Methods #### Arguments -* $request **mixed** -* $lang **mixed** +* $request **mixed** - <p>Request String for Text API</p> +* $lang **SYSTEM\API\lang** - <p>Request Language for given text</p> ### call_files - mixed SYSTEM\API\api_system::call_files($cat, $id) - + mixed SYSTEM\API\api_system::call_files(string $cat, string $id) +System File Request Call @@ -65,16 +65,16 @@ Methods #### Arguments -* $cat **mixed** -* $id **mixed** +* $cat **string** - <p>File category</p> +* $id **string** - <p>File name</p> ### call_pages - mixed SYSTEM\API\api_system::call_pages($group, $state) - + mixed SYSTEM\API\api_system::call_pages(integer $group, string $state) +System State-Pages Request Call @@ -83,16 +83,16 @@ Methods #### Arguments -* $group **mixed** -* $state **mixed** +* $group **integer** - <p>Page Group for Statesystem</p> +* $state **string** - <p>Full name of the State.</p> ### static__lang - mixed SYSTEM\API\api_system::static__lang($lang) - + null SYSTEM\API\api_system::static__lang(\SYSTEM\API\lang $lang) +Static Call to change Language for the current Session/User @@ -101,15 +101,15 @@ Methods #### Arguments -* $lang **mixed** +* $lang **SYSTEM\API\lang** - <p>Language requested</p> ### static__result - mixed SYSTEM\API\api_system::static__result($result) - + null SYSTEM\API\api_system::static__result(\SYSTEM\API\result $result) +Static Call to change Result-Type for the current Session/User @@ -118,15 +118,15 @@ Methods #### Arguments -* $result **mixed** +* $result **SYSTEM\API\result** - <p>Resulttype</p> ### static__ - mixed SYSTEM\API\api_system::static__($_) - + null SYSTEM\API\api_system::static__(mixed $_) +Static Time-Parameter _ Call to avoid caching and API Errors for JS requests @@ -135,15 +135,15 @@ Methods #### Arguments -* $_ **mixed** +* $_ **mixed** - <p>Anticaching Parameter of some Browsers</p> ### call_bug - mixed SYSTEM\API\api_system::call_bug($message, $data) - + null SYSTEM\API\api_system::call_bug(string $message, \SYSTEM\API\JSON $data) +API Bug Call to report Bugs @@ -152,16 +152,16 @@ Methods #### Arguments -* $message **mixed** -* $data **mixed** +* $message **string** - <p>Bugreport Message</p> +* $data **SYSTEM\API\JSON** - <p>Bugreport Data</p> ### call_cache - mixed SYSTEM\API\api_system::call_cache($id, $ident) - + mixed SYSTEM\API\api_system::call_cache(integer $id, \SYSTEM\API\sha1 $ident) +API Cache Call to request cached Data (usually js and css) @@ -170,16 +170,16 @@ Methods #### Arguments -* $id **mixed** -* $ident **mixed** +* $id **integer** - <p>Cache id to be queried</p> +* $ident **SYSTEM\API\sha1** - <p>Cache ident to be queried</p> ### call_account_action_login - mixed SYSTEM\API\api_login::call_account_action_login($username, $password_sha, $password_md5) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_login(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\lang $locale) +System Account Login @@ -189,17 +189,17 @@ Methods #### Arguments -* $username **mixed** -* $password_sha **mixed** -* $password_md5 **mixed** +* $username **string** - <p>Username</p> +* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p> +* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to login with</p> ### call_account_action_logout - mixed SYSTEM\API\api_login::call_account_action_logout() - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_logout() +System Account Logout @@ -212,9 +212,9 @@ Methods ### call_account_action_isloggedin - mixed SYSTEM\API\api_login::call_account_action_isloggedin() - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_isloggedin() +System Account isloggedin check @@ -227,9 +227,9 @@ Methods ### call_account_action_check - mixed SYSTEM\API\api_login::call_account_action_check($rightid) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_check(integer $rightid) +System Account Right Check @@ -239,15 +239,15 @@ Methods #### Arguments -* $rightid **mixed** +* $rightid **integer** - <p>RightID of the right to be checked</p> ### call_account_action_create - mixed SYSTEM\API\api_login::call_account_action_create($username, $password_sha, $email, $locale) - + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_create(string $username, \SYSTEM\API\sha1 $password_sha1, \SYSTEM\API\email $email, \SYSTEM\API\lang $locale) +System Account Create @@ -257,9 +257,97 @@ Methods #### Arguments -* $username **mixed** -* $password_sha **mixed** -* $email **mixed** -* $locale **mixed** +* $username **string** - <p>Username</p> +* $password_sha1 **SYSTEM\API\sha1** - <p>User Password SHA1 String</p> +* $email **SYSTEM\API\email** - <p>Email of the new User</p> +* $locale **SYSTEM\API\lang** - <p>Locale which the User wants to register or null for default language</p> + + + +### call_account_action_confirm_email + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm_email() + +System Account Request Confirm EMail Token + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + + + +### call_account_action_confirm + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_confirm(string $token) + +System Account Confirm Tokens + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + +#### Arguments +* $token **string** - <p>Token to do specifics with your Account</p> + + + +### call_account_action_reset_password + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_reset_password(string $username) + +System Account Request Reset Password Token + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + +#### Arguments +* $username **string** - <p>Username</p> + + + +### call_account_action_change_password + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_password(string $old_password_sha1, string $new_password_sha1) + +System Account Change Password + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + +#### Arguments +* $old_password_sha1 **string** - <p>Users Old Password SHA1 String</p> +* $new_password_sha1 **string** - <p>Users New Password SHA1 String</p> + + + +### call_account_action_change_email + + \SYSTEM\API\JSON SYSTEM\API\api_login::call_account_action_change_email(string $new_email) + +System Account Request Change EMail Token + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\API\api_login](SYSTEM-API-api_login) + + +#### Arguments +* $new_email **string** - <p>Users new EMail Address</p> diff --git a/SYSTEM-API-verify.md b/SYSTEM-API-verify.md index 6eea3aa..e661581 100644 --- a/SYSTEM-API-verify.md +++ b/SYSTEM-API-verify.md @@ -1,7 +1,7 @@ SYSTEM\API\verify =============== - +API default verify Class for Parameter validation @@ -21,9 +21,9 @@ Methods ### ALL - mixed SYSTEM\API\verify::ALL($param) - + boolean SYSTEM\API\verify::ALL(mixed $param) +Verify All - everything is allowed @@ -32,15 +32,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### UINT - mixed SYSTEM\API\verify::UINT($param) - + boolean SYSTEM\API\verify::UINT(mixed $param) +Verify UINT - Positive Integer excluding 0 @@ -49,15 +49,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### UINT0 - mixed SYSTEM\API\verify::UINT0($param) - + boolean SYSTEM\API\verify::UINT0(mixed $param) +Verify UINT0 - Positive Integer including 0 @@ -66,15 +66,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### INT - mixed SYSTEM\API\verify::INT($param) - + boolean SYSTEM\API\verify::INT(mixed $param) +Verify INT - all integers @@ -83,15 +83,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### TIMEUNIX - mixed SYSTEM\API\verify::TIMEUNIX($param) - + boolean SYSTEM\API\verify::TIMEUNIX(mixed $param) +Verify TIMEUNIX - unixtimestamp number @@ -100,15 +100,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### DATE - mixed SYSTEM\API\verify::DATE($param) - + boolean SYSTEM\API\verify::DATE(mixed $param) +Verify DATE - string parseable as date @@ -117,15 +117,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### STRING - mixed SYSTEM\API\verify::STRING($param) - + boolean SYSTEM\API\verify::STRING(mixed $param) +Verify STRING - allow every string - thats all @@ -134,15 +134,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### BOOL - mixed SYSTEM\API\verify::BOOL($param) - + boolean SYSTEM\API\verify::BOOL(mixed $param) +Verify BOOL - allow booleans @@ -151,15 +151,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### FLOAT - mixed SYSTEM\API\verify::FLOAT($param) - + boolean SYSTEM\API\verify::FLOAT(mixed $param) +Verify FLOAT - every float value @@ -168,15 +168,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### JSON - mixed SYSTEM\API\verify::JSON($param) - + boolean SYSTEM\API\verify::JSON(mixed $param) +Verify JSON - JSON format check @@ -185,15 +185,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### ARY - mixed SYSTEM\API\verify::ARY($param) - + boolean SYSTEM\API\verify::ARY(mixed $param) +Verify ARY - array check @@ -202,15 +202,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### LANG - mixed SYSTEM\API\verify::LANG($param) - + boolean SYSTEM\API\verify::LANG(mixed $param) +Verify LANG - verify supported languages @@ -219,15 +219,15 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> ### RESULT - mixed SYSTEM\API\verify::RESULT($param) - + boolean SYSTEM\API\verify::RESULT(mixed $param) +Verify RESULT - verify possible resulttypes @@ -236,6 +236,23 @@ Methods #### Arguments -* $param **mixed** +* $param **mixed** - <p>Input Paramter</p> + + + +### EMAIL + + boolean SYSTEM\API\verify::EMAIL(mixed $param) + +Verify EMAIL - verify email + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $param **mixed** - <p>Input Paramter</p> diff --git a/SYSTEM-CACHE-cache.md b/SYSTEM-CACHE-cache.md index ff47592..aa3d40c 100644 --- a/SYSTEM-CACHE-cache.md +++ b/SYSTEM-CACHE-cache.md @@ -1,7 +1,7 @@ SYSTEM\CACHE\cache =============== - +Cache Class provided by System for caching in the Database. @@ -21,9 +21,9 @@ Methods ### get - mixed SYSTEM\CACHE\cache::get($cache, $ident, $header) - + mixed SYSTEM\CACHE\cache::get(integer $cache, \SYSTEM\CACHE\sha1 $ident, boolean $header) +Get Data from Cache @@ -32,17 +32,17 @@ Methods #### Arguments -* $cache **mixed** -* $ident **mixed** -* $header **mixed** +* $cache **integer** - <p>Cache Group to query</p> +* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p> +* $header **boolean** - <p>Send Header</p> ### put - mixed SYSTEM\CACHE\cache::put($cache, $ident, $type, $data, $fail_on_exist) - + mixed SYSTEM\CACHE\cache::put(integer $cache, \SYSTEM\CACHE\sha1 $ident, string $type, string $data, boolean $fail_on_exist) +Put Data into the Cache @@ -51,19 +51,19 @@ Methods #### Arguments -* $cache **mixed** -* $ident **mixed** -* $type **mixed** -* $data **mixed** -* $fail_on_exist **mixed** +* $cache **integer** - <p>Cache Group to put Data to</p> +* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the Content</p> +* $type **string** - <p>String representing the Header-Type which will be sent with the content eg. JS for javascript</p> +* $data **string** - <p>Content to be cached</p> +* $fail_on_exist **boolean** - <p>Fail on existing record</p> ### del - mixed SYSTEM\CACHE\cache::del($cache, $ident) - + boolean SYSTEM\CACHE\cache::del(integer $cache, \SYSTEM\CACHE\sha1 $ident) +Delete Data from Cache @@ -72,7 +72,7 @@ Methods #### Arguments -* $cache **mixed** -* $ident **mixed** +* $cache **integer** - <p>Cache Group to delete Data from</p> +* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the Content</p> diff --git a/SYSTEM-CACHE-cache_css.md b/SYSTEM-CACHE-cache_css.md index ab367e0..127ffe5 100644 --- a/SYSTEM-CACHE-cache_css.md +++ b/SYSTEM-CACHE-cache_css.md @@ -1,7 +1,7 @@ SYSTEM\CACHE\cache_css =============== - +CSS Cache Class provided by System for caching CSS in the Database. @@ -31,9 +31,9 @@ Methods ### put - mixed SYSTEM\CACHE\cache_css::put($ident, $data) - + mixed SYSTEM\CACHE\cache_css::put(\SYSTEM\CACHE\sha1 $ident, integer $data) +Put Data into the Cache @@ -42,16 +42,16 @@ Methods #### Arguments -* $ident **mixed** -* $data **mixed** +* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p> +* $data **integer** - <p>Data to cache</p> ### get - mixed SYSTEM\CACHE\cache_css::get($ident, $header) - + mixed SYSTEM\CACHE\cache_css::get(\SYSTEM\CACHE\sha1 $ident, boolean $header) +Get Data from Cache @@ -60,16 +60,16 @@ Methods #### Arguments -* $ident **mixed** -* $header **mixed** +* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p> +* $header **boolean** - <p>Send Header</p> ### ident - mixed SYSTEM\CACHE\cache_css::ident($files) - + \SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_css::ident(array $files) +Calculate Ident for a list of Files @@ -78,15 +78,15 @@ Methods #### Arguments -* $files **mixed** +* $files **array** - <p>List of Files to be cached into one Cacheentry</p> -### url - - mixed SYSTEM\CACHE\cache_css::url($files) +### minify + \SYSTEM\CACHE\url SYSTEM\CACHE\cache_css::minify(array $files) +Minify CSS and calculate URL from it @@ -95,6 +95,6 @@ Methods #### Arguments -* $files **mixed** +* $files **array** - <p>List of Files to be cached into one Cacheentry</p> diff --git a/SYSTEM-CACHE-cache_filemask.md b/SYSTEM-CACHE-cache_filemask.md index b59a060..3da5b29 100644 --- a/SYSTEM-CACHE-cache_filemask.md +++ b/SYSTEM-CACHE-cache_filemask.md @@ -1,7 +1,7 @@ SYSTEM\CACHE\cache_filemask =============== - +File Cache Class provided by System for hiding Filepaths on the Server. @@ -31,9 +31,10 @@ Methods ### put - mixed SYSTEM\CACHE\cache_filemask::put($file) - + mixed SYSTEM\CACHE\cache_filemask::put(\SYSTEM\CACHE\sha1 $file) +Put Data into the Cache +Remark: Saves only the path into the Cache, not the File itself @@ -42,15 +43,15 @@ Methods #### Arguments -* $file **mixed** +* $file **SYSTEM\CACHE\sha1** - <p>String Filepath of Content</p> ### get - mixed SYSTEM\CACHE\cache_filemask::get($ident, $header) - + mixed SYSTEM\CACHE\cache_filemask::get(\SYSTEM\CACHE\sha1 $ident, boolean $header) +Get Data from Cache @@ -59,16 +60,16 @@ Methods #### Arguments -* $ident **mixed** -* $header **mixed** +* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p> +* $header **boolean** - <p>Send Header</p> ### ident - mixed SYSTEM\CACHE\cache_filemask::ident($file) - + \SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_filemask::ident(array $file) +Calculate Ident for a File @@ -77,6 +78,6 @@ Methods #### Arguments -* $file **mixed** +* $file **array** - <p>Filepath to be cached</p> diff --git a/SYSTEM-CACHE-cache_js.md b/SYSTEM-CACHE-cache_js.md index 644fc9c..a3358e3 100644 --- a/SYSTEM-CACHE-cache_js.md +++ b/SYSTEM-CACHE-cache_js.md @@ -1,7 +1,7 @@ SYSTEM\CACHE\cache_js =============== - +JS Cache Class provided by System for caching JS in the Database. @@ -31,9 +31,9 @@ Methods ### put - mixed SYSTEM\CACHE\cache_js::put($ident, $data) - + mixed SYSTEM\CACHE\cache_js::put(\SYSTEM\CACHE\sha1 $ident, integer $data) +Put Data into the Cache @@ -42,16 +42,16 @@ Methods #### Arguments -* $ident **mixed** -* $data **mixed** +* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p> +* $data **integer** - <p>Data to cache</p> ### get - mixed SYSTEM\CACHE\cache_js::get($ident, $header) - + mixed SYSTEM\CACHE\cache_js::get(\SYSTEM\CACHE\sha1 $ident, boolean $header) +Get Data from Cache @@ -60,16 +60,16 @@ Methods #### Arguments -* $ident **mixed** -* $header **mixed** +* $ident **SYSTEM\CACHE\sha1** - <p>String Identifier for the cached Content</p> +* $header **boolean** - <p>Send Header</p> ### ident - mixed SYSTEM\CACHE\cache_js::ident($files) - + \SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_js::ident(array $files) +Calculate Ident for a list of Files @@ -78,15 +78,15 @@ Methods #### Arguments -* $files **mixed** +* $files **array** - <p>List of Files to be cached into one Cacheentry</p> -### url - - mixed SYSTEM\CACHE\cache_js::url($files) +### minify + \SYSTEM\CACHE\url SYSTEM\CACHE\cache_js::minify(array $files) +Minify JS files and calculate URL for it @@ -95,6 +95,6 @@ Methods #### Arguments -* $files **mixed** +* $files **array** - <p>List of Files to be cached into one Cacheentry</p> diff --git a/SYSTEM-CACHE-cache_scss.md b/SYSTEM-CACHE-cache_scss.md index 9d23fd3..6ff6986 100644 --- a/SYSTEM-CACHE-cache_scss.md +++ b/SYSTEM-CACHE-cache_scss.md @@ -1,7 +1,7 @@ SYSTEM\CACHE\cache_scss =============== - +SCSS Cache Class provided by System for compiling and caching SCSS in the Database. @@ -31,9 +31,9 @@ Methods ### put - mixed SYSTEM\CACHE\cache_scss::put($file, $data) - + mixed SYSTEM\CACHE\cache_scss::put(\SYSTEM\CACHE\sha1 $file, integer $data) +Put Data into the Cache @@ -42,16 +42,16 @@ Methods #### Arguments -* $file **mixed** -* $data **mixed** +* $file **SYSTEM\CACHE\sha1** - <p>Filepath of the Content</p> +* $data **integer** - <p>Data to cache</p> ### get - mixed SYSTEM\CACHE\cache_scss::get($file, $header) - + mixed SYSTEM\CACHE\cache_scss::get(\SYSTEM\CACHE\sha1 $file, boolean $header) +Get Data from Cache @@ -60,16 +60,16 @@ Methods #### Arguments -* $file **mixed** -* $header **mixed** +* $file **SYSTEM\CACHE\sha1** - <p>Filepath for the cached Content</p> +* $header **boolean** - <p>Send Header</p> ### ident - mixed SYSTEM\CACHE\cache_scss::ident($file) - + \SYSTEM\CACHE\sha1 SYSTEM\CACHE\cache_scss::ident(string $file) +Calculate Ident for a File @@ -78,15 +78,15 @@ Methods #### Arguments -* $file **mixed** +* $file **string** - <p>Filepath to be cached</p> ### url - mixed SYSTEM\CACHE\cache_scss::url($file) - + \SYSTEM\CACHE\url SYSTEM\CACHE\cache_scss::url(array $file) +Calculate URL for a File @@ -95,6 +95,6 @@ Methods #### Arguments -* $file **mixed** +* $file **array** - <p>Filepath to be cached</p> diff --git a/SYSTEM-CONFIG-config.md b/SYSTEM-CONFIG-config.md index 1dbc1f1..d9a477a 100644 --- a/SYSTEM-CONFIG-config.md +++ b/SYSTEM-CONFIG-config.md @@ -1,7 +1,7 @@ SYSTEM\CONFIG\config =============== - +Config Class provided by System for configuration of the System Environment. @@ -21,7 +21,7 @@ Properties private mixed $config - +array Holding all the Config Data @@ -35,9 +35,9 @@ Methods ### get - mixed SYSTEM\CONFIG\config::get($config_id) - + mixed SYSTEM\CONFIG\config::get(integer $config_id) +Get Config Setting @@ -46,15 +46,15 @@ Methods #### Arguments -* $config_id **mixed** +* $config_id **integer** - <p>Config ID to be retrieved</p> ### set - mixed SYSTEM\CONFIG\config::set($config_id, $value) - + NULL SYSTEM\CONFIG\config::set(integer $config_id, mixed $value) +Set Config Setting @@ -63,16 +63,16 @@ Methods #### Arguments -* $config_id **mixed** -* $value **mixed** +* $config_id **integer** - <p>Config ID to be written</p> +* $value **mixed** - <p>Config Value to be written</p> ### setArray - mixed SYSTEM\CONFIG\config::setArray($id_value_array) - + NULL SYSTEM\CONFIG\config::setArray(array $id_value_array) +Set Array of Config Settings @@ -81,6 +81,6 @@ Methods #### Arguments -* $id_value_array **mixed** +* $id_value_array **array** - <p>Array containing Config IDs as Key and Value as Value to that Key. array( array(ID, VALUE), array(ID, VALUE))</p> diff --git a/SYSTEM-CONFIG-config_ids.md b/SYSTEM-CONFIG-config_ids.md index cfabea9..6d1f68b 100644 --- a/SYSTEM-CONFIG-config_ids.md +++ b/SYSTEM-CONFIG-config_ids.md @@ -1,9 +1,9 @@ SYSTEM\CONFIG\config_ids =============== +ConfigID Class provided by System for System Environment Config IDs. - - +Extend this class for your own purposes. * Class name: config_ids @@ -159,6 +159,14 @@ Constants +### SYS_CONFIG_PATH_CACHE + + const SYS_CONFIG_PATH_CACHE = 31 + + + + + ### SYS_SAI_CONFIG_PROJECT const SYS_SAI_CONFIG_PROJECT = 54 diff --git a/SYSTEM-CRON-cron.md b/SYSTEM-CRON-cron.md index 990021c..ee1356a 100644 --- a/SYSTEM-CRON-cron.md +++ b/SYSTEM-CRON-cron.md @@ -1,7 +1,7 @@ SYSTEM\CRON\cron =============== - +Cron Class provided by System for Tasks occurring repeateadly. @@ -21,9 +21,9 @@ Methods ### check - mixed SYSTEM\CRON\cron::check($class) - + boolean SYSTEM\CRON\cron::check(\SYSTEM\CRON\class $class) +Check if given Class is a compatible Cronjob @@ -32,15 +32,15 @@ Methods #### Arguments -* $class **mixed** +* $class **SYSTEM\CRON\class** - <p>Cronclass extending cronjob</p> ### run - mixed SYSTEM\CRON\cron::run() - + \SYSTEM\CRON\JSON SYSTEM\CRON\cron::run() +Run all registered Cronjobs if its time to do so. @@ -50,11 +50,28 @@ Methods +### run_class + + \SYSTEM\CRON\JSON SYSTEM\CRON\cron::run_class($class) + +Run a specific registered Cronjob by classname if its time to do so. + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $class **mixed** + + + ### next - mixed SYSTEM\CRON\cron::next($class) - + \SYSTEM\CRON\time SYSTEM\CRON\cron::next(\SYSTEM\CRON\class $class) +Determine next run of a given Cronjob @@ -63,15 +80,15 @@ Methods #### Arguments -* $class **mixed** +* $class **SYSTEM\CRON\class** - <p>Cronjob class</p> ### last - mixed SYSTEM\CRON\cron::last($class) - + \SYSTEM\CRON\time SYSTEM\CRON\cron::last(\SYSTEM\CRON\class $class) +Determine last run of a given Cronjob @@ -80,15 +97,15 @@ Methods #### Arguments -* $class **mixed** +* $class **SYSTEM\CRON\class** - <p>Cronjob class</p> ### status - mixed SYSTEM\CRON\cron::status($class, $status) - + boolean SYSTEM\CRON\cron::status(\SYSTEM\CRON\class $class, integer $status) +Updates the Status of a Cronjob @@ -97,16 +114,16 @@ Methods #### Arguments -* $class **mixed** -* $status **mixed** +* $class **SYSTEM\CRON\class** - <p>Cronjob class</p> +* $status **integer** - <p>Status to be written</p> ### last_visit - mixed SYSTEM\CRON\cron::last_visit() - + \SYSTEM\CRON\time SYSTEM\CRON\cron::last_visit() +Determines the time when the System-Cronjobs were executed the last time. diff --git a/SYSTEM-CRON-cron_cache_delete.md b/SYSTEM-CRON-cron_cache_delete.md index 093f575..6d01fe3 100644 --- a/SYSTEM-CRON-cron_cache_delete.md +++ b/SYSTEM-CRON-cron_cache_delete.md @@ -1,15 +1,14 @@ SYSTEM\CRON\cron_cache_delete =============== - +Conjob Class provided by System to delete System Cache. * Class name: cron_cache_delete * Namespace: SYSTEM\CRON -* Parent class: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob) - +* This class implements: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob) @@ -22,9 +21,9 @@ Methods ### run - mixed SYSTEM\CRON\cronjob::run() - + integer SYSTEM\CRON\cronjob::run() +Run the Cronjob and execute its task diff --git a/SYSTEM-CRON-cron_log2sqlite.md b/SYSTEM-CRON-cron_log2sqlite.md index 7d5fad0..1aeb9d0 100644 --- a/SYSTEM-CRON-cron_log2sqlite.md +++ b/SYSTEM-CRON-cron_log2sqlite.md @@ -1,15 +1,14 @@ SYSTEM\CRON\cron_log2sqlite =============== - +Conjob Class provided by System to extract Logentries into sqlite files. * Class name: cron_log2sqlite * Namespace: SYSTEM\CRON -* Parent class: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob) - +* This class implements: [SYSTEM\CRON\cronjob](SYSTEM-CRON-cronjob) @@ -22,9 +21,9 @@ Methods ### run - mixed SYSTEM\CRON\cronjob::run() - + integer SYSTEM\CRON\cronjob::run() +Run the Cronjob and execute its task diff --git a/SYSTEM-CRON-cronjob.md b/SYSTEM-CRON-cronjob.md index 12218e2..7d445d3 100644 --- a/SYSTEM-CRON-cronjob.md +++ b/SYSTEM-CRON-cronjob.md @@ -1,14 +1,14 @@ SYSTEM\CRON\cronjob =============== +Conjob Class provided by System to derive from for custom Cronjobs. - -* Class name: cronjob +* Interface name: cronjob * Namespace: SYSTEM\CRON - +* This is an **interface** @@ -21,9 +21,9 @@ Methods ### run - mixed SYSTEM\CRON\cronjob::run() - + integer SYSTEM\CRON\cronjob::run() +Run the Cronjob and execute its task diff --git a/SYSTEM-CRON-cronstatus.md b/SYSTEM-CRON-cronstatus.md index 79a5e0b..ce30550 100644 --- a/SYSTEM-CRON-cronstatus.md +++ b/SYSTEM-CRON-cronstatus.md @@ -1,7 +1,7 @@ SYSTEM\CRON\cronstatus =============== - +Cronstatus Class provided by System for Cronjob stati. @@ -63,9 +63,9 @@ Methods ### text - mixed SYSTEM\CRON\cronstatus::text($status) - + string SYSTEM\CRON\cronstatus::text(integer $status) +Convert Cron Status to a text value. @@ -74,6 +74,6 @@ Methods #### Arguments -* $status **mixed** +* $status **integer** - <p>Value from this Class</p> diff --git a/SYSTEM-CRON-crontime.md b/SYSTEM-CRON-crontime.md index bbaa1ad..d437450 100644 --- a/SYSTEM-CRON-crontime.md +++ b/SYSTEM-CRON-crontime.md @@ -1,7 +1,7 @@ SYSTEM\CRON\crontime =============== - +Crontime Class provided by System for Cronjob time calculation. @@ -21,9 +21,9 @@ Methods ### next - mixed SYSTEM\CRON\crontime::next($base_time, $min, $hour, $day, $day_week, $month) - + \SYSTEM\CRON\time SYSTEM\CRON\crontime::next(\SYSTEM\CRON\time $base_time, integer $min, integer $hour, integer $day, integer $day_week, integer $month) +Determine next time based on a basetime and crontab-style modificators @@ -32,20 +32,20 @@ Methods #### Arguments -* $base_time **mixed** -* $min **mixed** -* $hour **mixed** -* $day **mixed** -* $day_week **mixed** -* $month **mixed** +* $base_time **SYSTEM\CRON\time** - <p>Time which the calculation should be based upon</p> +* $min **integer** - <p>Minutes-Modificator for next run</p> +* $hour **integer** - <p>Hour-Modificator for next run</p> +* $day **integer** - <p>Day-Modificator for next run</p> +* $day_week **integer** - <p>Day-Of-The-Week-Modificator for next run</p> +* $month **integer** - <p>Month-Modificator for next run</p> ### last - mixed SYSTEM\CRON\crontime::last($base_time, $min, $hour, $day, $day_week, $month) - + \SYSTEM\CRON\time SYSTEM\CRON\crontime::last(\SYSTEM\CRON\time $base_time, integer $min, integer $hour, integer $day, integer $day_week, integer $month) +Determine last time based on a basetime and crontab-style modificators @@ -54,20 +54,21 @@ Methods #### Arguments -* $base_time **mixed** -* $min **mixed** -* $hour **mixed** -* $day **mixed** -* $day_week **mixed** -* $month **mixed** +* $base_time **SYSTEM\CRON\time** - <p>Time which the calculation should be based upon</p> +* $min **integer** - <p>Minutes-Modificator for last run</p> +* $hour **integer** - <p>Hour-Modificator for last run</p> +* $day **integer** - <p>Day-Modificator for last run</p> +* $day_week **integer** - <p>Day-Of-The-Week-Modificator for last run</p> +* $month **integer** - <p>Month-Modificator for last run</p> ### check - mixed SYSTEM\CRON\crontime::check($base_time, $last_run, $min, $hour, $day, $day_week, $month) - + boolean SYSTEM\CRON\crontime::check(\SYSTEM\CRON\time $base_time, \SYSTEM\CRON\time $last_run, integer $min, integer $hour, integer $day, integer $day_week, integer $month) +Determine if time for next run lies in the past based on a lastrun, +a basetime and crontab-style modificators @@ -76,63 +77,22 @@ Methods #### Arguments -* $base_time **mixed** -* $last_run **mixed** -* $min **mixed** -* $hour **mixed** -* $day **mixed** -* $day_week **mixed** -* $month **mixed** - - - -### next_now - - mixed SYSTEM\CRON\crontime::next_now($min, $hour, $day, $day_week, $month) - - - - - -* Visibility: **public** -* This method is **static**. - - -#### Arguments -* $min **mixed** -* $hour **mixed** -* $day **mixed** -* $day_week **mixed** -* $month **mixed** - - - -### last_now - - mixed SYSTEM\CRON\crontime::last_now($min, $hour, $day, $day_week, $month) - - - - - -* Visibility: **public** -* This method is **static**. - - -#### Arguments -* $min **mixed** -* $hour **mixed** -* $day **mixed** -* $day_week **mixed** -* $month **mixed** +* $base_time **SYSTEM\CRON\time** - <p>Time upon which is checked if the calculated time is in the past</p> +* $last_run **SYSTEM\CRON\time** - <p>Time which the calculation should be based upon</p> +* $min **integer** - <p>Minutes-Modificator for next run</p> +* $hour **integer** - <p>Hour-Modificator for next run</p> +* $day **integer** - <p>Day-Modificator for next run</p> +* $day_week **integer** - <p>Day-Of-The-Week-Modificator for next run</p> +* $month **integer** - <p>Month-Modificator for next run</p> ### check_now - mixed SYSTEM\CRON\crontime::check_now($last_run, $min, $hour, $day, $day_week, $month) - + boolean SYSTEM\CRON\crontime::check_now(\SYSTEM\CRON\time $last_run, integer $min, integer $hour, integer $day, integer $day_week, integer $month) +Determine if time for next run lies in the past based on a lastrun and +crontab-style modificators using system-time as compare-time. @@ -141,11 +101,53 @@ Methods #### Arguments -* $last_run **mixed** -* $min **mixed** -* $hour **mixed** -* $day **mixed** -* $day_week **mixed** -* $month **mixed** +* $last_run **SYSTEM\CRON\time** - <p>Time which the calculation should be based upon</p> +* $min **integer** - <p>Minutes-Modificator for next run</p> +* $hour **integer** - <p>Hour-Modificator for next run</p> +* $day **integer** - <p>Day-Modificator for next run</p> +* $day_week **integer** - <p>Day-Of-The-Week-Modificator for next run</p> +* $month **integer** - <p>Month-Modificator for next run</p> + + + +### next_now + + \SYSTEM\CRON\time SYSTEM\CRON\crontime::next_now(integer $min, integer $hour, integer $day, integer $day_week, integer $month) + +Determine next time based on the system-time and crontab-style modificators + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $min **integer** - <p>Minutes-Modificator for next run</p> +* $hour **integer** - <p>Hour-Modificator for next run</p> +* $day **integer** - <p>Day-Modificator for next run</p> +* $day_week **integer** - <p>Day-Of-The-Week-Modificator for next run</p> +* $month **integer** - <p>Month-Modificator for next run</p> + + + +### last_now + + \SYSTEM\CRON\time SYSTEM\CRON\crontime::last_now(integer $min, integer $hour, integer $day, integer $day_week, integer $month) + +Determine last time based on system-time and crontab-style modificators + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $min **integer** - <p>Minutes-Modificator for last run</p> +* $hour **integer** - <p>Hour-Modificator for last run</p> +* $day **integer** - <p>Day-Modificator for last run</p> +* $day_week **integer** - <p>Day-Of-The-Week-Modificator for last run</p> +* $month **integer** - <p>Month-Modificator for last run</p> diff --git a/SYSTEM-DB-Connection.md b/SYSTEM-DB-Connection.md index 9cf7f8e..2401d9d 100644 --- a/SYSTEM-DB-Connection.md +++ b/SYSTEM-DB-Connection.md @@ -1,7 +1,7 @@ SYSTEM\DB\Connection =============== - +Connection Class provided by System to open a Connection to a Database. @@ -22,7 +22,7 @@ Properties private mixed $connection = NULL - +ressource Variable to store then open Connection @@ -35,9 +35,9 @@ Methods ### __construct - mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo) - + mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo) +Connect to the DB upon Construction. @@ -47,7 +47,7 @@ Methods #### Arguments -* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p> @@ -55,9 +55,24 @@ Methods mixed SYSTEM\DB\ConnectionAbstr::__destruct() +Destruct the Database Connection upon Destruction. +* Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) + + + + +### close + + boolean SYSTEM\DB\ConnectionAbstr::close() + +Close the Database Connection. + + * Visibility: **public** * This method is **abstract**. @@ -68,9 +83,9 @@ Methods ### prepare - mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types) +Query the Connection using Prepare Statement @@ -80,32 +95,18 @@ Methods #### Arguments -* $stmtName **mixed** -* $stmt **mixed** -* $values **mixed** - - - -### close - - mixed SYSTEM\DB\ConnectionAbstr::close() - - - - - -* Visibility: **public** -* This method is **abstract**. -* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) - +* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p> +* $stmt **string** - <p>SQL string of the Statement</p> +* $values **array** - <p>Array of Prepare Values</p> +* $types **string** - <p>types sql prepare string</p> ### query - mixed SYSTEM\DB\ConnectionAbstr::query($query) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query) +Query the Connection using normal Query Statement @@ -115,31 +116,33 @@ Methods #### Arguments -* $query **mixed** +* $query **string** - <p>SQL string of the Statement</p> ### exec - mixed SYSTEM\DB\Connection::exec($query) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query) +Exec Query on Database * Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) #### Arguments -* $query **mixed** +* $query **string** - <p>SQL string of the Statement</p> ### trans - mixed SYSTEM\DB\ConnectionAbstr::trans() - + boolean SYSTEM\DB\ConnectionAbstr::trans() +Open a Transaction on the Database Connection @@ -152,9 +155,9 @@ Methods ### commit - mixed SYSTEM\DB\ConnectionAbstr::commit() - + boolean SYSTEM\DB\ConnectionAbstr::commit() +Commit a Transaction on the Database Connection @@ -167,9 +170,9 @@ Methods ### getPrepareValueType - mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value) - + string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value) +Helperfunction to convert Prepared Values to SQL Type identifiers @@ -179,6 +182,6 @@ Methods #### Arguments -* $value **mixed** +* $value **string** - <p>Value to be examined regarding Type</p> diff --git a/SYSTEM-DB-ConnectionAMQP.md b/SYSTEM-DB-ConnectionAMQP.md index 25c39c9..870a77c 100644 --- a/SYSTEM-DB-ConnectionAMQP.md +++ b/SYSTEM-DB-ConnectionAMQP.md @@ -1,7 +1,7 @@ SYSTEM\DB\ConnectionAMQP =============== - +AMQP Connection Class provided by System to connect to AMQP Services. @@ -22,7 +22,7 @@ Properties private mixed $connection = NULL - +ressource Variable to store then open Connection @@ -35,9 +35,9 @@ Methods ### __construct - mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo) - + mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo) +Connect to the DB upon Construction. @@ -47,15 +47,15 @@ Methods #### Arguments -* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p> ### send - mixed SYSTEM\DB\ConnectionAMQP::send($msg) - + null SYSTEM\DB\ConnectionAMQP::send(array $msg) +Send a Message to the AMQP Server @@ -63,7 +63,7 @@ Methods #### Arguments -* $msg **mixed** +* $msg **array** - <p>Query Object</p> @@ -71,7 +71,7 @@ Methods mixed SYSTEM\DB\ConnectionAbstr::__destruct() - +Destruct the Database Connection upon Destruction. @@ -84,9 +84,9 @@ Methods ### close - mixed SYSTEM\DB\ConnectionAbstr::close() - + boolean SYSTEM\DB\ConnectionAbstr::close() +Close the Database Connection. @@ -99,9 +99,9 @@ Methods ### query - mixed SYSTEM\DB\ConnectionAbstr::query($query) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query) +Query the Connection using normal Query Statement @@ -111,15 +111,15 @@ Methods #### Arguments -* $query **mixed** +* $query **string** - <p>SQL string of the Statement</p> ### prepare - mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types) +Query the Connection using Prepare Statement @@ -129,17 +129,18 @@ Methods #### Arguments -* $stmtName **mixed** -* $stmt **mixed** -* $values **mixed** +* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p> +* $stmt **string** - <p>SQL string of the Statement</p> +* $values **array** - <p>Array of Prepare Values</p> +* $types **string** - <p>types sql prepare string</p> ### commit - mixed SYSTEM\DB\ConnectionAbstr::commit() - + boolean SYSTEM\DB\ConnectionAbstr::commit() +Commit a Transaction on the Database Connection @@ -150,11 +151,29 @@ Methods +### exec + + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query) + +Exec Query on Database + + + +* Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) + + +#### Arguments +* $query **string** - <p>SQL string of the Statement</p> + + + ### trans - mixed SYSTEM\DB\ConnectionAbstr::trans() - + boolean SYSTEM\DB\ConnectionAbstr::trans() +Open a Transaction on the Database Connection @@ -167,9 +186,9 @@ Methods ### getPrepareValueType - mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value) - + string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value) +Helperfunction to convert Prepared Values to SQL Type identifiers @@ -179,6 +198,6 @@ Methods #### Arguments -* $value **mixed** +* $value **string** - <p>Value to be examined regarding Type</p> diff --git a/SYSTEM-DB-ConnectionAbstr.md b/SYSTEM-DB-ConnectionAbstr.md index e60dd13..76fd551 100644 --- a/SYSTEM-DB-ConnectionAbstr.md +++ b/SYSTEM-DB-ConnectionAbstr.md @@ -1,7 +1,7 @@ SYSTEM\DB\ConnectionAbstr =============== - +Abstract Connection Class provided by System as a PDO Controller. @@ -22,9 +22,9 @@ Methods ### __construct - mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo) - + mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo) +Connect to the DB upon Construction. @@ -33,7 +33,7 @@ Methods #### Arguments -* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p> @@ -41,7 +41,7 @@ Methods mixed SYSTEM\DB\ConnectionAbstr::__destruct() - +Destruct the Database Connection upon Destruction. @@ -53,9 +53,9 @@ Methods ### close - mixed SYSTEM\DB\ConnectionAbstr::close() - + boolean SYSTEM\DB\ConnectionAbstr::close() +Close the Database Connection. @@ -67,9 +67,9 @@ Methods ### prepare - mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types) +Query the Connection using Prepare Statement @@ -78,17 +78,18 @@ Methods #### Arguments -* $stmtName **mixed** -* $stmt **mixed** -* $values **mixed** +* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p> +* $stmt **string** - <p>SQL string of the Statement</p> +* $values **array** - <p>Array of Prepare Values</p> +* $types **string** - <p>types sql prepare string</p> ### query - mixed SYSTEM\DB\ConnectionAbstr::query($query) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query) +Query the Connection using normal Query Statement @@ -97,16 +98,33 @@ Methods #### Arguments -* $query **mixed** +* $query **string** - <p>SQL string of the Statement</p> -### commit +### exec - mixed SYSTEM\DB\ConnectionAbstr::commit() + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query) + +Exec Query on Database +* Visibility: **public** +* This method is **abstract**. + + +#### Arguments +* $query **string** - <p>SQL string of the Statement</p> + + + +### trans + + boolean SYSTEM\DB\ConnectionAbstr::trans() + +Open a Transaction on the Database Connection + * Visibility: **public** @@ -115,11 +133,11 @@ Methods -### trans - - mixed SYSTEM\DB\ConnectionAbstr::trans() +### commit + boolean SYSTEM\DB\ConnectionAbstr::commit() +Commit a Transaction on the Database Connection @@ -131,9 +149,9 @@ Methods ### getPrepareValueType - mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value) - + string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value) +Helperfunction to convert Prepared Values to SQL Type identifiers @@ -142,6 +160,6 @@ Methods #### Arguments -* $value **mixed** +* $value **string** - <p>Value to be examined regarding Type</p> diff --git a/SYSTEM-DB-ConnectionMYS.md b/SYSTEM-DB-ConnectionMYS.md index 0388c56..95e5dc2 100644 --- a/SYSTEM-DB-ConnectionMYS.md +++ b/SYSTEM-DB-ConnectionMYS.md @@ -1,7 +1,7 @@ SYSTEM\DB\ConnectionMYS =============== - +MYSQL Connection Class provided by System to connect to MYSQL Database. @@ -22,7 +22,7 @@ Properties private mixed $connection = NULL - +ressource Variable to store then open Connection @@ -35,9 +35,9 @@ Methods ### __construct - mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo) - + mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo) +Connect to the DB upon Construction. @@ -47,7 +47,7 @@ Methods #### Arguments -* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p> @@ -55,9 +55,24 @@ Methods mixed SYSTEM\DB\ConnectionAbstr::__destruct() +Destruct the Database Connection upon Destruction. +* Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) + + + + +### close + + boolean SYSTEM\DB\ConnectionAbstr::close() + +Close the Database Connection. + + * Visibility: **public** * This method is **abstract**. @@ -68,9 +83,9 @@ Methods ### prepare - mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types) +Query the Connection using Prepare Statement @@ -80,32 +95,18 @@ Methods #### Arguments -* $stmtName **mixed** -* $stmt **mixed** -* $values **mixed** - - - -### close - - mixed SYSTEM\DB\ConnectionAbstr::close() - - - - - -* Visibility: **public** -* This method is **abstract**. -* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) - +* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p> +* $stmt **string** - <p>SQL string of the Statement</p> +* $values **array** - <p>Array of Prepare Values</p> +* $types **string** - <p>types sql prepare string</p> ### query - mixed SYSTEM\DB\ConnectionAbstr::query($query) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query) +Query the Connection using normal Query Statement @@ -115,15 +116,33 @@ Methods #### Arguments -* $query **mixed** +* $query **string** - <p>SQL string of the Statement</p> + + + +### exec + + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query) + +Exec Query on Database + + + +* Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) + + +#### Arguments +* $query **string** - <p>SQL string of the Statement</p> ### commit - mixed SYSTEM\DB\ConnectionAbstr::commit() - + boolean SYSTEM\DB\ConnectionAbstr::commit() +Commit a Transaction on the Database Connection @@ -136,9 +155,9 @@ Methods ### trans - mixed SYSTEM\DB\ConnectionAbstr::trans() - + boolean SYSTEM\DB\ConnectionAbstr::trans() +Open a Transaction on the Database Connection @@ -151,9 +170,9 @@ Methods ### getPrepareValueType - mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value) - + string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value) +Helperfunction to convert Prepared Values to SQL Type identifiers @@ -163,6 +182,6 @@ Methods #### Arguments -* $value **mixed** +* $value **string** - <p>Value to be examined regarding Type</p> diff --git a/SYSTEM-DB-ConnectionPG.md b/SYSTEM-DB-ConnectionPG.md index b3d6f71..d988f13 100644 --- a/SYSTEM-DB-ConnectionPG.md +++ b/SYSTEM-DB-ConnectionPG.md @@ -1,7 +1,7 @@ SYSTEM\DB\ConnectionPG =============== - +PostgreSQL Connection Class provided by System to connect to PostgreSQL Database. @@ -22,7 +22,7 @@ Properties private mixed $connection = NULL - +ressource Variable to store then open Connection @@ -35,9 +35,9 @@ Methods ### __construct - mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo) - + mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo) +Connect to the DB upon Construction. @@ -47,7 +47,7 @@ Methods #### Arguments -* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p> @@ -55,9 +55,24 @@ Methods mixed SYSTEM\DB\ConnectionAbstr::__destruct() +Destruct the Database Connection upon Destruction. +* Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) + + + + +### close + + boolean SYSTEM\DB\ConnectionAbstr::close() + +Close the Database Connection. + + * Visibility: **public** * This method is **abstract**. @@ -68,9 +83,9 @@ Methods ### prepare - mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types) +Query the Connection using Prepare Statement @@ -80,32 +95,18 @@ Methods #### Arguments -* $stmtName **mixed** -* $stmt **mixed** -* $values **mixed** - - - -### close - - mixed SYSTEM\DB\ConnectionAbstr::close() - - - - - -* Visibility: **public** -* This method is **abstract**. -* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) - +* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p> +* $stmt **string** - <p>SQL string of the Statement</p> +* $values **array** - <p>Array of Prepare Values</p> +* $types **string** - <p>types sql prepare string</p> ### query - mixed SYSTEM\DB\ConnectionAbstr::query($query) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query) +Query the Connection using normal Query Statement @@ -115,15 +116,15 @@ Methods #### Arguments -* $query **mixed** +* $query **string** - <p>SQL string of the Statement</p> ### trans - mixed SYSTEM\DB\ConnectionAbstr::trans() - + boolean SYSTEM\DB\ConnectionAbstr::trans() +Open a Transaction on the Database Connection @@ -136,9 +137,9 @@ Methods ### commit - mixed SYSTEM\DB\ConnectionAbstr::commit() - + boolean SYSTEM\DB\ConnectionAbstr::commit() +Commit a Transaction on the Database Connection @@ -149,11 +150,29 @@ Methods +### exec + + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query) + +Exec Query on Database + + + +* Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) + + +#### Arguments +* $query **string** - <p>SQL string of the Statement</p> + + + ### getPrepareValueType - mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value) - + string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value) +Helperfunction to convert Prepared Values to SQL Type identifiers @@ -163,6 +182,6 @@ Methods #### Arguments -* $value **mixed** +* $value **string** - <p>Value to be examined regarding Type</p> diff --git a/SYSTEM-DB-ConnectionSQLite.md b/SYSTEM-DB-ConnectionSQLite.md index 02cef6d..4040b09 100644 --- a/SYSTEM-DB-ConnectionSQLite.md +++ b/SYSTEM-DB-ConnectionSQLite.md @@ -1,7 +1,7 @@ SYSTEM\DB\ConnectionSQLite =============== - +SQLite Connection Class provided by System to connect to SQLite Databasefile. @@ -22,7 +22,7 @@ Properties private mixed $connection = NULL - +ressource Variable to store the open Connection @@ -35,9 +35,9 @@ Methods ### __construct - mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBInfo $dbinfo) - + mixed SYSTEM\DB\ConnectionAbstr::__construct(\SYSTEM\DB\DBINFO $dbinfo) +Connect to the DB upon Construction. @@ -47,7 +47,7 @@ Methods #### Arguments -* $dbinfo **[SYSTEM\DB\DBInfo](SYSTEM-DB-DBInfo)** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Information Object</p> @@ -55,9 +55,24 @@ Methods mixed SYSTEM\DB\ConnectionAbstr::__destruct() +Destruct the Database Connection upon Destruction. +* Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) + + + + +### close + + boolean SYSTEM\DB\ConnectionAbstr::close() + +Close the Database Connection. + + * Visibility: **public** * This method is **abstract**. @@ -68,9 +83,9 @@ Methods ### prepare - mixed SYSTEM\DB\ConnectionAbstr::prepare($stmtName, $stmt, $values) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::prepare(string $stmtName, string $stmt, array $values, string $types) +Query the Connection using Prepare Statement @@ -80,32 +95,18 @@ Methods #### Arguments -* $stmtName **mixed** -* $stmt **mixed** -* $values **mixed** - - - -### close - - mixed SYSTEM\DB\ConnectionAbstr::close() - - - - - -* Visibility: **public** -* This method is **abstract**. -* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) - +* $stmtName **string** - <p>Name of the Statement - espec for PostgreSQL important</p> +* $stmt **string** - <p>SQL string of the Statement</p> +* $values **array** - <p>Array of Prepare Values</p> +* $types **string** - <p>types sql prepare string</p> ### query - mixed SYSTEM\DB\ConnectionAbstr::query($query) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::query(string $query) +Query the Connection using normal Query Statement @@ -115,31 +116,33 @@ Methods #### Arguments -* $query **mixed** +* $query **string** - <p>SQL string of the Statement</p> ### exec - mixed SYSTEM\DB\ConnectionSQLite::exec($query) - + \SYSTEM\DB\Result SYSTEM\DB\ConnectionAbstr::exec(string $query) +Exec Query on Database * Visibility: **public** +* This method is **abstract**. +* This method is defined by [SYSTEM\DB\ConnectionAbstr](SYSTEM-DB-ConnectionAbstr) #### Arguments -* $query **mixed** +* $query **string** - <p>SQL string of the Statement</p> ### commit - mixed SYSTEM\DB\ConnectionAbstr::commit() - + boolean SYSTEM\DB\ConnectionAbstr::commit() +Commit a Transaction on the Database Connection @@ -152,9 +155,9 @@ Methods ### trans - mixed SYSTEM\DB\ConnectionAbstr::trans() - + boolean SYSTEM\DB\ConnectionAbstr::trans() +Open a Transaction on the Database Connection @@ -167,9 +170,9 @@ Methods ### getPrepareValueType - mixed SYSTEM\DB\ConnectionAbstr::getPrepareValueType($value) - + string SYSTEM\DB\ConnectionAbstr::getPrepareValueType(string $value) +Helperfunction to convert Prepared Values to SQL Type identifiers @@ -179,6 +182,6 @@ Methods #### Arguments -* $value **mixed** +* $value **string** - <p>Value to be examined regarding Type</p> diff --git a/SYSTEM-DB-DBInfo.md b/SYSTEM-DB-DBInfo.md index 320e560..4b1ba55 100644 --- a/SYSTEM-DB-DBInfo.md +++ b/SYSTEM-DB-DBInfo.md @@ -1,7 +1,7 @@ SYSTEM\DB\DBInfo =============== - +DBInfo Abstract Class provided by System to hold Database Information. @@ -22,7 +22,7 @@ Properties public mixed $m_database = null - +string Variable to store Database name @@ -33,7 +33,7 @@ Properties public mixed $m_user = null - +string Variable to store Database user @@ -44,7 +44,7 @@ Properties public mixed $m_password = null - +string Variable to store Database password @@ -55,7 +55,7 @@ Properties public mixed $m_host = null - +string Variable to store Database host @@ -66,7 +66,7 @@ Properties public mixed $m_port = null - +int Variable to store Database port @@ -79,9 +79,9 @@ Methods ### __construct - mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port) - + mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port) +Store Data upon Construction. @@ -90,10 +90,10 @@ Methods #### Arguments -* $database **mixed** -* $user **mixed** -* $password **mixed** -* $host **mixed** -* $port **mixed** +* $database **string** - <p>Database name</p> +* $user **string** - <p>Database user</p> +* $password **string** - <p>Database password</p> +* $host **string** - <p>Database host</p> +* $port **integer** - <p>Database port</p> diff --git a/SYSTEM-DB-DBInfoAMQP.md b/SYSTEM-DB-DBInfoAMQP.md index cee97ce..43147b6 100644 --- a/SYSTEM-DB-DBInfoAMQP.md +++ b/SYSTEM-DB-DBInfoAMQP.md @@ -1,7 +1,7 @@ SYSTEM\DB\DBInfoAMQP =============== - +DBInfoAMQP Class provided by System to hold AMQP Database Information. @@ -22,7 +22,7 @@ Properties public mixed $m_database = null - +string Variable to store Database name @@ -33,7 +33,7 @@ Properties public mixed $m_user = null - +string Variable to store Database user @@ -44,7 +44,7 @@ Properties public mixed $m_password = null - +string Variable to store Database password @@ -55,7 +55,7 @@ Properties public mixed $m_host = null - +string Variable to store Database host @@ -66,7 +66,7 @@ Properties public mixed $m_port = null - +int Variable to store Database port @@ -79,9 +79,9 @@ Methods ### __construct - mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port) - + mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port) +Store Data upon Construction. @@ -91,10 +91,10 @@ Methods #### Arguments -* $database **mixed** -* $user **mixed** -* $password **mixed** -* $host **mixed** -* $port **mixed** +* $database **string** - <p>Database name</p> +* $user **string** - <p>Database user</p> +* $password **string** - <p>Database password</p> +* $host **string** - <p>Database host</p> +* $port **integer** - <p>Database port</p> diff --git a/SYSTEM-DB-DBInfoMYS.md b/SYSTEM-DB-DBInfoMYS.md index e815fb4..b8a526f 100644 --- a/SYSTEM-DB-DBInfoMYS.md +++ b/SYSTEM-DB-DBInfoMYS.md @@ -1,7 +1,7 @@ SYSTEM\DB\DBInfoMYS =============== - +DBInfoMYS Class provided by System to hold MYSQL Database Information. @@ -22,7 +22,7 @@ Properties public mixed $m_database = null - +string Variable to store Database name @@ -33,7 +33,7 @@ Properties public mixed $m_user = null - +string Variable to store Database user @@ -44,7 +44,7 @@ Properties public mixed $m_password = null - +string Variable to store Database password @@ -55,7 +55,7 @@ Properties public mixed $m_host = null - +string Variable to store Database host @@ -66,7 +66,7 @@ Properties public mixed $m_port = null - +int Variable to store Database port @@ -79,9 +79,9 @@ Methods ### __construct - mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port) - + mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port) +Store Data upon Construction. @@ -91,10 +91,10 @@ Methods #### Arguments -* $database **mixed** -* $user **mixed** -* $password **mixed** -* $host **mixed** -* $port **mixed** +* $database **string** - <p>Database name</p> +* $user **string** - <p>Database user</p> +* $password **string** - <p>Database password</p> +* $host **string** - <p>Database host</p> +* $port **integer** - <p>Database port</p> diff --git a/SYSTEM-DB-DBInfoPG.md b/SYSTEM-DB-DBInfoPG.md index 1da11fd..4d4e3dc 100644 --- a/SYSTEM-DB-DBInfoPG.md +++ b/SYSTEM-DB-DBInfoPG.md @@ -1,7 +1,7 @@ SYSTEM\DB\DBInfoPG =============== - +DBInfoPG Class provided by System to hold PostgreSQL Database Information. @@ -22,7 +22,7 @@ Properties public mixed $m_database = null - +string Variable to store Database name @@ -33,7 +33,7 @@ Properties public mixed $m_user = null - +string Variable to store Database user @@ -44,7 +44,7 @@ Properties public mixed $m_password = null - +string Variable to store Database password @@ -55,7 +55,7 @@ Properties public mixed $m_host = null - +string Variable to store Database host @@ -66,7 +66,7 @@ Properties public mixed $m_port = null - +int Variable to store Database port @@ -79,9 +79,9 @@ Methods ### __construct - mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port) - + mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port) +Store Data upon Construction. @@ -91,10 +91,10 @@ Methods #### Arguments -* $database **mixed** -* $user **mixed** -* $password **mixed** -* $host **mixed** -* $port **mixed** +* $database **string** - <p>Database name</p> +* $user **string** - <p>Database user</p> +* $password **string** - <p>Database password</p> +* $host **string** - <p>Database host</p> +* $port **integer** - <p>Database port</p> diff --git a/SYSTEM-DB-DBInfoSQLite.md b/SYSTEM-DB-DBInfoSQLite.md index 9166765..3aacccf 100644 --- a/SYSTEM-DB-DBInfoSQLite.md +++ b/SYSTEM-DB-DBInfoSQLite.md @@ -1,7 +1,7 @@ SYSTEM\DB\DBInfoSQLite =============== - +DBInfoSQLite Class provided by System to hold SQLite File-Database Information. @@ -22,7 +22,7 @@ Properties public mixed $m_database = null - +string Variable to store Database name @@ -33,7 +33,7 @@ Properties public mixed $m_user = null - +string Variable to store Database user @@ -44,7 +44,7 @@ Properties public mixed $m_password = null - +string Variable to store Database password @@ -55,7 +55,7 @@ Properties public mixed $m_host = null - +string Variable to store Database host @@ -66,7 +66,7 @@ Properties public mixed $m_port = null - +int Variable to store Database port @@ -79,9 +79,9 @@ Methods ### __construct - mixed SYSTEM\DB\DBInfo::__construct($database, $user, $password, $host, $port) - + mixed SYSTEM\DB\DBInfo::__construct(string $database, string $user, string $password, string $host, integer $port) +Store Data upon Construction. @@ -91,10 +91,10 @@ Methods #### Arguments -* $database **mixed** -* $user **mixed** -* $password **mixed** -* $host **mixed** -* $port **mixed** +* $database **string** - <p>Database name</p> +* $user **string** - <p>Database user</p> +* $password **string** - <p>Database password</p> +* $host **string** - <p>Database host</p> +* $port **integer** - <p>Database port</p> diff --git a/SYSTEM-DB-QI.md b/SYSTEM-DB-QI.md index c391cc3..db0ddd4 100644 --- a/SYSTEM-DB-QI.md +++ b/SYSTEM-DB-QI.md @@ -1,7 +1,7 @@ SYSTEM\DB\QI =============== - +QI Class provided by System to execute quick installation statements. @@ -21,9 +21,10 @@ Methods ### QI - mixed SYSTEM\DB\QI::QI($dbinfo) - + array SYSTEM\DB\QI::QI(\SYSTEM\DB\DBINFO $dbinfo) +Executes stored action by calling either files_pgsql() or files_mysql() +of inherting class @@ -32,6 +33,6 @@ Methods #### Arguments -* $dbinfo **mixed** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> diff --git a/SYSTEM-DB-QP.md b/SYSTEM-DB-QP.md index 6a1099c..f64313a 100644 --- a/SYSTEM-DB-QP.md +++ b/SYSTEM-DB-QP.md @@ -1,7 +1,7 @@ SYSTEM\DB\QP =============== - +QQ Class provided by System to execute quick prepare statements. @@ -21,9 +21,9 @@ Methods ### QQ - mixed SYSTEM\DB\QP::QQ($params, $dbinfo) - + \SYSTEM\DB\Result SYSTEM\DB\QP::QQ(array $params, \SYSTEM\DB\DBINFO $dbinfo) +Executes stored action and return Database Object @@ -32,16 +32,16 @@ Methods #### Arguments -* $params **mixed** -* $dbinfo **mixed** +* $params **array** - <p>Parameter passed to the prepare-query</p> +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> ### QA - mixed SYSTEM\DB\QP::QA($params, $dbinfo) - + array SYSTEM\DB\QP::QA(array $params, \SYSTEM\DB\DBINFO $dbinfo) +Executes stored action and return all Data found @@ -50,16 +50,16 @@ Methods #### Arguments -* $params **mixed** -* $dbinfo **mixed** +* $params **array** - <p>Parameter passed to the prepare-query</p> +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> ### Q1 - mixed SYSTEM\DB\QP::Q1($params, $dbinfo) - + array SYSTEM\DB\QP::Q1(array $params, \SYSTEM\DB\DBINFO $dbinfo) +Executes stored action and return one line of Data found @@ -68,25 +68,25 @@ Methods #### Arguments -* $params **mixed** -* $dbinfo **mixed** +* $params **array** - <p>Parameter passed to the prepare-query</p> +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> ### QI - mixed SYSTEM\DB\QP::QI($params, $dbinfo) - - + boolean SYSTEM\DB\QP::QI(array $params, \SYSTEM\DB\DBINFO $dbinfo) +Executes stored action and return Database Result Object. +Use this function if the Result is either true or false (update/delete/insert) * Visibility: **public** * This method is **static**. #### Arguments -* $params **mixed** -* $dbinfo **mixed** +* $params **array** - <p>Parameter passed to the prepare-query</p> +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> diff --git a/SYSTEM-DB-QQ.md b/SYSTEM-DB-QQ.md index 839aecb..f1b10df 100644 --- a/SYSTEM-DB-QQ.md +++ b/SYSTEM-DB-QQ.md @@ -1,7 +1,7 @@ SYSTEM\DB\QQ =============== - +QQ Class provided by System to execute quick query statements. @@ -21,9 +21,9 @@ Methods ### QQ - mixed SYSTEM\DB\QQ::QQ($dbinfo) - + \SYSTEM\DB\Result SYSTEM\DB\QQ::QQ(\SYSTEM\DB\DBINFO $dbinfo) +Executes stored action and return Database Object @@ -32,15 +32,15 @@ Methods #### Arguments -* $dbinfo **mixed** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> ### QA - mixed SYSTEM\DB\QQ::QA($dbinfo) - + array SYSTEM\DB\QQ::QA(\SYSTEM\DB\DBINFO $dbinfo) +Executes stored action and return all Data found @@ -49,15 +49,15 @@ Methods #### Arguments -* $dbinfo **mixed** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> ### Q1 - mixed SYSTEM\DB\QQ::Q1($dbinfo) - + array SYSTEM\DB\QQ::Q1(\SYSTEM\DB\DBINFO $dbinfo) +Executes stored action and return one line of Data found @@ -66,23 +66,23 @@ Methods #### Arguments -* $dbinfo **mixed** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> ### QI - mixed SYSTEM\DB\QQ::QI($dbinfo) - - + boolean SYSTEM\DB\QQ::QI(\SYSTEM\DB\DBINFO $dbinfo) +Executes stored action and return Database Result Object. +Use this function if the Result is either true or false (update/delete/insert) * Visibility: **public** * This method is **static**. #### Arguments -* $dbinfo **mixed** +* $dbinfo **SYSTEM\DB\DBINFO** - <p>Database Info or Null for Default DB</p> diff --git a/SYSTEM-DB-Result.md b/SYSTEM-DB-Result.md index 081a34e..139ff5a 100644 --- a/SYSTEM-DB-Result.md +++ b/SYSTEM-DB-Result.md @@ -1,7 +1,7 @@ SYSTEM\DB\Result =============== - +Result Class provided by System to hold Database Query Result Ressources. @@ -22,9 +22,9 @@ Methods ### count - mixed SYSTEM\DB\Result::count() - + integer SYSTEM\DB\Result::count() +Counts the Lines in the Resultset @@ -36,9 +36,9 @@ Methods ### affectedRows - mixed SYSTEM\DB\Result::affectedRows() - + integer SYSTEM\DB\Result::affectedRows() +Counts the affected lines in the Resultset @@ -50,9 +50,9 @@ Methods ### next - mixed SYSTEM\DB\Result::next($object) - + array SYSTEM\DB\Result::next(boolean $object) +Returns the next line in the Resultset @@ -61,15 +61,15 @@ Methods #### Arguments -* $object **mixed** +* $object **boolean** - <p>Determines if the result will be an object or array</p> ### seek - mixed SYSTEM\DB\Result::seek($row_number) - + boolean SYSTEM\DB\Result::seek(integer $row_number) +Seeks an amount of lines within the Resultset @@ -78,15 +78,15 @@ Methods #### Arguments -* $row_number **mixed** +* $row_number **integer** - <p>Lines to seek over</p> ### close - mixed SYSTEM\DB\Result::close() - + null SYSTEM\DB\Result::close() +Closes the Resultset diff --git a/SYSTEM-DB-ResultAMQP.md b/SYSTEM-DB-ResultAMQP.md index 2099a57..f874e19 100644 --- a/SYSTEM-DB-ResultAMQP.md +++ b/SYSTEM-DB-ResultAMQP.md @@ -1,7 +1,7 @@ SYSTEM\DB\ResultAMQP =============== - +Result Class provided by System to hold Database Query Result Ressources of AMQP Querys. @@ -22,7 +22,7 @@ Properties private mixed $res = NULL - +ressource Variable to store Database Result-ressource @@ -33,7 +33,7 @@ Properties private mixed $current = NULL - +ressource Variable to store current Line either as array or object @@ -46,9 +46,9 @@ Methods ### __construct - mixed SYSTEM\DB\ResultAMQP::__construct($res) - + mixed SYSTEM\DB\ResultAMQP::__construct(\SYSTEM\DB\ressource $res) +Construct the Resultset with a database ressource @@ -56,7 +56,7 @@ Methods #### Arguments -* $res **mixed** +* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p> @@ -64,7 +64,7 @@ Methods mixed SYSTEM\DB\ResultAMQP::__destruct() - +Close Resultset upon destruction @@ -75,9 +75,9 @@ Methods ### close - mixed SYSTEM\DB\Result::close() - + null SYSTEM\DB\Result::close() +Closes the Resultset @@ -90,9 +90,9 @@ Methods ### count - mixed SYSTEM\DB\Result::count() - + integer SYSTEM\DB\Result::count() +Counts the Lines in the Resultset @@ -105,9 +105,9 @@ Methods ### affectedRows - mixed SYSTEM\DB\Result::affectedRows() - + integer SYSTEM\DB\Result::affectedRows() +Counts the affected lines in the Resultset @@ -120,9 +120,9 @@ Methods ### next - mixed SYSTEM\DB\Result::next($object) - + array SYSTEM\DB\Result::next(boolean $object) +Returns the next line in the Resultset @@ -132,15 +132,15 @@ Methods #### Arguments -* $object **mixed** +* $object **boolean** - <p>Determines if the result will be an object or array</p> ### seek - mixed SYSTEM\DB\Result::seek($row_number) - + boolean SYSTEM\DB\Result::seek(integer $row_number) +Seeks an amount of lines within the Resultset @@ -150,6 +150,6 @@ Methods #### Arguments -* $row_number **mixed** +* $row_number **integer** - <p>Lines to seek over</p> diff --git a/SYSTEM-DB-ResultMysqli.md b/SYSTEM-DB-ResultMysqli.md index 1679b88..2548722 100644 --- a/SYSTEM-DB-ResultMysqli.md +++ b/SYSTEM-DB-ResultMysqli.md @@ -1,7 +1,7 @@ SYSTEM\DB\ResultMysqli =============== - +Result Class provided by System to hold Database Query Result Ressources of MYSQL Querys. @@ -22,7 +22,7 @@ Properties private mixed $res = NULL - +ressource Variable to store Database Result-ressource @@ -33,7 +33,7 @@ Properties private mixed $current = NULL - +ressource Variable to store current Line either as array or object @@ -46,9 +46,9 @@ Methods ### __construct - mixed SYSTEM\DB\ResultMysqli::__construct($res) - + mixed SYSTEM\DB\ResultMysqli::__construct(\SYSTEM\DB\ressource $res) +Construct the Resultset with a database ressource @@ -56,7 +56,7 @@ Methods #### Arguments -* $res **mixed** +* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p> @@ -64,7 +64,7 @@ Methods mixed SYSTEM\DB\ResultMysqli::__destruct() - +Close Resultset upon destruction @@ -75,9 +75,9 @@ Methods ### close - mixed SYSTEM\DB\Result::close() - + null SYSTEM\DB\Result::close() +Closes the Resultset @@ -90,9 +90,9 @@ Methods ### count - mixed SYSTEM\DB\Result::count() - + integer SYSTEM\DB\Result::count() +Counts the Lines in the Resultset @@ -105,9 +105,9 @@ Methods ### affectedRows - mixed SYSTEM\DB\Result::affectedRows() - + integer SYSTEM\DB\Result::affectedRows() +Counts the affected lines in the Resultset @@ -120,9 +120,9 @@ Methods ### next - mixed SYSTEM\DB\Result::next($object) - + array SYSTEM\DB\Result::next(boolean $object) +Returns the next line in the Resultset @@ -132,15 +132,15 @@ Methods #### Arguments -* $object **mixed** +* $object **boolean** - <p>Determines if the result will be an object or array</p> ### seek - mixed SYSTEM\DB\Result::seek($row_number) - + boolean SYSTEM\DB\Result::seek(integer $row_number) +Seeks an amount of lines within the Resultset @@ -150,6 +150,6 @@ Methods #### Arguments -* $row_number **mixed** +* $row_number **integer** - <p>Lines to seek over</p> diff --git a/SYSTEM-DB-ResultMysqliPrepare.md b/SYSTEM-DB-ResultMysqliPrepare.md index 4490660..430ed15 100644 --- a/SYSTEM-DB-ResultMysqliPrepare.md +++ b/SYSTEM-DB-ResultMysqliPrepare.md @@ -1,7 +1,7 @@ SYSTEM\DB\ResultMysqliPrepare =============== - +Result Class provided by System to hold Database Query Result Ressources of MYSQL prepare Querys. @@ -22,7 +22,7 @@ Properties private mixed $res = NULL - +ressource Variable to store Database Result-ressource @@ -33,7 +33,7 @@ Properties private mixed $meta = NULL - +ressource Variable to store Metadata of Colums @@ -44,7 +44,7 @@ Properties private mixed $binds = array() - +ressource Variable to store Binding Variables @@ -55,7 +55,7 @@ Properties private mixed $connection = NULL - +ressource Variable to store Database Connection @@ -68,9 +68,9 @@ Methods ### __construct - mixed SYSTEM\DB\ResultMysqliPrepare::__construct($res, $connection) - + mixed SYSTEM\DB\ResultMysqliPrepare::__construct(\SYSTEM\DB\ressource $res, \SYSTEM\DB\ressource $connection) +Construct the Resultset with a database ressource @@ -78,8 +78,8 @@ Methods #### Arguments -* $res **mixed** -* $connection **mixed** +* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p> +* $connection **SYSTEM\DB\ressource** - <p>Connection on which the Result-Set was returned</p> @@ -87,7 +87,7 @@ Methods mixed SYSTEM\DB\ResultMysqliPrepare::__destruct() - +Close Resultset upon destruction @@ -98,9 +98,9 @@ Methods ### close - mixed SYSTEM\DB\Result::close() - + null SYSTEM\DB\Result::close() +Closes the Resultset @@ -113,9 +113,9 @@ Methods ### count - mixed SYSTEM\DB\Result::count() - + integer SYSTEM\DB\Result::count() +Counts the Lines in the Resultset @@ -128,9 +128,9 @@ Methods ### affectedRows - mixed SYSTEM\DB\Result::affectedRows() - + integer SYSTEM\DB\Result::affectedRows() +Counts the affected lines in the Resultset @@ -143,9 +143,9 @@ Methods ### next - mixed SYSTEM\DB\Result::next($object) - + array SYSTEM\DB\Result::next(boolean $object) +Returns the next line in the Resultset @@ -155,15 +155,15 @@ Methods #### Arguments -* $object **mixed** +* $object **boolean** - <p>Determines if the result will be an object or array</p> ### seek - mixed SYSTEM\DB\Result::seek($row_number) - + boolean SYSTEM\DB\Result::seek(integer $row_number) +Seeks an amount of lines within the Resultset @@ -173,6 +173,6 @@ Methods #### Arguments -* $row_number **mixed** +* $row_number **integer** - <p>Lines to seek over</p> diff --git a/SYSTEM-DB-ResultPostgres.md b/SYSTEM-DB-ResultPostgres.md index 6e04d03..f07b249 100644 --- a/SYSTEM-DB-ResultPostgres.md +++ b/SYSTEM-DB-ResultPostgres.md @@ -1,7 +1,7 @@ SYSTEM\DB\ResultPostgres =============== - +Result Class provided by System to hold Database Query Result Ressources of PostgreSQL Querys. @@ -22,7 +22,7 @@ Properties private mixed $res = NULL - +ressource Variable to store Database Result-ressource @@ -33,7 +33,7 @@ Properties private mixed $current = NULL - +ressource Variable to store current Line either as array or object @@ -44,7 +44,7 @@ Properties private mixed $connection = NULL - +ressource Variable to store Database Connection @@ -57,9 +57,9 @@ Methods ### __construct - mixed SYSTEM\DB\ResultPostgres::__construct($res, $connection) - + mixed SYSTEM\DB\ResultPostgres::__construct(\SYSTEM\DB\ressource $res, \SYSTEM\DB\ressource $connection) +Construct the Resultset with a database ressource @@ -67,8 +67,8 @@ Methods #### Arguments -* $res **mixed** -* $connection **mixed** +* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p> +* $connection **SYSTEM\DB\ressource** - <p>Connection on which the Result-Set was returned</p> @@ -76,7 +76,7 @@ Methods mixed SYSTEM\DB\ResultPostgres::__destruct() - +Close Resultset upon destruction @@ -87,9 +87,9 @@ Methods ### close - mixed SYSTEM\DB\Result::close() - + null SYSTEM\DB\Result::close() +Closes the Resultset @@ -102,9 +102,9 @@ Methods ### count - mixed SYSTEM\DB\Result::count() - + integer SYSTEM\DB\Result::count() +Counts the Lines in the Resultset @@ -117,9 +117,9 @@ Methods ### affectedRows - mixed SYSTEM\DB\Result::affectedRows() - + integer SYSTEM\DB\Result::affectedRows() +Counts the affected lines in the Resultset @@ -132,9 +132,9 @@ Methods ### next - mixed SYSTEM\DB\Result::next($object) - + array SYSTEM\DB\Result::next(boolean $object) +Returns the next line in the Resultset @@ -144,15 +144,15 @@ Methods #### Arguments -* $object **mixed** +* $object **boolean** - <p>Determines if the result will be an object or array</p> ### seek - mixed SYSTEM\DB\Result::seek($row_number) - + boolean SYSTEM\DB\Result::seek(integer $row_number) +Seeks an amount of lines within the Resultset @@ -162,6 +162,6 @@ Methods #### Arguments -* $row_number **mixed** +* $row_number **integer** - <p>Lines to seek over</p> diff --git a/SYSTEM-DB-ResultSQLite.md b/SYSTEM-DB-ResultSQLite.md index 1bf2941..13c6fa4 100644 --- a/SYSTEM-DB-ResultSQLite.md +++ b/SYSTEM-DB-ResultSQLite.md @@ -1,7 +1,7 @@ SYSTEM\DB\ResultSQLite =============== - +Result Class provided by System to hold Database Query Result Ressources of SQLite File Querys. @@ -22,7 +22,7 @@ Properties private mixed $res = NULL - +ressource Variable to store Database Result-ressource @@ -33,7 +33,7 @@ Properties private mixed $stmt = NULL - +ressource Variable to store query statement @@ -44,7 +44,7 @@ Properties private mixed $current = NULL - +ressource Variable to store current Line either as array or object @@ -57,9 +57,9 @@ Methods ### __construct - mixed SYSTEM\DB\ResultSQLite::__construct($res, $stmt) - + mixed SYSTEM\DB\ResultSQLite::__construct(\SYSTEM\DB\ressource $res, string $stmt) +Construct the Resultset with a database ressource @@ -67,8 +67,8 @@ Methods #### Arguments -* $res **mixed** -* $stmt **mixed** +* $res **SYSTEM\DB\ressource** - <p>Ressource of the Database Result-Set</p> +* $stmt **string** - <p>Query Statement which produced the result set</p> @@ -76,7 +76,7 @@ Methods mixed SYSTEM\DB\ResultSQLite::__destruct() - +Close Resultset upon destruction @@ -87,9 +87,9 @@ Methods ### close - mixed SYSTEM\DB\Result::close() - + null SYSTEM\DB\Result::close() +Closes the Resultset @@ -102,9 +102,9 @@ Methods ### count - mixed SYSTEM\DB\Result::count() - + integer SYSTEM\DB\Result::count() +Counts the Lines in the Resultset @@ -117,9 +117,9 @@ Methods ### affectedRows - mixed SYSTEM\DB\Result::affectedRows() - + integer SYSTEM\DB\Result::affectedRows() +Counts the affected lines in the Resultset @@ -132,9 +132,9 @@ Methods ### next - mixed SYSTEM\DB\Result::next($object) - + array SYSTEM\DB\Result::next(boolean $object) +Returns the next line in the Resultset @@ -144,15 +144,15 @@ Methods #### Arguments -* $object **mixed** +* $object **boolean** - <p>Determines if the result will be an object or array</p> ### seek - mixed SYSTEM\DB\Result::seek($row_number) - + boolean SYSTEM\DB\Result::seek(integer $row_number) +Seeks an amount of lines within the Resultset @@ -162,6 +162,6 @@ Methods #### Arguments -* $row_number **mixed** +* $row_number **integer** - <p>Lines to seek over</p> diff --git a/SYSTEM-DOCU-docu.md b/SYSTEM-DOCU-docu.md index 42a0b58..63f71ea 100644 --- a/SYSTEM-DOCU-docu.md +++ b/SYSTEM-DOCU-docu.md @@ -1,7 +1,7 @@ SYSTEM\DOCU\docu =============== - +Docu Class provided by System to register docu_packages. @@ -17,11 +17,11 @@ Properties ---------- -### $phpdocconfigs - - private mixed $phpdocconfigs = array() +### $docu_packages + private mixed $docu_packages = array() +array Variable to store all registred docu_package classes @@ -35,9 +35,9 @@ Methods ### register - mixed SYSTEM\DOCU\docu::register($phpdocconfig) - + null SYSTEM\DOCU\docu::register(string $docu_package) +Register a docu package @@ -46,15 +46,15 @@ Methods #### Arguments -* $phpdocconfig **mixed** +* $docu_package **string** - <p>Classname of Docu Package to be registered</p> ### getAll - mixed SYSTEM\DOCU\docu::getAll() - + array SYSTEM\DOCU\docu::getAll() +Get all registered docu packages @@ -66,9 +66,9 @@ Methods ### get - mixed SYSTEM\DOCU\docu::get($id) - + array SYSTEM\DOCU\docu::get(string $id) +Get a specific docu package by classname @@ -77,6 +77,40 @@ Methods #### Arguments -* $id **mixed** +* $id **string** - <p>Class name of the package to be found</p> + + + +### generate + + array SYSTEM\DOCU\docu::generate(string $id) + +Generate HTML Docu by docu classname + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $id **string** - <p>Classname of Docu Package to generated</p> + + + +### generate_md + + array SYSTEM\DOCU\docu::generate_md(string $id) + +Generate Markdown Docu by docu classname + + + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $id **string** - <p>Classname of Docu Package to generated</p> diff --git a/SYSTEM-DOCU-docu_package.md b/SYSTEM-DOCU-docu_package.md new file mode 100644 index 0000000..718ffef --- /dev/null +++ b/SYSTEM-DOCU-docu_package.md @@ -0,0 +1,34 @@ +SYSTEM\DOCU\docu_package +=============== + +Docu Package Interface to abstract from for every docu to be registered. + + + + +* Interface name: docu_package +* Namespace: SYSTEM\DOCU +* This is an **interface** + + + + + + +Methods +------- + + +### get_config + + array SYSTEM\DOCU\docu_package::get_config() + +Config of the Docu Package + + + +* Visibility: **public** +* This method is **static**. + + + diff --git a/SYSTEM-DOCU-docu_system.md b/SYSTEM-DOCU-docu_system.md new file mode 100644 index 0000000..2c14ded --- /dev/null +++ b/SYSTEM-DOCU-docu_system.md @@ -0,0 +1,35 @@ +SYSTEM\DOCU\docu_system +=============== + +Docu Package Class for System. + + + + +* Class name: docu_system +* Namespace: SYSTEM\DOCU +* This class implements: [SYSTEM\DOCU\docu_package](SYSTEM-DOCU-docu_package) + + + + + + +Methods +------- + + +### get_config + + array SYSTEM\DOCU\docu_package::get_config() + +Config of the Docu Package + + + +* Visibility: **public** +* This method is **static**. +* This method is defined by [SYSTEM\DOCU\docu_package](SYSTEM-DOCU-docu_package) + + + diff --git a/SYSTEM-FILES-files.md b/SYSTEM-FILES-files.md index 7f54ec9..8c3fcb9 100644 --- a/SYSTEM-FILES-files.md +++ b/SYSTEM-FILES-files.md @@ -1,7 +1,7 @@ SYSTEM\FILES\files =============== - +Files Class provided by System to register folders and serve files. @@ -21,7 +21,7 @@ Properties private mixed $folders = array() - +array Variable to store all registred file folders @@ -35,9 +35,9 @@ Methods ### registerFolder - mixed SYSTEM\FILES\files::registerFolder($path, $cat) - + null SYSTEM\FILES\files::registerFolder(string $path, string $cat) +Register a filefolder @@ -46,16 +46,16 @@ Methods #### Arguments -* $path **mixed** -* $cat **mixed** +* $path **string** - <p>Path of the Folder</p> +* $cat **string** - <p>Category to register that folder to</p> ### get - mixed SYSTEM\FILES\files::get($cat, $id, $returnasjson) - + mixed SYSTEM\FILES\files::get(string $cat, string $id, boolean $returnasjson) +Retrieve a File @@ -64,17 +64,17 @@ Methods #### Arguments -* $cat **mixed** -* $id **mixed** -* $returnasjson **mixed** +* $cat **string** - <p>Category to query or null</p> +* $id **string** - <p>File to query or null</p> +* $returnasjson **boolean** - <p>Determines if you recieve Arrays or JSON results</p> ### put - mixed SYSTEM\FILES\files::put($cat, $id, $contents) - + boolean SYSTEM\FILES\files::put(string $cat, string $id, \SYSTEM\FILES\ressource $contents) +Move a uploaded File into a Directtory @@ -83,17 +83,17 @@ Methods #### Arguments -* $cat **mixed** -* $id **mixed** -* $contents **mixed** +* $cat **string** - <p>Category for the File</p> +* $id **string** - <p>ID for the File</p> +* $contents **SYSTEM\FILES\ressource** - <p>Uploaded File Ressource</p> ### delete - mixed SYSTEM\FILES\files::delete($cat, $id) - + boolean SYSTEM\FILES\files::delete(string $cat, string $id) +Delete a File @@ -102,16 +102,16 @@ Methods #### Arguments -* $cat **mixed** -* $id **mixed** +* $cat **string** - <p>Category of the File</p> +* $id **string** - <p>ID of the File</p> ### rename - mixed SYSTEM\FILES\files::rename($cat, $id, $newid) - + boolean SYSTEM\FILES\files::rename(string $cat, string $id, string $newid) +Rename a File @@ -120,17 +120,17 @@ Methods #### Arguments -* $cat **mixed** -* $id **mixed** -* $newid **mixed** +* $cat **string** - <p>Category of the File</p> +* $id **string** - <p>ID of the File</p> +* $newid **string** - <p>ID of the renamed File</p> ### getFolder - mixed SYSTEM\FILES\files::getFolder($folder) - + array SYSTEM\FILES\files::getFolder(string $folder) +Returns the contents of a Folder @@ -139,15 +139,15 @@ Methods #### Arguments -* $folder **mixed** +* $folder **string** - <p>Path to the Folder</p> ### getURL - mixed SYSTEM\FILES\files::getURL($cat, $id) - + string SYSTEM\FILES\files::getURL(string $cat, string $id) +Returns a URL for a File @@ -156,16 +156,17 @@ Methods #### Arguments -* $cat **mixed** -* $id **mixed** +* $cat **string** - <p>Category of the File</p> +* $id **string** - <p>ID of the File</p> ### file_get_contents_chunked - mixed SYSTEM\FILES\files::file_get_contents_chunked($file, $chunk_size, $callback) - + boolean SYSTEM\FILES\files::file_get_contents_chunked(string $file, integer $chunk_size, \SYSTEM\FILES\function $callback) +Returns Chunks of a File +Callback: function($chunk,&$handle,$iteration) @@ -174,8 +175,8 @@ Methods #### Arguments -* $file **mixed** -* $chunk_size **mixed** -* $callback **mixed** +* $file **string** - <p>Path of the File</p> +* $chunk_size **integer** - <p>Size of the Chunks</p> +* $callback **SYSTEM\FILES\function** - <p>Callback function which is called for every chunk</p> diff --git a/SYSTEM-HEADER.md b/SYSTEM-HEADER.md index 83da2b2..7ae495f 100644 --- a/SYSTEM-HEADER.md +++ b/SYSTEM-HEADER.md @@ -1,7 +1,7 @@ SYSTEM\HEADER =============== - +HEADER Class provided by System Send HTML Headers @@ -21,9 +21,10 @@ Methods ### checkHeader - mixed SYSTEM\HEADER::checkHeader() - + boolean SYSTEM\HEADER::checkHeader() +Check if Header was already sent +Writes Warning into Database on failure if Database logging is enabled. @@ -33,11 +34,28 @@ Methods +### available + + boolean SYSTEM\HEADER::available(string $datatype) + +Check if a given Datatype has a handler within this class. + +Not Case sensitive. + +* Visibility: **public** +* This method is **static**. + + +#### Arguments +* $datatype **string** - <p>Datatype to be checked eg. 'jpg'</p> + + + ### JSON - mixed SYSTEM\HEADER::JSON() - + null SYSTEM\HEADER::JSON() +Send JSON Headers, if Header was not sent yet @@ -49,9 +67,9 @@ Methods ### PNG - mixed SYSTEM\HEADER::PNG() - + null SYSTEM\HEADER::PNG() +Send PNG Headers, if Header was not sent yet @@ -63,9 +81,9 @@ Methods ### JPG - mixed SYSTEM\HEADER::JPG() - + null SYSTEM\HEADER::JPG() +Send JPG Headers, if Header was not sent yet @@ -77,9 +95,9 @@ Methods ### JPEG - mixed SYSTEM\HEADER::JPEG() - + null SYSTEM\HEADER::JPEG() +Send JPEG Headers, if Header was not sent yet @@ -91,9 +109,9 @@ Methods ### GIF - mixed SYSTEM\HEADER::GIF() - + null SYSTEM\HEADER::GIF() +Send GIF Headers, if Header was not sent yet @@ -105,9 +123,9 @@ Methods ### JS - mixed SYSTEM\HEADER::JS() - + null SYSTEM\HEADER::JS() +Send JS Headers, if Header was not sent yet @@ -119,9 +137,9 @@ Methods ### CSS - mixed SYSTEM\HEADER::CSS() - + null SYSTEM\HEADER::CSS() +Send CSS Headers, if Header was not sent yet @@ -133,9 +151,9 @@ Methods ### LESS - mixed SYSTEM\HEADER::LESS() - + null SYSTEM\HEADER::LESS() +Send LESS Headers, if Header was not sent yet @@ -147,9 +165,9 @@ Methods ### FILE - mixed SYSTEM\HEADER::FILE($filename) - + null SYSTEM\HEADER::FILE(string $filename) +Send FILE(download) Headers, if Header was not sent yet @@ -158,23 +176,6 @@ Methods #### Arguments -* $filename **mixed** - - - -### available - - mixed SYSTEM\HEADER::available($datatype) - - - - - -* Visibility: **public** -* This method is **static**. - - -#### Arguments -* $datatype **mixed** +* $filename **string** - <p>Filename which should be transmitted with the Filetransfere</p> diff --git a/SYSTEM-HTML-html.md b/SYSTEM-HTML-html.md index e06b228..7e0a5c2 100644 --- a/SYSTEM-HTML-html.md +++ b/SYSTEM-HTML-html.md @@ -1,7 +1,7 @@ SYSTEM\HTML\html =============== - +HTML Class provided by System to generate common HTML tags. @@ -21,9 +21,9 @@ Methods ### link - mixed SYSTEM\HTML\html::link($href, $rel, $type) - + string SYSTEM\HTML\html::link(string $href, string $rel, string $type) +Generate tag @@ -32,17 +32,17 @@ Methods #### Arguments -* $href **mixed** -* $rel **mixed** -* $type **mixed** +* $href **string** - <p>href attribute</p> +* $rel **string** - <p>rel attribute</p> +* $type **string** - <p>type attribute</p> ### script - mixed SYSTEM\HTML\html::script($src, $type, $rel, $language, $script) - + string SYSTEM\HTML\html::script(string $src, string $type, string $rel, string $script) +Generate