Jingga/oms-Organization
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-Organization.git synced 2026-02-17 16: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 96c05517c0
commit 12c6858271
6 changed files with 30 additions and 30 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.

32
Controller/ApiController.php
View File

@ -87,7 +87,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiUnitGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitGet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Unit $unit */ /** @var Unit $unit */
$unit = UnitMapper::get()->where('id', (int) $request->getData('id'))->execute(); $unit = UnitMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -107,7 +107,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiUnitSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitSet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Unit $old */ /** @var Unit $old */
$old = clone UnitMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone UnitMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -153,7 +153,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiUnitDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitDelete(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Unit $unit */ /** @var Unit $unit */
$unit = UnitMapper::get()->where('id', (int) $request->getData('id'))->execute(); $unit = UnitMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -174,7 +174,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiUnitCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateUnitCreate($request))) { if (!empty($val = $this->validateUnitCreate($request))) {
$response->set('unit_create', new FormValidation($val)); $response->set('unit_create', new FormValidation($val));
@ -233,7 +233,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiUnitImageSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitImageSet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$uploadedFiles = $request->getFiles(); $uploadedFiles = $request->getFiles();
if (empty($uploadedFiles)) { if (empty($uploadedFiles)) {
@ -306,7 +306,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiPositionGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiPositionGet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Position $position */ /** @var Position $position */
$position = PositionMapper::get()->where('id', (int) $request->getData('id'))->execute(); $position = PositionMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -326,7 +326,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiPositionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiPositionDelete(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Position $position */ /** @var Position $position */
$position = PositionMapper::get()->where('id', (int) $request->getData('id'))->execute(); $position = PositionMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -347,7 +347,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiPositionSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiPositionSet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Position $old */ /** @var Position $old */
$old = clone PositionMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone PositionMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -396,7 +396,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiPositionCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiPositionCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validatePositionCreate($request))) { if (!empty($val = $this->validatePositionCreate($request))) {
$response->set('position_create', new FormValidation($val)); $response->set('position_create', new FormValidation($val));
@ -485,7 +485,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiDepartmentGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiDepartmentGet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Department $department */ /** @var Department $department */
$department = DepartmentMapper::get()->where('id', (int) $request->getData('id'))->execute(); $department = DepartmentMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -505,7 +505,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiDepartmentSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiDepartmentSet(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Department $old */ /** @var Department $old */
$old = clone DepartmentMapper::get()->where('id', (int) $request->getData('id'))->execute(); $old = clone DepartmentMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -554,7 +554,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiDepartmentDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiDepartmentDelete(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
/** @var Department $department */ /** @var Department $department */
$department = DepartmentMapper::get()->where('id', (int) $request->getData('id'))->execute(); $department = DepartmentMapper::get()->where('id', (int) $request->getData('id'))->execute();
@ -575,7 +575,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiDepartmentCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiDepartmentCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
if (!empty($val = $this->validateDepartmentCreate($request))) { if (!empty($val = $this->validateDepartmentCreate($request))) {
$response->set('department_create', new FormValidation($val)); $response->set('department_create', new FormValidation($val));
@ -635,7 +635,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiUnitFind(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitFind(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$response->header->set('Content-Type', MimeType::M_JSON, true); $response->header->set('Content-Type', MimeType::M_JSON, true);
$response->set( $response->set(
@ -659,7 +659,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiDepartmentFind(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiDepartmentFind(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$response->header->set('Content-Type', MimeType::M_JSON, true); $response->header->set('Content-Type', MimeType::M_JSON, true);
$response->set( $response->set(
@ -683,7 +683,7 @@ final class ApiController extends Controller
* *
* @since 1.0.0 * @since 1.0.0
*/ */
public function apiPositionFind(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiPositionFind(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{ {
$response->header->set('Content-Type', MimeType::M_JSON, true); $response->header->set('Content-Type', MimeType::M_JSON, true);
$response->set( $response->set(

20
Controller/BackendController.php
View File

@ -50,7 +50,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewUnitList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewUnitList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -80,7 +80,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewUnitProfile(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewUnitProfile(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -109,7 +109,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewOrganigram(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewOrganigram(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$response->get('Content') $response->get('Content')
->getData('head') ->getData('head')
@ -197,7 +197,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewUnitCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewUnitCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -228,7 +228,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewDepartmentList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewDepartmentList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -258,7 +258,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewDepartmentProfile(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewDepartmentProfile(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -291,7 +291,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewDepartmentCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewDepartmentCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -322,7 +322,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewPositionList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewPositionList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -352,7 +352,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewPositionProfile(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewPositionProfile(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{ {
$view = new View($this->app->l11nManager, $request, $response); $view = new View($this->app->l11nManager, $request, $response);
@ -385,7 +385,7 @@ final class BackendController extends Controller
* @since 1.0.0 * @since 1.0.0
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function viewPositionCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface public function viewPositionCreate(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/DepartmentMapper.php
View File

@ -45,7 +45,7 @@ final class DepartmentMapper 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/PositionMapper.php
View File

@ -45,7 +45,7 @@ final class PositionMapper 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/UnitMapper.php
View File

@ -59,7 +59,7 @@ final class UnitMapper 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 = [