diff --git a/Admin/Install/Navigation.php b/Admin/Install/Navigation.php index 0e1fdee..6a4021e 100644 --- a/Admin/Install/Navigation.php +++ b/Admin/Install/Navigation.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help\Admin\Install - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help\Admin\Install + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -19,10 +19,10 @@ use phpOMS\DataStorage\Database\DatabasePool; /** * Navigation class. * - * @package Modules\Help\Admin\Install - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help\Admin\Install + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ class Navigation { @@ -34,7 +34,7 @@ class Navigation * * @return void * - * @since 1.0.0 + * @since 1.0.0 */ public static function install(string $path, DatabasePool $dbPool) : void { diff --git a/Admin/Install/Search.php b/Admin/Install/Search.php index a919886..d8dd173 100644 --- a/Admin/Install/Search.php +++ b/Admin/Install/Search.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help\Admin\Install - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help\Admin\Install + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -19,10 +19,10 @@ use phpOMS\DataStorage\Database\DatabasePool; /** * Search class. * - * @package Modules\Help\Admin\Install - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help\Admin\Install + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ final class Search { @@ -34,7 +34,7 @@ final class Search * * @return void * - * @since 1.0.0 + * @since 1.0.0 */ public static function install(string $path, DatabasePool $dbPool) : void { diff --git a/Admin/Installer.php b/Admin/Installer.php index 1b9f0ba..0cab6e7 100644 --- a/Admin/Installer.php +++ b/Admin/Installer.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help\Admin - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help\Admin + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -19,10 +19,10 @@ use phpOMS\Module\InstallerAbstract; /** * Installer class. * - * @package Modules\Help\Admin - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help\Admin + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ class Installer extends InstallerAbstract { diff --git a/Admin/Status.php b/Admin/Status.php index f9c44bb..6841e25 100644 --- a/Admin/Status.php +++ b/Admin/Status.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help\Admin - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help\Admin + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -19,10 +19,10 @@ use phpOMS\Module\StatusAbstract; /** * Navigation class. * - * @package Modules\Help\Admin - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help\Admin + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ class Status extends StatusAbstract { diff --git a/Admin/Uninstaller.php b/Admin/Uninstaller.php index 9fd63ea..c29e309 100644 --- a/Admin/Uninstaller.php +++ b/Admin/Uninstaller.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help\Admin - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help\Admin + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -19,10 +19,10 @@ use phpOMS\Module\UninstallerAbstract; /** * Uninstaller class. * - * @package Modules\Help\Admin - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help\Admin + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ class Uninstaller extends UninstallerAbstract { diff --git a/Admin/Updater.php b/Admin/Updater.php index 7241274..15ccc06 100644 --- a/Admin/Updater.php +++ b/Admin/Updater.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help\Admin - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help\Admin + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -19,10 +19,10 @@ use phpOMS\Module\UpdaterAbstract; /** * Updater class. * - * @package Modules\Help\Admin - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help\Admin + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ class Updater extends UpdaterAbstract { diff --git a/Controller/BackendController.php b/Controller/BackendController.php index 39b9ff5..1438c97 100644 --- a/Controller/BackendController.php +++ b/Controller/BackendController.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -23,21 +23,23 @@ use phpOMS\Views\View; /** * Help class. * - * @package Modules\Help - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ final class BackendController extends Controller { /** + * Routing end-point for application behaviour. + * * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * - * @since 1.0.0 + * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelp(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface @@ -49,13 +51,15 @@ final class BackendController extends Controller } /** + * Routing end-point for application behaviour. + * * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * - * @since 1.0.0 + * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelpGeneral(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface @@ -83,7 +87,7 @@ final class BackendController extends Controller * * @return string * - * @since 1.0.0 + * @since 1.0.0 * @codeCoverageIgnore */ private function getHelpGeneralPath(RequestAbstract $request) : string @@ -102,13 +106,15 @@ final class BackendController extends Controller } /** + * Routing end-point for application behaviour. + * * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * - * @since 1.0.0 + * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelpModuleList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface @@ -120,13 +126,15 @@ final class BackendController extends Controller } /** + * Routing end-point for application behaviour. + * * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * - * @since 1.0.0 + * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelpModule(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface @@ -160,7 +168,7 @@ final class BackendController extends Controller * * @return string * - * @since 1.0.0 + * @since 1.0.0 * @codeCoverageIgnore */ private function getHelpModulePath(RequestAbstract $request) : string @@ -179,13 +187,15 @@ final class BackendController extends Controller } /** + * Routing end-point for application behaviour. + * * @param RequestAbstract $request Request * @param ResponseAbstract $response Response * @param mixed $data Generic data * * @return RenderableInterface * - * @since 1.0.0 + * @since 1.0.0 * @codeCoverageIgnore */ public function viewHelpDeveloper(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface @@ -213,7 +223,7 @@ final class BackendController extends Controller * * @return string * - * @since 1.0.0 + * @since 1.0.0 * @codeCoverageIgnore */ private function getHelpDeveloperPath(RequestAbstract $request) : string diff --git a/Controller/Controller.php b/Controller/Controller.php index cc31878..4ba89e2 100644 --- a/Controller/Controller.php +++ b/Controller/Controller.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -20,10 +20,10 @@ use phpOMS\Module\WebInterface; /** * Help class. * - * @package Modules\Help - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ class Controller extends ModuleAbstract implements WebInterface { @@ -31,7 +31,7 @@ class Controller extends ModuleAbstract implements WebInterface /** * Module path. * - * @var string + * @var string * @since 1.0.0 */ public const MODULE_PATH = __DIR__ . '/../'; @@ -39,7 +39,7 @@ class Controller extends ModuleAbstract implements WebInterface /** * Module version. * - * @var string + * @var string * @since 1.0.0 */ public const MODULE_VERSION = '1.0.0'; @@ -47,7 +47,7 @@ class Controller extends ModuleAbstract implements WebInterface /** * Module name. * - * @var string + * @var string * @since 1.0.0 */ public const MODULE_NAME = 'Help'; @@ -55,7 +55,7 @@ class Controller extends ModuleAbstract implements WebInterface /** * Module id. * - * @var int + * @var int * @since 1.0.0 */ public const MODULE_ID = 1006800000; @@ -63,7 +63,7 @@ class Controller extends ModuleAbstract implements WebInterface /** * Providing. * - * @var string[] + * @var string[] * @since 1.0.0 */ protected static array $providing = []; @@ -71,7 +71,7 @@ class Controller extends ModuleAbstract implements WebInterface /** * Dependencies. * - * @var string[] + * @var string[] * @since 1.0.0 */ protected static array $dependencies = []; diff --git a/Controller/SearchController.php b/Controller/SearchController.php index 8f00dbc..535a225 100644 --- a/Controller/SearchController.php +++ b/Controller/SearchController.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -20,10 +20,10 @@ use phpOMS\Message\ResponseAbstract; /** * Help class. * - * @package Modules\Help - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ final class SearchController extends Controller { @@ -38,7 +38,7 @@ final class SearchController extends Controller * * @api * - * @since 1.0.0 + * @since 1.0.0 */ public function searchHelp(RequestAbstract $request, ResponseAbstract $response, $data = null) : array { diff --git a/Models/PermissionState.php b/Models/PermissionState.php index c9c2e96..f38a4b4 100644 --- a/Models/PermissionState.php +++ b/Models/PermissionState.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Help - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Help + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ declare(strict_types=1); @@ -19,10 +19,10 @@ use phpOMS\Stdlib\Base\Enum; /** * Permision state enum. * - * @package Modules\Help - * @license OMS License 1.0 - * @link https://orange-management.org - * @since 1.0.0 + * @package Modules\Help + * @license OMS License 1.0 + * @link https://orange-management.org + * @since 1.0.0 */ abstract class PermissionState extends Enum { diff --git a/Theme/Backend/Lang/Navigation.en.lang.php b/Theme/Backend/Lang/Navigation.en.lang.php index c17bd58..22bbeea 100644 --- a/Theme/Backend/Lang/Navigation.en.lang.php +++ b/Theme/Backend/Lang/Navigation.en.lang.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package TBD - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package TBD + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ return ['Navigation' => [ 'Help' => 'Help', diff --git a/Theme/Backend/Lang/en.lang.php b/Theme/Backend/Lang/en.lang.php index 5bb6fb3..1d6839b 100644 --- a/Theme/Backend/Lang/en.lang.php +++ b/Theme/Backend/Lang/en.lang.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package TBD - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package TBD + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ return ['Help' => [ 'Modules' => 'Modules', diff --git a/Theme/Backend/help-module-list.tpl.php b/Theme/Backend/help-module-list.tpl.php index c427714..77c3326 100644 --- a/Theme/Backend/help-module-list.tpl.php +++ b/Theme/Backend/help-module-list.tpl.php @@ -4,11 +4,11 @@ * * PHP Version 7.4 * - * @package Modules\Admin\Template\Backend - * @copyright Dennis Eichhorn - * @license OMS License 1.0 - * @version 1.0.0 - * @link https://orange-management.org + * @package Modules\Admin\Template\Backend + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @link https://orange-management.org */ /**