diff --git a/api/api_default.php b/api/api_default.php index 43d28d7..9809e0a 100644 --- a/api/api_default.php +++ b/api/api_default.php @@ -98,6 +98,7 @@ abstract class api_default extends api_system { /** * API Default Page function - implement this function and return the Default Page * + * @param string $_escaped_fragment_ Fragment from Hashbang Crawling * @return string Returns your API-Default-State */ public abstract static function default_page($_escaped_fragment_ = null); diff --git a/db/result/ResultAMQP.php b/db/result/ResultAMQP.php index d0f8157..a74abd2 100644 --- a/db/result/ResultAMQP.php +++ b/db/result/ResultAMQP.php @@ -22,6 +22,8 @@ class ResultAMQP extends \SYSTEM\DB\Result{ // < maybe not ? check if amqpchanne /** * Construct the Resultset with a database ressource + * + * @param ressource $res Ressource of the Database Result-Set */ public function __construct($res){ $this->res = $res;} diff --git a/db/result/ResultMysqli.php b/db/result/ResultMysqli.php index 3af222f..258cd03 100644 --- a/db/result/ResultMysqli.php +++ b/db/result/ResultMysqli.php @@ -22,6 +22,8 @@ class ResultMysqli extends \SYSTEM\DB\Result{ /** * Construct the Resultset with a database ressource + * + * @param ressource $res Ressource of the Database Result-Set */ public function __construct($res){ $this->res = $res;} diff --git a/db/result/ResultMysqliPrepare.php b/db/result/ResultMysqliPrepare.php index 6464751..86cdb07 100644 --- a/db/result/ResultMysqliPrepare.php +++ b/db/result/ResultMysqliPrepare.php @@ -26,6 +26,9 @@ class ResultMysqliPrepare extends \SYSTEM\DB\Result{ /** * Construct the Resultset with a database ressource + * + * @param ressource $res Ressource of the Database Result-Set + * @param ressource $connection Connection on which the Result-Set was returned */ public function __construct($res,$connection){ $this->res = $res; diff --git a/db/result/ResultPostgres.php b/db/result/ResultPostgres.php index d7c8822..d91e7a6 100644 --- a/db/result/ResultPostgres.php +++ b/db/result/ResultPostgres.php @@ -24,6 +24,9 @@ class ResultPostgres extends \SYSTEM\DB\Result{ /** * Construct the Resultset with a database ressource + * + * @param ressource $res Ressource of the Database Result-Set + * @param ressource $connection Connection on which the Result-Set was returned */ public function __construct($res,$connection){ $this->res = $res; diff --git a/db/result/ResultSQLite.php b/db/result/ResultSQLite.php index 5bde8bb..24c5b64 100644 --- a/db/result/ResultSQLite.php +++ b/db/result/ResultSQLite.php @@ -24,6 +24,9 @@ class ResultSQLite extends \SYSTEM\DB\Result{ /** * Construct the Resultset with a database ressource + * + * @param ressource $res Ressource of the Database Result-Set + * @param string $stmt Query Statement which produced the result set */ public function __construct($res,$stmt){ $this->res = $res; diff --git a/lib/system/lib_system.php b/lib/system/lib_system.php index 1a0fa2f..d7804c3 100644 --- a/lib/system/lib_system.php +++ b/lib/system/lib_system.php @@ -1,12 +1,49 @@ ${sai_menu_api}';} + /** + * Generate
  • Menu for the Saimod + * + * @return string Returns
  • Menu for the Saimod + */ public static function html_li_menu(){return '
  • ';} - public static function right_public(){return false;} + + /** + * Returns if the Saimod is public(access for everyone) + * + * @return boolean Returns if the Saimod is public(true) or not(false) + */ + public static function right_public(){return false;} + + /** + * Returns if the requesting user has the required rights to access the Saimod + * + * @return boolean Returns true if the user can access + */ public static function right_right(){return \SYSTEM\SECURITY\security::check(\SYSTEM\SECURITY\RIGHTS::SYS_SAI) && \SYSTEM\SECURITY\security::check(\SYSTEM\SECURITY\RIGHTS::SYS_SAI_API);} + /** + * Get all css System Paths required for this Saimod + * + * @return array Returns array of Pathobjects pointing to the saimods css + */ public static function css(){ return array(new \SYSTEM\PSAI('modules/saimod_sys_api/css/saimod_sys_api.css'));} + + /** + * Get all js System Paths required for this Saimod + * + * @return array Returns array of Pathobjects pointing to the saimods js + */ public static function js(){ return array(new \SYSTEM\PSAI('modules/saimod_sys_api/js/saimod_sys_api.js'));} } \ No newline at end of file diff --git a/sai/modules/saimod_sys_cache/saimod_sys_cache.php b/sai/modules/saimod_sys_cache/saimod_sys_cache.php index 04363a2..a6576a9 100644 --- a/sai/modules/saimod_sys_cache/saimod_sys_cache.php +++ b/sai/modules/saimod_sys_cache/saimod_sys_cache.php @@ -10,7 +10,16 @@ * @package SYSTEM\SAI */ namespace SYSTEM\SAI; -class saimod_sys_cache extends \SYSTEM\SAI\SaiModule { + +/** + * saimod_sys_cache Class provided by System as saimod to manage the system_cache table + */ +class saimod_sys_cache extends \SYSTEM\SAI\SaiModule { + /** + * Generate the HTML for the Saimods startpage + * + * @return string Returns HTML for the Saimods startpage + */ public static function sai_mod__SYSTEM_SAI_saimod_sys_cache(){ $vars = array(); $vars['count'] = \SYSTEM\SQL\SYS_SAIMOD_CACHE_COUNT::Q1()['count']; @@ -31,11 +40,32 @@ class saimod_sys_cache extends \SYSTEM\SAI\SaiModule { return 'info';} return 'success';} + /** + * Generate
  • Menu for the Saimod + * + * @return string Returns
  • Menu for the Saimod + */ public static function html_li_menu(){return '
  • ';} - public static function right_public(){return false;} + + /** + * Returns if the Saimod is public(access for everyone) + * + * @return boolean Returns if the Saimod is public(true) or not(false) + */ + public static function right_public(){return false;} + + /** + * Returns if the requesting user has the required rights to access the Saimod + * + * @return boolean Returns true if the user can access + */ public static function right_right(){return \SYSTEM\SECURITY\security::check(\SYSTEM\SECURITY\RIGHTS::SYS_SAI);} - //public static function css(){} + /** + * Get all js System Paths required for this Saimod + * + * @return array Returns array of Pathobjects pointing to the saimods js + */ public static function js(){ return array(new \SYSTEM\PSAI('modules/saimod_sys_cache/js/saimod_sys_cache.js'));} } \ No newline at end of file diff --git a/sai/modules/saimod_sys_config/saimod_sys_config.php b/sai/modules/saimod_sys_config/saimod_sys_config.php index c3a05e8..64a51f6 100644 --- a/sai/modules/saimod_sys_config/saimod_sys_config.php +++ b/sai/modules/saimod_sys_config/saimod_sys_config.php @@ -10,7 +10,16 @@ * @package SYSTEM\SAI */ namespace SYSTEM\SAI; -class saimod_sys_config extends \SYSTEM\SAI\SaiModule { + +/** + * saimod_sys_config Class provided by System as saimod to display the config + */ +class saimod_sys_config extends \SYSTEM\SAI\SaiModule { + /** + * Generate the HTML for the Saimods startpage + * + * @return string Returns HTML for the Saimods startpage + */ public static function sai_mod__SYSTEM_SAI_saimod_sys_config(){ $vars = \SYSTEM\PAGE\text::tag(\SYSTEM\SQL\system_text::TAG_SAI_CONFIG); $vars['basics'] = $vars['database'] = $vars['sai'] = ''; @@ -149,10 +158,33 @@ class saimod_sys_config extends \SYSTEM\SAI\SaiModule { return \SYSTEM\PAGE\replace::replaceFile((new \SYSTEM\PSAI('modules/saimod_sys_config/tpl/config_database.tpl'))->SERVERPATH(),$vars); } + + /** + * Generate
  • Menu for the Saimod + * + * @return string Returns
  • Menu for the Saimod + */ public static function html_li_menu(){return '
  • ';} + + /** + * Returns if the Saimod is public(access for everyone) + * + * @return boolean Returns if the Saimod is public(true) or not(false) + */ public static function right_public(){return false;} + + /** + * Returns if the requesting user has the required rights to access the Saimod + * + * @return boolean Returns true if the user can access + */ public static function right_right(){return \SYSTEM\SECURITY\security::check(\SYSTEM\SECURITY\RIGHTS::SYS_SAI);} + + /** + * Get all js System Paths required for this Saimod + * + * @return array Returns array of Pathobjects pointing to the saimods js + */ public static function js(){ return array(new \SYSTEM\PSAI('modules/saimod_sys_config/js/saimod_sys_config.js'));} - //public static function css(){} } \ No newline at end of file diff --git a/sai/modules/saimod_sys_cron/saimod_sys_cron.php b/sai/modules/saimod_sys_cron/saimod_sys_cron.php index 3dc65da..6a5ef3c 100644 --- a/sai/modules/saimod_sys_cron/saimod_sys_cron.php +++ b/sai/modules/saimod_sys_cron/saimod_sys_cron.php @@ -11,7 +11,15 @@ */ namespace SYSTEM\SAI; -class saimod_sys_cron extends \SYSTEM\SAI\SaiModule { +/** + * saimod_sys_cron Class provided by System as saimod to manage the system_cron table + */ +class saimod_sys_cron extends \SYSTEM\SAI\SaiModule { + /** + * Generate the HTML for the Saimods startpage + * + * @return string Returns HTML for the Saimods startpage + */ public static function sai_mod__SYSTEM_SAI_saimod_sys_cron(){ $vars['content'] = ''; $vars['last_visit'] = \SYSTEM\time::time_ago_string(strtotime(\SYSTEM\CRON\cron::last_visit())); @@ -50,13 +58,40 @@ class saimod_sys_cron extends \SYSTEM\SAI\SaiModule { \SYSTEM\SQL\SYS_SAIMOD_CRON_DEL::QI(array($cls)); return \SYSTEM\LOG\JsonResult::ok();} - //public static function html_li_menu(){return '
  • ${sai_menu_cron}
  • ';} + /** + * Generate
  • Menu for the Saimod + * + * @return string Returns
  • Menu for the Saimod + */ public static function html_li_menu(){return '
  • ';} - public static function right_public(){return false;} + + /** + * Returns if the Saimod is public(access for everyone) + * + * @return boolean Returns if the Saimod is public(true) or not(false) + */ + public static function right_public(){return false;} + + /** + * Returns if the requesting user has the required rights to access the Saimod + * + * @return boolean Returns true if the user can access + */ public static function right_right(){return \SYSTEM\SECURITY\security::check(\SYSTEM\SECURITY\RIGHTS::SYS_SAI_CRON);} + /** + * Get all css System Paths required for this Saimod + * + * @return array Returns array of Pathobjects pointing to the saimods css + */ public static function css(){ return array(new \SYSTEM\PSAI('modules/saimod_sys_cron/css/saimod_sys_cron.css'));} + + /** + * Get all js System Paths required for this Saimod + * + * @return array Returns array of Pathobjects pointing to the saimods js + */ public static function js(){ return array(new \SYSTEM\PSAI('modules/saimod_sys_cron/js/saimod_sys_cron.js'));} } \ No newline at end of file diff --git a/sai/modules/saimod_sys_docu/saimod_sys_docu.php b/sai/modules/saimod_sys_docu/saimod_sys_docu.php index 614544e..40dd19b 100644 --- a/sai/modules/saimod_sys_docu/saimod_sys_docu.php +++ b/sai/modules/saimod_sys_docu/saimod_sys_docu.php @@ -10,7 +10,16 @@ * @package SYSTEM\SAI */ namespace SYSTEM\SAI; -class saimod_sys_docu extends \SYSTEM\SAI\SaiModule { + +/** + * saimod_sys_docu Class provided by System as saimod to display the code documentation + */ +class saimod_sys_docu extends \SYSTEM\SAI\SaiModule { + /** + * Generate the HTML for the Saimods startpage + * + * @return string Returns HTML for the Saimods startpage + */ public static function sai_mod__SYSTEM_SAI_saimod_sys_docu(){ $phpdocconfigs = \SYSTEM\DOCU\docu::getAll(); $vars = \SYSTEM\PAGE\text::tag(\SYSTEM\SQL\system_text::TAG_SAI_DOCU); @@ -46,12 +55,32 @@ class saimod_sys_docu extends \SYSTEM\SAI\SaiModule { return \SYSTEM\PAGE\replace::replaceFile((new \SYSTEM\PSAI('modules/saimod_sys_docu/tpl/saimod_sys_docu_iframe.tpl'))->SERVERPATH(), $vars); } - //public static function html_li_menu(){return '
  • ${sai_menu_docu}
  • ';} + /** + * Generate
  • Menu for the Saimod + * + * @return string Returns
  • Menu for the Saimod + */ public static function html_li_menu(){return '
  • ';} - public static function right_public(){return false;} + + /** + * Returns if the Saimod is public(access for everyone) + * + * @return boolean Returns if the Saimod is public(true) or not(false) + */ + public static function right_public(){return false;} + + /** + * Returns if the requesting user has the required rights to access the Saimod + * + * @return boolean Returns true if the user can access + */ public static function right_right(){return \SYSTEM\SECURITY\security::check(\SYSTEM\SECURITY\RIGHTS::SYS_SAI);} - //public static function css(){} + /** + * Get all js System Paths required for this Saimod + * + * @return array Returns array of Pathobjects pointing to the saimods js + */ public static function js(){ return array(new \SYSTEM\PSAI('modules/saimod_sys_docu/js/saimod_sys_docu.js'));} } \ No newline at end of file diff --git a/sai/modules/saimod_sys_files/saimod_sys_files.php b/sai/modules/saimod_sys_files/saimod_sys_files.php index f015785..f82c89f 100644 --- a/sai/modules/saimod_sys_files/saimod_sys_files.php +++ b/sai/modules/saimod_sys_files/saimod_sys_files.php @@ -11,6 +11,9 @@ */ namespace SYSTEM\SAI; +/** + * saimod_sys_files Class provided by System as saimod to manage files (files feature) + */ class saimod_sys_files extends \SYSTEM\SAI\SaiModule { public static function sai_mod__SYSTEM_SAI_saimod_sys_files_action_del($cat,$id){ if(!\SYSTEM\FILES\files::delete($cat, $id)){ @@ -32,6 +35,12 @@ class saimod_sys_files extends \SYSTEM\SAI\SaiModule { return \SYSTEM\LOG\JsonResult::ok(); } + + /** + * Generate the HTML for the Saimods startpage + * + * @return string Returns HTML for the Saimods startpage + */ public static function sai_mod__SYSTEM_SAI_saimod_sys_files(){ $vars['tabopts'] = ''; @@ -53,12 +62,32 @@ class saimod_sys_files extends \SYSTEM\SAI\SaiModule { $vars = array_merge($vars, \SYSTEM\PAGE\text::tag(\SYSTEM\SQL\system_text::TAG_SAI_FILES)); return \SYSTEM\PAGE\replace::replaceFile((new \SYSTEM\PSAI('modules/saimod_sys_files/tpl/saimod_sys_files_list.tpl'))->SERVERPATH(), $vars);} - //public static function html_li_menu(){return '
  • ${sai_menu_files}
  • ';} + /** + * Generate
  • Menu for the Saimod + * + * @return string Returns
  • Menu for the Saimod + */ public static function html_li_menu(){return '
  • ';} - public static function right_public(){return false;} + + /** + * Returns if the Saimod is public(access for everyone) + * + * @return boolean Returns if the Saimod is public(true) or not(false) + */ + public static function right_public(){return false;} + + /** + * Returns if the requesting user has the required rights to access the Saimod + * + * @return boolean Returns true if the user can access + */ public static function right_right(){return \SYSTEM\SECURITY\security::check(\SYSTEM\SECURITY\RIGHTS::SYS_SAI) && \SYSTEM\SECURITY\security::check(\SYSTEM\SECURITY\RIGHTS::SYS_SAI_FILES);} - //public static function css(){} + /** + * Get all js System Paths required for this Saimod + * + * @return array Returns array of Pathobjects pointing to the saimods js + */ public static function js(){ return array(new \SYSTEM\PSAI('modules/saimod_sys_files/js/saimod_sys_files.js'));} } \ No newline at end of file diff --git a/sai/modules/saimod_sys_git/saimod_sys_git.php b/sai/modules/saimod_sys_git/saimod_sys_git.php index a066a50..13d2d78 100644 --- a/sai/modules/saimod_sys_git/saimod_sys_git.php +++ b/sai/modules/saimod_sys_git/saimod_sys_git.php @@ -11,7 +11,15 @@ */ namespace SYSTEM\SAI; -class saimod_sys_git extends \SYSTEM\SAI\SaiModule { +/** + * saimod_sys_git Class provided by System as saimod to display git information on the project and system + */ +class saimod_sys_git extends \SYSTEM\SAI\SaiModule { + /** + * Generate the HTML for the Saimods startpage + * + * @return string Returns HTML for the Saimods startpage + */ public static function sai_mod__SYSTEM_SAI_saimod_sys_git(){ $vars = \SYSTEM\PAGE\text::tag(\SYSTEM\SQL\system_text::TAG_SAI_GIT); $vars = array_merge($vars,self::getGitInfo()); @@ -48,11 +56,24 @@ class saimod_sys_git extends \SYSTEM\SAI\SaiModule { return 'success'; } - //public static function html_li_menu(){return '
  • ${sai_menu_git}
  • ';} + /** + * Generate
  • Menu for the Saimod + * + * @return string Returns
  • Menu for the Saimod + */ public static function html_li_menu(){return '