commit 89de6d98ff67e92fb43459fc345739a79791baa6 Author: Dennis Eichhorn Date: Tue Nov 14 16:12:50 2017 +0100 Scrab exp. smoothing. wrong diff --git a/Admin/Activate.php b/Admin/Activate.php new file mode 100644 index 0000000..636b444 --- /dev/null +++ b/Admin/Activate.php @@ -0,0 +1,40 @@ + [ + [ + 'dest' => '\Modules\Help\Controller:viewHelpGeneral', + 'verb' => RouteVerb::GET, + ], + ], + '^.*/backend/help/module/list(\?.*)?$' => [ + [ + 'dest' => '\Modules\Help\Controller:viewHelpModuleList', + 'verb' => RouteVerb::GET, + ], + ], + '^.*/backend/help/module/single(\?.*)?$' => [ + [ + 'dest' => '\Modules\Help\Controller:viewHelpModule', + 'verb' => RouteVerb::GET, + ], + ], + '^.*/backend/help/developer(\?.*)?$' => [ + [ + 'dest' => '\Modules\Help\Controller:viewHelpDeveloper', + 'verb' => RouteVerb::GET, + ], + ], +]; diff --git a/Admin/Routes/console.php b/Admin/Routes/console.php new file mode 100644 index 0000000..1ecbfac --- /dev/null +++ b/Admin/Routes/console.php @@ -0,0 +1,3 @@ +app, $request, $response); + $view->setTemplate('/Modules/Help/Theme/Backend/help'); + + return $view; + } + + /** + * @param RequestAbstract $request Request + * @param ResponseAbstract $response Response + * @param mixed $data Generic data + * + * @return \Serializable + * + * @since 1.0.0 + * @codeCoverageIgnore + */ + public function viewHelpGeneral(RequestAbstract $request, ResponseAbstract $response, $data = null) : \Serializable + { + $view = new View($this->app, $request, $response); + $view->setTemplate('/Modules/Help/Theme/Backend/help-general'); + + $view->setData('markdown', Markdown::parse(file_get_contents(__DIR__ . '/../../Documentation/README.md'))); + + return $view; + } + + /** + * @param RequestAbstract $request Request + * @param ResponseAbstract $response Response + * @param mixed $data Generic data + * + * @return \Serializable + * + * @since 1.0.0 + * @codeCoverageIgnore + */ + public function viewHelpModuleList(RequestAbstract $request, ResponseAbstract $response, $data = null) : \Serializable + { + $view = new View($this->app, $request, $response); + $view->setTemplate('/Modules/Help/Theme/Backend/help-module-list'); + + return $view; + } + + /** + * @param RequestAbstract $request Request + * @param ResponseAbstract $response Response + * @param mixed $data Generic data + * + * @return \Serializable + * + * @since 1.0.0 + * @codeCoverageIgnore + */ + public function viewHelpModule(RequestAbstract $request, ResponseAbstract $response, $data = null) : \Serializable + { + $view = new View($this->app, $request, $response); + $view->setTemplate('/Modules/Help/Theme/Backend/help-module'); + + return $view; + } + + /** + * @param RequestAbstract $request Request + * @param ResponseAbstract $response Response + * @param mixed $data Generic data + * + * @return \Serializable + * + * @since 1.0.0 + * @codeCoverageIgnore + */ + public function viewHelpDeveloper(RequestAbstract $request, ResponseAbstract $response, $data = null) : \Serializable + { + $view = new View($this->app, $request, $response); + $view->setTemplate('/Modules/Help/Theme/Backend/help-developer'); + + $view->setData('markdown', Markdown::parse(file_get_contents(__DIR__ . '/../../Developer-Guide/README.md'))); + + return $view; + } +} diff --git a/Docs/introduction.md b/Docs/introduction.md new file mode 100644 index 0000000..46fca38 --- /dev/null +++ b/Docs/introduction.md @@ -0,0 +1,21 @@ +# Introduction + +The **Dashboard** module is one of the essential core modules that is always required. This module is responsible for providing a personalizable dashboard after login. + +## Target Group + +The target group for this module is everyone. + +# Setup + +The module can be installed through the integrated module downloader and installer or by uploading the module into the `Modules/` directory and executing the installation through the module installer. + +# Features + +## Customizability + +The dashboard can be custamized by every user according to his/her needs. It's also possible to define default dashboards for different user groups which can be used by users. This allows the administrator to provide default dashboards which then can be used without manually creating a dashboard. + +## Extendability + +All modules can provide one or multiple dashboard components which can be integrated in the dashboard. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f4510d --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# Backend Dashboard # diff --git a/Theme/Backend/Lang/Navigation.en.lang.php b/Theme/Backend/Lang/Navigation.en.lang.php new file mode 100644 index 0000000..74ced0a --- /dev/null +++ b/Theme/Backend/Lang/Navigation.en.lang.php @@ -0,0 +1,19 @@ + [ + 'Help' => 'Help', + 'General' => 'General', + 'Modules' => 'Modules', + 'Developer' => 'Developer', +]]; diff --git a/Theme/Backend/help-developer.tpl.php b/Theme/Backend/help-developer.tpl.php new file mode 100644 index 0000000..a185baa --- /dev/null +++ b/Theme/Backend/help-developer.tpl.php @@ -0,0 +1 @@ +getData('markdown'); ?> \ No newline at end of file diff --git a/Theme/Backend/help-general.tpl.php b/Theme/Backend/help-general.tpl.php new file mode 100644 index 0000000..a185baa --- /dev/null +++ b/Theme/Backend/help-general.tpl.php @@ -0,0 +1 @@ +getData('markdown'); ?> \ No newline at end of file diff --git a/Theme/Backend/help-module-list.tpl.php b/Theme/Backend/help-module-list.tpl.php new file mode 100644 index 0000000..e69de29 diff --git a/Theme/Backend/help-module.tpl.php b/Theme/Backend/help-module.tpl.php new file mode 100644 index 0000000..e69de29 diff --git a/Theme/Backend/help.tpl.php b/Theme/Backend/help.tpl.php new file mode 100644 index 0000000..e69de29 diff --git a/img/module_teaser_small.png b/img/module_teaser_small.png new file mode 100644 index 0000000..9147e4f Binary files /dev/null and b/img/module_teaser_small.png differ diff --git a/info.json b/info.json new file mode 100644 index 0000000..3500d0c --- /dev/null +++ b/info.json @@ -0,0 +1,45 @@ +{ + "name": { + "id": 1007800000, + "internal": "Help", + "external": "Backend Help" + }, + "category": "General", + "version": "1.0.0", + "requirements": { + "phpOMS": "1.0.0", + "phpOMS-db": "1.0.0" + }, + "creator": { + "name": "Orange Management", + "website": "www.spl1nes.com" + }, + "description": "The backend help module.", + "directory": "Help", + "dependencies": { + "Admin" : "1.0.0" + }, + "providing": { + "Navigation": "*" + }, + "load": [ + { + "pid": [ + "/backend/help" + ], + "type": 4, + "for": "Content", + "from": "Help", + "file": "Help" + }, + { + "pid": [ + "/backend" + ], + "type": 5, + "from": "Help", + "for": "Navigation", + "file": "Navigation" + } + ] +}