Jingga/oms-Editor
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-Editor.git synced 2026-07-10 21:58:41 +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 979c8a878f
commit 8a915f395b
5 changed files with 15 additions and 15 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.

14
Controller/ApiController.php
View File

@ -82,7 +82,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiEditorDocTypeCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiEditorDocTypeCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateEditorDocTypeCreate($request))) { if (!empty($val = $this->validateEditorDocTypeCreate($request))) {
$response->set('editor_doc_type_create', new FormValidation($val)); $response->set('editor_doc_type_create', new FormValidation($val));
@ -152,7 +152,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiEditorDocTypeL11nCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiEditorDocTypeL11nCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateEditorDocTypeL11nCreate($request))) { if (!empty($val = $this->validateEditorDocTypeL11nCreate($request))) {
$response->set('editor_doc_type_l11n_create', new FormValidation($val)); $response->set('editor_doc_type_l11n_create', new FormValidation($val));
@ -222,7 +222,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiEditorCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiEditorCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateEditorCreate($request))) { if (!empty($val = $this->validateEditorCreate($request))) {
$response->set('editor_create', new FormValidation($val)); $response->set('editor_create', new FormValidation($val));
@ -414,7 +414,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiEditorUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiEditorUpdate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var \Modules\Editor\Models\EditorDoc $old */ /** @var \Modules\Editor\Models\EditorDoc $old */
$old = clone EditorDocMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone EditorDocMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -468,7 +468,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiEditorGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiEditorGet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var \Modules\Editor\Models\EditorDoc $doc */ /** @var \Modules\Editor\Models\EditorDoc $doc */
$doc = EditorDocMapper::get()->where('id', (int) $request->getData('id'))->execute(); $doc = EditorDocMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -488,7 +488,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiEditorDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiEditorDelete(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var \Modules\Editor\Models\EditorDoc $doc */ /** @var \Modules\Editor\Models\EditorDoc $doc */
$doc = EditorDocMapper::get()->where('id', (int) $request->getData('id'))->execute(); $doc = EditorDocMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -509,7 +509,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiFileCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiFileCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateEditorFileCreate($request))) { if (!empty($val = $this->validateEditorFileCreate($request))) {
$response->set('file_create', new FormValidation($val)); $response->set('file_create', new FormValidation($val));

10
Controller/BackendController.php
View File

@ -48,7 +48,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function setUpEditorEditor(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function setUpEditorEditor(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$head = $response->get('Content')->getData('head'); $head = $response->get('Content')->getData('head');
$head->addAsset(AssetType::JSLATE, 'Modules/Editor/Controller.js', ['type' => 'module']); $head->addAsset(AssetType::JSLATE, 'Modules/Editor/Controller.js', ['type' => 'module']);
@ -66,7 +66,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewEditorCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewEditorCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -94,7 +94,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewEditorList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewEditorList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -127,7 +127,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewEditorSingle(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewEditorSingle(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -180,7 +180,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewEditorEdit(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewEditorEdit(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);

2
Models/EditorDocHistoryMapper.php
View File

@ -46,7 +46,7 @@ final class EditorDocHistoryMapper 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 = [

2
Models/EditorDocMapper.php
View File

@ -53,7 +53,7 @@ final class EditorDocMapper 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 = [