doc fixes

This commit is contained in:
Dennis Eichhorn 2022-04-21 23:52:00 +02:00
parent 3b22129784
commit e6176b8b9e
6 changed files with 41 additions and 31 deletions

View File

@ -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. 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. 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.

View File

@ -67,7 +67,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiDocCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiDocCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateWikiDocCreate($request))) { if (!empty($val = $this->validateWikiDocCreate($request))) {
$response->set($request->uri->__toString(), new FormValidation($val)); $response->set($request->uri->__toString(), new FormValidation($val));
@ -308,7 +308,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiCategoryL11nCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiCategoryL11nCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateWikiCategoryL11nCreate($request))) { if (!empty($val = $this->validateWikiCategoryL11nCreate($request))) {
$response->set('wiki_category_l11n_create', new FormValidation($val)); $response->set('wiki_category_l11n_create', new FormValidation($val));
@ -357,7 +357,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiDocGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiDocGet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$doc = WikiDocMapper::get()->where('id', (int) $request->getData('id'))->execute(); $doc = WikiDocMapper::get()->where('id', (int) $request->getData('id'))->execute();
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Doc', 'Doc successfully returned', $doc); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Doc', 'Doc successfully returned', $doc);
@ -376,7 +376,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiDocUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiDocUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$old = clone WikiDocMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone WikiDocMapper::get()->where('id', (int) $request->getData('id'))->execute();
$new = $this->updateDocFromRequest($request); $new = $this->updateDocFromRequest($request);
@ -429,7 +429,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiDocDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiDocDelete(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$doc = WikiDocMapper::get()->where('id', (int) $request->getData('id'))->execute(); $doc = WikiDocMapper::get()->where('id', (int) $request->getData('id'))->execute();
$this->deleteModel($request->header->account, $doc, WikiDocMapper::class, 'doc', $request->getOrigin()); $this->deleteModel($request->header->account, $doc, WikiDocMapper::class, 'doc', $request->getOrigin());
@ -449,7 +449,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiCategoryCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiCategoryCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateWikiCategoryCreate($request))) { if (!empty($val = $this->validateWikiCategoryCreate($request))) {
$response->set($request->uri->__toString(), new FormValidation($val)); $response->set($request->uri->__toString(), new FormValidation($val));
@ -518,7 +518,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiCategoryGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiCategoryGet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$category = WikiCategoryMapper::get() $category = WikiCategoryMapper::get()
->with('name') ->with('name')
@ -542,7 +542,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiCategoryUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiCategoryUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$old = clone WikiCategoryMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone WikiCategoryMapper::get()->where('id', (int) $request->getData('id'))->execute();
$new = $this->updateCategoryFromRequest($request); $new = $this->updateCategoryFromRequest($request);
@ -580,7 +580,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiCategoryDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiCategoryDelete(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$category = WikiCategoryMapper::get()->where('id', (int) $request->getData('id'))->execute(); $category = WikiCategoryMapper::get()->where('id', (int) $request->getData('id'))->execute();
$this->deleteModel($request->header->account, $category, WikiCategoryMapper::class, 'category', $request->getOrigin()); $this->deleteModel($request->header->account, $category, WikiCategoryMapper::class, 'category', $request->getOrigin());
@ -600,7 +600,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiAppCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiAppCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateWikiAppCreate($request))) { if (!empty($val = $this->validateWikiAppCreate($request))) {
$response->set($request->uri->__toString(), new FormValidation($val)); $response->set($request->uri->__toString(), new FormValidation($val));
@ -663,7 +663,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiAppGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiAppGet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$app = WikiAppMapper::get()->where('id', (int) $request->getData('id'))->execute(); $app = WikiAppMapper::get()->where('id', (int) $request->getData('id'))->execute();
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'App', 'App successfully returned', $app); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'App', 'App successfully returned', $app);
@ -682,7 +682,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiAppUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiAppUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$old = clone WikiAppMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone WikiAppMapper::get()->where('id', (int) $request->getData('id'))->execute();
$new = $this->updateAppFromRequest($request); $new = $this->updateAppFromRequest($request);
@ -720,7 +720,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiWikiAppDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiWikiAppDelete(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$app = WikiAppMapper::get()->where('id', (int) $request->getData('id'))->execute(); $app = WikiAppMapper::get()->where('id', (int) $request->getData('id'))->execute();
$this->deleteModel($request->header->account, $app, WikiAppMapper::class, 'app', $request->getOrigin()); $this->deleteModel($request->header->account, $app, WikiAppMapper::class, 'app', $request->getOrigin());

View File

@ -53,7 +53,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @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 = $response->get('Content')->getData('head');
$head->addAsset(AssetType::CSS, '/Modules/Knowledgebase/Theme/Backend/styles.css'); $head->addAsset(AssetType::CSS, '/Modules/Knowledgebase/Theme/Backend/styles.css');
@ -71,7 +71,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseDashboard(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseDashboard(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -81,6 +81,7 @@ final class BackendController extends Controller
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-dashboard'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-dashboard');
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response)); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response));
/** @var \Modules\Knowledgebase\Models\WikiCategory[] $categories */
$categories = WikiCategoryMapper::getAll() $categories = WikiCategoryMapper::getAll()
->with('name') ->with('name')
->where('parent', $request->hasData('category') ? (int) $request->getData('category') : null) ->where('parent', $request->hasData('category') ? (int) $request->getData('category') : null)
@ -90,6 +91,7 @@ final class BackendController extends Controller
$view->setData('categories', $categories); $view->setData('categories', $categories);
/** @var \Modules\Knowledgebase\Models\WikiDoc[] $documents */
$documents = WikiDocMapper::getAll() $documents = WikiDocMapper::getAll()
->with('tags') ->with('tags')
->with('tags/title') ->with('tags/title')
@ -101,6 +103,7 @@ final class BackendController extends Controller
$view->setData('docs', $documents); $view->setData('docs', $documents);
/** @var \Modules\Knowledgebase\Models\WikiApp[] $apps */
$apps = WikiAppMapper::getAll()->execute(); $apps = WikiAppMapper::getAll()->execute();
$view->setData('apps', $apps); $view->setData('apps', $apps);
@ -119,13 +122,14 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseAppList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseAppList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-app-list'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-app-list');
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response)); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response));
/** @var \Modules\Knowledgebase\Models\WikiApp[] $list */
$list = WikiAppMapper::getAll()->execute(); $list = WikiAppMapper::getAll()->execute();
$view->setData('apps', $list); $view->setData('apps', $list);
@ -144,13 +148,14 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseApp(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseApp(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-app-single'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-app-single');
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response)); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response));
/** @var \Modules\Knowledgebase\Models\WikiApp $app */
$app = WikiAppMapper::get()->where('id', (int) $request->getData('id'))->execute(); $app = WikiAppMapper::get()->where('id', (int) $request->getData('id'))->execute();
$view->setData('app', $app); $view->setData('app', $app);
@ -169,7 +174,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseAppCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseAppCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-app-single'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-app-single');
@ -192,7 +197,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseCategoryList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseCategoryList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -201,6 +206,7 @@ final class BackendController extends Controller
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-category-list'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-category-list');
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response)); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response));
/** @var \Modules\Knowledgebase\Models\WikiCategory[] $list */
$list = WikiCategoryMapper::getAll()->with('name')->where('app', $app)->where('name/language', $response->getLanguage())->execute(); $list = WikiCategoryMapper::getAll()->with('name')->where('app', $app)->where('name/language', $response->getLanguage())->execute();
$view->setData('categories', $list); $view->setData('categories', $list);
@ -219,13 +225,14 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseCategory(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseCategory(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-category-single'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-category-single');
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response)); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response));
/** @var \Modules\Knowledgebase\Models\WikiCategory $category */
$category = WikiCategoryMapper::get()->where('id', (int) $request->getData('id'))->execute(); $category = WikiCategoryMapper::get()->where('id', (int) $request->getData('id'))->execute();
$view->setData('category', $category); $view->setData('category', $category);
@ -244,7 +251,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseCategoryCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseCategoryCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-category-single'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-category-single');
@ -267,13 +274,14 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseDocList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseDocList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-doc-list'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-doc-list');
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response)); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response));
/** @var \Modules\Knowledgebase\Models\WikiDoc[] $list */
$list = WikiDocMapper::getAll()->limit(25)->execute(); $list = WikiDocMapper::getAll()->limit(25)->execute();
$view->setData('docs', $list); $view->setData('docs', $list);
@ -292,12 +300,13 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseDoc(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseDoc(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
$app = (int) ($request->getData('app') ?? $this->app->orgId); $app = (int) ($request->getData('app') ?? $this->app->orgId);
/** @var \Modules\Knowledgebase\Models\WikiDoc $document */
$document = WikiDocMapper::get() $document = WikiDocMapper::get()
->with('tags') ->with('tags')
->with('tags/title') ->with('tags/title')
@ -320,6 +329,7 @@ final class BackendController extends Controller
$view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-doc-single'); $view->setTemplate('/Modules/Knowledgebase/Theme/Backend/wiki-doc-single');
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response)); $view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005901001, $request, $response));
/** @var \Modules\Knowledgebase\Models\WikiCategory[] $categories */
$categories = WikiCategoryMapper::getAll() $categories = WikiCategoryMapper::getAll()
->with('name') ->with('name')
->where('parent', $request->hasData('category') ? (int) $request->getData('category') : null) ->where('parent', $request->hasData('category') ? (int) $request->getData('category') : null)
@ -348,7 +358,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseDocCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseDocCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -378,7 +388,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewKnowledgebaseDocEdit(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewKnowledgebaseDocEdit(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);

View File

@ -56,9 +56,9 @@ final class WikiCategoryMapper extends DataMapperFactory
]; ];
/** /**
* Has owns one relation. * Belongs to.
* *
* @var array<string, array{mapper:string, external:string}> * @var array<string, array{mapper:string, external:string, column?:string, by?:string}>
* @since 1.0.0 * @since 1.0.0
*/ */
public const BELONGS_TO = [ public const BELONGS_TO = [

View File

@ -48,7 +48,7 @@ final class WikiDocMapper extends DataMapperFactory
/** /**
* Belongs to. * Belongs to.
* *
* @var array<string, array{mapper:string, external:string}> * @var array<string, array{mapper:string, external:string, column?:string, by?:string}>
* @since 1.0.0 * @since 1.0.0
*/ */
public const BELONGS_TO = [ public const BELONGS_TO = [

View File

@ -72,9 +72,9 @@ final class WikiDocMapper extends DataMapperFactory
]; ];
/** /**
* Has owns one relation. * Belongs to.
* *
* @var array<string, array{mapper:string, external:string}> * @var array<string, array{mapper:string, external:string, column?:string, by?:string}>
* @since 1.0.0 * @since 1.0.0
*/ */
public const BELONGS_TO = [ public const BELONGS_TO = [