Jingga/oms-Help
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-Help.git synced 2026-02-13 11:38:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix phpcs findings

Browse Source
This commit is contained in:
Dennis Eichhorn 2019-09-12 19:48:00 +02:00
parent 561e95f5bc
commit c4d635f479
13 changed files with 132 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Admin/Install/Navigation.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help\Admin\Install * @package Modules\Help\Admin\Install
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -19,10 +19,10 @@ use phpOMS\DataStorage\Database\DatabasePool;
/** /**
* Navigation class. * Navigation class.
* *
* @package Modules\Help\Admin\Install * @package Modules\Help\Admin\Install
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
class Navigation class Navigation
{ {
@ -34,7 +34,7 @@ class Navigation
* *
* @return void * @return void
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public static function install(string $path, DatabasePool $dbPool) : void public static function install(string $path, DatabasePool $dbPool) : void
{ {

20
Admin/Install/Search.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help\Admin\Install * @package Modules\Help\Admin\Install
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -19,10 +19,10 @@ use phpOMS\DataStorage\Database\DatabasePool;
/** /**
* Search class. * Search class.
* *
* @package Modules\Help\Admin\Install * @package Modules\Help\Admin\Install
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
final class Search final class Search
{ {
@ -34,7 +34,7 @@ final class Search
* *
* @return void * @return void
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public static function install(string $path, DatabasePool $dbPool) : void public static function install(string $path, DatabasePool $dbPool) : void
{ {

18
Admin/Installer.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help\Admin * @package Modules\Help\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -19,10 +19,10 @@ use phpOMS\Module\InstallerAbstract;
/** /**
* Installer class. * Installer class.
* *
* @package Modules\Help\Admin * @package Modules\Help\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
class Installer extends InstallerAbstract class Installer extends InstallerAbstract
{ {

18
Admin/Status.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help\Admin * @package Modules\Help\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -19,10 +19,10 @@ use phpOMS\Module\StatusAbstract;
/** /**
* Navigation class. * Navigation class.
* *
* @package Modules\Help\Admin * @package Modules\Help\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
class Status extends StatusAbstract class Status extends StatusAbstract
{ {

18
Admin/Uninstaller.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help\Admin * @package Modules\Help\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -19,10 +19,10 @@ use phpOMS\Module\UninstallerAbstract;
/** /**
* Uninstaller class. * Uninstaller class.
* *
* @package Modules\Help\Admin * @package Modules\Help\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
class Uninstaller extends UninstallerAbstract class Uninstaller extends UninstallerAbstract
{ {

18
Admin/Updater.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help\Admin * @package Modules\Help\Admin
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -19,10 +19,10 @@ use phpOMS\Module\UpdaterAbstract;
/** /**
* Updater class. * Updater class.
* *
* @package Modules\Help\Admin * @package Modules\Help\Admin
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
class Updater extends UpdaterAbstract class Updater extends UpdaterAbstract
{ {

44
Controller/BackendController.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help * @package Modules\Help
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -23,21 +23,23 @@ use phpOMS\Views\View;
/** /**
* Help class. * Help class.
* *
* @package Modules\Help * @package Modules\Help
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
final class BackendController extends Controller final class BackendController extends Controller
{ {
/** /**
* Routing end-point for application behaviour.
*
* @param RequestAbstract $request Request * @param RequestAbstract $request Request
* @param ResponseAbstract $response Response * @param ResponseAbstract $response Response
* @param mixed $data Generic data * @param mixed $data Generic data
* *
* @return RenderableInterface * @return RenderableInterface
* *
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewHelp(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface 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 RequestAbstract $request Request
* @param ResponseAbstract $response Response * @param ResponseAbstract $response Response
* @param mixed $data Generic data * @param mixed $data Generic data
* *
* @return RenderableInterface * @return RenderableInterface
* *
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewHelpGeneral(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewHelpGeneral(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
@ -83,7 +87,7 @@ final class BackendController extends Controller
* *
* @return string * @return string
* *
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
private function getHelpGeneralPath(RequestAbstract $request) : string 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 RequestAbstract $request Request
* @param ResponseAbstract $response Response * @param ResponseAbstract $response Response
* @param mixed $data Generic data * @param mixed $data Generic data
* *
* @return RenderableInterface * @return RenderableInterface
* *
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewHelpModuleList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface 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 RequestAbstract $request Request
* @param ResponseAbstract $response Response * @param ResponseAbstract $response Response
* @param mixed $data Generic data * @param mixed $data Generic data
* *
* @return RenderableInterface * @return RenderableInterface
* *
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewHelpModule(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewHelpModule(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
@ -160,7 +168,7 @@ final class BackendController extends Controller
* *
* @return string * @return string
* *
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
private function getHelpModulePath(RequestAbstract $request) : string 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 RequestAbstract $request Request
* @param ResponseAbstract $response Response * @param ResponseAbstract $response Response
* @param mixed $data Generic data * @param mixed $data Generic data
* *
* @return RenderableInterface * @return RenderableInterface
* *
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewHelpDeveloper(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewHelpDeveloper(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
@ -213,7 +223,7 @@ final class BackendController extends Controller
* *
* @return string * @return string
* *
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
private function getHelpDeveloperPath(RequestAbstract $request) : string private function getHelpDeveloperPath(RequestAbstract $request) : string

30
Controller/Controller.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help * @package Modules\Help
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -20,10 +20,10 @@ use phpOMS\Module\WebInterface;
/** /**
* Help class. * Help class.
* *
* @package Modules\Help * @package Modules\Help
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
class Controller extends ModuleAbstract implements WebInterface class Controller extends ModuleAbstract implements WebInterface
{ {
@ -31,7 +31,7 @@ class Controller extends ModuleAbstract implements WebInterface
/** /**
* Module path. * Module path.
* *
* @var string * @var string
* @since 1.0.0 * @since 1.0.0
*/ */
public const MODULE_PATH = __DIR__ . '/../'; public const MODULE_PATH = __DIR__ . '/../';
@ -39,7 +39,7 @@ class Controller extends ModuleAbstract implements WebInterface
/** /**
* Module version. * Module version.
* *
* @var string * @var string
* @since 1.0.0 * @since 1.0.0
*/ */
public const MODULE_VERSION = '1.0.0'; public const MODULE_VERSION = '1.0.0';
@ -47,7 +47,7 @@ class Controller extends ModuleAbstract implements WebInterface
/** /**
* Module name. * Module name.
* *
* @var string * @var string
* @since 1.0.0 * @since 1.0.0
*/ */
public const MODULE_NAME = 'Help'; public const MODULE_NAME = 'Help';
@ -55,7 +55,7 @@ class Controller extends ModuleAbstract implements WebInterface
/** /**
* Module id. * Module id.
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public const MODULE_ID = 1006800000; public const MODULE_ID = 1006800000;
@ -63,7 +63,7 @@ class Controller extends ModuleAbstract implements WebInterface
/** /**
* Providing. * Providing.
* *
* @var string[] * @var string[]
* @since 1.0.0 * @since 1.0.0
*/ */
protected static array $providing = []; protected static array $providing = [];
@ -71,7 +71,7 @@ class Controller extends ModuleAbstract implements WebInterface
/** /**
* Dependencies. * Dependencies.
* *
* @var string[] * @var string[]
* @since 1.0.0 * @since 1.0.0
*/ */
protected static array $dependencies = []; protected static array $dependencies = [];

