Jingga/oms-Comments
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-Comments.git synced 2026-02-16 17:28:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc fixes

Browse Source
This commit is contained in:
Dennis Eichhorn 2022-04-21 23:52:00 +02:00
parent 3603cc4464
commit b09734a560
4 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
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.

20
Controller/ApiController.php
View File

@ -60,7 +60,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiCommentListCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiCommentListCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$commentList = $this->createCommentList(); $commentList = $this->createCommentList();
$this->createModel($request->header->account, $commentList, CommentListMapper::class, 'comment_list', $request->getOrigin()); $this->createModel($request->header->account, $commentList, CommentListMapper::class, 'comment_list', $request->getOrigin());
@ -94,7 +94,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiCommentListUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiCommentListUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var \Modules\Comments\Models\CommentList $old */ /** @var \Modules\Comments\Models\CommentList $old */
$old = clone CommentListMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone CommentListMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -137,7 +137,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiCommentCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiCommentCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateCommentCreate($request))) { if (!empty($val = $this->validateCommentCreate($request))) {
$response->set('comment_create', new FormValidation($val)); $response->set('comment_create', new FormValidation($val));
@ -316,7 +316,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiCommentUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiCommentUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var \Modules\Comments\Models\Comment $old */ /** @var \Modules\Comments\Models\Comment $old */
$old = clone CommentMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone CommentMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -338,9 +338,9 @@ final class ApiController extends Controller
{ {
/** @var \Modules\Comments\Models\Comment $comment */ /** @var \Modules\Comments\Models\Comment $comment */
$comment = CommentMapper::get()->where('id', (int) $request->getData('id'))->execute(); $comment = CommentMapper::get()->where('id', (int) $request->getData('id'))->execute();
$comment->title = $request->getData('title') ?? $comment->getTitle(); $comment->title = $request->getData('title') ?? $comment->title;
$comment->contentRaw = $request->getData('plain') ?? $comment->getContentRaw(); $comment->contentRaw = $request->getData('plain') ?? $comment->contentRaw;
$comment->content = Markdown::parse((string) ($request->getData('plain') ?? $comment->getPlain())); $comment->content = Markdown::parse((string) ($request->getData('plain') ?? $comment->contentRaw));
$comment->ref = $request->getData('ref') ?? $comment->ref; $comment->ref = $request->getData('ref') ?? $comment->ref;
return $comment; return $comment;
@ -359,7 +359,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiCommentGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiCommentGet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var \Modules\Comments\Models\Comment $comment */ /** @var \Modules\Comments\Models\Comment $comment */
$comment = CommentMapper::get()->where('id', (int) $request->getData('id'))->execute(); $comment = CommentMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -379,7 +379,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiCommentDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiCommentDelete(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var \Modules\Comments\Models\Comment $comment */ /** @var \Modules\Comments\Models\Comment $comment */
$comment = CommentMapper::get()->where('id', (int) $request->getData('id'))->execute(); $comment = CommentMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -400,7 +400,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiChangeCommentVote(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiChangeCommentVote(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateCommentVote($request))) { if (!empty($val = $this->validateCommentVote($request))) {
$response->set('qa_answer_vote', new FormValidation($val)); $response->set('qa_answer_vote', new FormValidation($val));

8
Controller/BackendController.php
View File

@ -49,7 +49,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function setUpCommentEditor(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function setUpCommentEditor(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$head = $response->get('Content')->getData('head'); $head = $response->get('Content')->getData('head');
$head->addAsset(AssetType::JS, '/Modules/Editor/Controller.js', ['type' => 'module']); $head->addAsset(AssetType::JS, '/Modules/Editor/Controller.js', ['type' => 'module']);
@ -67,7 +67,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewCommentCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewCommentCreate(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/Comments/Theme/Backend/comment-create'); $view->setTemplate('/Modules/Comments/Theme/Backend/comment-create');
@ -88,7 +88,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewCommentList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewCommentList(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/Comments/Theme/Backend/comment-list'); $view->setTemplate('/Modules/Comments/Theme/Backend/comment-list');
@ -131,7 +131,7 @@ final class BackendController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiCommentCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiCommentCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateCommentCreate($request))) { if (!empty($val = $this->validateCommentCreate($request))) {
$response->set('comment_create', new FormValidation($val)); $response->set('comment_create', new FormValidation($val));

2
Models/CommentMapper.php
View File

@ -49,7 +49,7 @@ final class CommentMapper 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 = [