From d0e57d163b3d6084559317b0e9446ec61dc869ce Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Thu, 21 Apr 2022 23:52:00 +0200 Subject: [PATCH] doc fixes --- .../QA/Controller/AppController.php | 12 ++++++------ CONTRIBUTING.md | 2 +- Controller/ApiController.php | 18 +++++++++--------- Controller/BackendController.php | 18 ++++++++++++------ Models/QAAnswerMapper.php | 2 +- Models/QAAnswerVoteMapper.php | 2 +- Models/QAHelperMapper.php | 4 ++-- Models/QAQuestionMapper.php | 2 +- Models/QAQuestionVoteMapper.php | 2 +- 9 files changed, 34 insertions(+), 28 deletions(-) diff --git a/Admin/Install/Application/QA/Controller/AppController.php b/Admin/Install/Application/QA/Controller/AppController.php index bb7081f..c7734e8 100755 --- a/Admin/Install/Application/QA/Controller/AppController.php +++ b/Admin/Install/Application/QA/Controller/AppController.php @@ -58,7 +58,7 @@ final class AppController extends ModuleAbstract * @since 1.0.0 * @codeCoverageIgnore */ - public function viewList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Web/{APPNAME}/tpl/list'); @@ -78,7 +78,7 @@ final class AppController extends ModuleAbstract * @since 1.0.0 * @codeCoverageIgnore */ - public function viewQuestion(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewQuestion(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Web/{APPNAME}/tpl/question'); @@ -98,7 +98,7 @@ final class AppController extends ModuleAbstract * @since 1.0.0 * @codeCoverageIgnore */ - public function viewProfile(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewProfile(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Web/{APPNAME}/tpl/profile'); @@ -118,7 +118,7 @@ final class AppController extends ModuleAbstract * @since 1.0.0 * @codeCoverageIgnore */ - public function viewImprint(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewImprint(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Web/{APPNAME}/tpl/imprint'); @@ -138,7 +138,7 @@ final class AppController extends ModuleAbstract * @since 1.0.0 * @codeCoverageIgnore */ - public function viewTerms(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewTerms(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Web/{APPNAME}/tpl/terms'); @@ -158,7 +158,7 @@ final class AppController extends ModuleAbstract * @since 1.0.0 * @codeCoverageIgnore */ - public function viewDataPrivacy(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewDataPrivacy(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Web/{APPNAME}/tpl/privacy'); diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9b4371..4bbb819 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ Generally, the development philosophy is result orientated. This means that anyo Developers are encouraged to pick open tasks with high priorities according to their own skill level. Senior developers may directly assign tasks to developers based on their importance. New developers may find it easier to start with a task that has a low priority as they often also have a lower difficulty. -Open tasks can be found in the project overview: [PROJECT.md](../Project/PROJECT.md) +Open tasks can be found in the project overview: [PROJECT.md](https://github.com/Karaka-Management/Organization-Guide/blob/master/Project/PROJECT.md) Tasks currently in development are prefixed in the priority column with an asterisk `*` and a name tag in the task description of the developer who is working on the task. diff --git a/Controller/ApiController.php b/Controller/ApiController.php index 2fca963..1791a24 100755 --- a/Controller/ApiController.php +++ b/Controller/ApiController.php @@ -65,7 +65,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiQuestionUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiQuestionUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { } @@ -82,7 +82,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiQAAppUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiQAAppUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { } @@ -99,7 +99,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiAnswerUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiAnswerUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { } @@ -116,7 +116,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiQAQuestionCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiQAQuestionCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateQAQuestionCreate($request))) { $response->set('qa_question_create', new FormValidation($val)); @@ -232,7 +232,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiQAAnswerCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiQAAnswerCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateQAAnswerCreate($request))) { $response->set('qa_answer_create', new FormValidation($val)); @@ -329,7 +329,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiChangeAnsweredStatus(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiChangeAnsweredStatus(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { // @todo: check if is allowed to change @@ -386,7 +386,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiQAAppCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiQAAppCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateQAAppCreate($request))) { $response->set('qa_app_create', new FormValidation($val)); @@ -450,7 +450,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiChangeQAQuestionVote(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiChangeQAQuestionVote(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateQuestionVote($request))) { $response->set('qa_question_vote', new FormValidation($val)); @@ -525,7 +525,7 @@ final class ApiController extends Controller * * @since 1.0.0 */ - public function apiChangeQAAnswerVote(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function apiChangeQAAnswerVote(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { if (!empty($val = $this->validateAnswerVote($request))) { $response->set('qa_answer_vote', new FormValidation($val)); diff --git a/Controller/BackendController.php b/Controller/BackendController.php index dc3c766..4bfd9bf 100755 --- a/Controller/BackendController.php +++ b/Controller/BackendController.php @@ -48,7 +48,7 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function setUpBackend(RequestAbstract $request, ResponseAbstract $response, $data = null) : void + public function setUpBackend(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void { $head = $response->get('Content')->getData('head'); $head->addAsset(AssetType::CSS, '/Modules/QA/Theme/Backend/styles.css'); @@ -66,12 +66,13 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewQADashboard(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewQADashboard(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/QA/Theme/Backend/qa-dashboard'); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1006001001, $request, $response)); + /** @var \Modules\QA\Models\QAQuestion[] $list */ $list = QAQuestionMapper::getAll() ->with('createdBy') ->with('createdBy/account') @@ -86,6 +87,7 @@ final class BackendController extends Controller $view->setData('questions', $list); + /** @var \Modules\QA\Models\QAApp[] $apps */ $apps = QAAppMapper::getAll()->execute(); $view->setData('apps', $apps); @@ -104,12 +106,13 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewQADoc(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewQADoc(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/QA/Theme/Backend/qa-question'); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1006001001, $request, $response)); + /** @var \Modules\QA\Models\QAQuestion $question */ $question = QAQuestionMapper::get() ->with('answers') ->with('answers/createdBy') @@ -145,12 +148,13 @@ final class BackendController extends Controller * @since 1.0.0 * @codeCoverageIgnore */ - public function viewQAQuestionCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewQAQuestionCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/QA/Theme/Backend/qa-question-create'); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1006001001, $request, $response)); + /** @var \Modules\QA\Models\QAQuestion $question */ $question = QAQuestionMapper::get()->where('id', (int) $request->getData('id'))->execute(); $view->addData('question', $question); @@ -168,18 +172,20 @@ final class BackendController extends Controller * * @since 1.0.0 */ - public function viewModuleSettings(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewModuleSettings(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1000105001, $request, $response)); $id = $request->getData('id') ?? ''; + /** @var \Model\Setting[] $settings */ $settings = SettingMapper::getAll()->where('module', $id)->execute(); if (!($settings instanceof NullSetting)) { $view->setData('settings', !\is_array($settings) ? [$settings] : $settings); } + /** @var \Modules\QA\Models\QAApp[] $apps */ $apps = QAAppMapper::getAll()->execute(); $view->setData('apps', $apps); @@ -203,7 +209,7 @@ final class BackendController extends Controller * * @since 1.0.0 */ - public function viewAppSettings(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface + public function viewAppSettings(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface { $view = new View($this->app->l11nManager, $request, $response); $view->setTemplate('/Modules/' . static::NAME . '/Admin/Settings/Theme/Backend/settings-app'); diff --git a/Models/QAAnswerMapper.php b/Models/QAAnswerMapper.php index d93a6dc..416cb26 100755 --- a/Models/QAAnswerMapper.php +++ b/Models/QAAnswerMapper.php @@ -48,7 +48,7 @@ final class QAAnswerMapper extends DataMapperFactory /** * Belongs to. * - * @var array + * @var array * @since 1.0.0 */ public const BELONGS_TO = [ diff --git a/Models/QAAnswerVoteMapper.php b/Models/QAAnswerVoteMapper.php index 163bbfd..f2fdd7b 100755 --- a/Models/QAAnswerVoteMapper.php +++ b/Models/QAAnswerVoteMapper.php @@ -45,7 +45,7 @@ final class QAAnswerVoteMapper extends DataMapperFactory /** * Belongs to. * - * @var array + * @var array * @since 1.0.0 */ public const BELONGS_TO = [ diff --git a/Models/QAHelperMapper.php b/Models/QAHelperMapper.php index 657c3c1..3859ece 100755 --- a/Models/QAHelperMapper.php +++ b/Models/QAHelperMapper.php @@ -48,7 +48,7 @@ final class QAHelperMapper extends DataMapperFactory ?->fetchAll(); if ($questionScore === null) { - $questionScore = [];; + $questionScore = []; } foreach ($questionScore as $votes) { @@ -65,7 +65,7 @@ final class QAHelperMapper extends DataMapperFactory ?->fetchAll(); if ($answerScore === null) { - $answerScore = [];; + $answerScore = []; } foreach ($answerScore as $votes) { diff --git a/Models/QAQuestionMapper.php b/Models/QAQuestionMapper.php index 1ac0d6f..3ae61ea 100755 --- a/Models/QAQuestionMapper.php +++ b/Models/QAQuestionMapper.php @@ -83,7 +83,7 @@ final class QAQuestionMapper extends DataMapperFactory /** * Belongs to. * - * @var array + * @var array * @since 1.0.0 */ public const BELONGS_TO = [ diff --git a/Models/QAQuestionVoteMapper.php b/Models/QAQuestionVoteMapper.php index 7e69531..4dd9c87 100755 --- a/Models/QAQuestionVoteMapper.php +++ b/Models/QAQuestionVoteMapper.php @@ -45,7 +45,7 @@ final class QAQuestionVoteMapper extends DataMapperFactory /** * Belongs to. * - * @var array + * @var array * @since 1.0.0 */ public const BELONGS_TO = [