20
Controller/SearchController.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help * @package Modules\Help
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -20,10 +20,10 @@ use phpOMS\Message\ResponseAbstract;
/** /**
* Help class. * Help class.
* *
* @package Modules\Help * @package Modules\Help
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
final class SearchController extends Controller final class SearchController extends Controller
{ {
@ -38,7 +38,7 @@ final class SearchController extends Controller
* *
* @api * @api
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function searchHelp(RequestAbstract $request, ResponseAbstract $response, $data = null) : array public function searchHelp(RequestAbstract $request, ResponseAbstract $response, $data = null) : array
{ {

18
Models/PermissionState.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Help * @package Modules\Help
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
declare(strict_types=1); declare(strict_types=1);
@ -19,10 +19,10 @@ use phpOMS\Stdlib\Base\Enum;
/** /**
* Permision state enum. * Permision state enum.
* *
* @package Modules\Help * @package Modules\Help
* @license OMS License 1.0 * @license OMS License 1.0
* @link https://orange-management.org * @link https://orange-management.org
* @since 1.0.0 * @since 1.0.0
*/ */
abstract class PermissionState extends Enum abstract class PermissionState extends Enum
{ {

10
Theme/Backend/Lang/Navigation.en.lang.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package TBD * @package TBD
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
return ['Navigation' => [ return ['Navigation' => [
'Help' => 'Help', 'Help' => 'Help',

10
Theme/Backend/Lang/en.lang.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package TBD * @package TBD
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
return ['Help' => [ return ['Help' => [
'Modules' => 'Modules', 'Modules' => 'Modules',

10
Theme/Backend/help-module-list.tpl.php
View File

@ -4,11 +4,11 @@
* *
* PHP Version 7.4 * PHP Version 7.4
* *
* @package Modules\Admin\Template\Backend * @package Modules\Admin\Template\Backend
* @copyright Dennis Eichhorn * @copyright Dennis Eichhorn
* @license OMS License 1.0 * @license OMS License 1.0
* @version 1.0.0 * @version 1.0.0
* @link https://orange-management.org * @link https://orange-management.org
*/ */
/** /**