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

improve docblocks for Mapper:: variables

Browse Source
This commit is contained in:
Dennis Eichhorn 2020-05-02 10:13:21 +02:00
parent e5278cdf93
commit 69ceb82229
2 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Controller/ApiController.php
View File

@ -91,6 +91,7 @@ final class ApiController extends Controller
*/ */
public function apiUnitGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Unit $unit */
$unit = UnitMapper::get((int) $request->getData('id')); $unit = UnitMapper::get((int) $request->getData('id'));
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Unit', 'Unit successfully returned.', $unit); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Unit', 'Unit successfully returned.', $unit);
} }
@ -110,6 +111,7 @@ final class ApiController extends Controller
*/ */
public function apiUnitSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Unit $old */
$old = clone UnitMapper::get((int) $request->getData('id')); $old = clone UnitMapper::get((int) $request->getData('id'));
$new = $this->updateUnitFromRequest($request); $new = $this->updateUnitFromRequest($request);
$this->updateModel($request->getHeader()->getAccount(), $old, $new, UnitMapper::class, 'unit'); $this->updateModel($request->getHeader()->getAccount(), $old, $new, UnitMapper::class, 'unit');
@ -127,6 +129,7 @@ final class ApiController extends Controller
*/ */
private function updateUnitFromRequest(RequestAbstract $request) : Unit private function updateUnitFromRequest(RequestAbstract $request) : Unit
{ {
/** @var Unit $unit */
$unit = UnitMapper::get((int) $request->getData('id')); $unit = UnitMapper::get((int) $request->getData('id'));
$unit->setName((string) ($request->getData('name') ?? $unit->getName())); $unit->setName((string) ($request->getData('name') ?? $unit->getName()));
$unit->setDescriptionRaw((string) ($request->getData('description') ?? $unit->getDescriptionRaw())); $unit->setDescriptionRaw((string) ($request->getData('description') ?? $unit->getDescriptionRaw()));
@ -154,6 +157,7 @@ final class ApiController extends Controller
*/ */
public function apiUnitDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUnitDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Unit $unit */
$unit = UnitMapper::get((int) $request->getData('id')); $unit = UnitMapper::get((int) $request->getData('id'));
$this->deleteModel($request->getHeader()->getAccount(), $unit, UnitMapper::class, 'unit'); $this->deleteModel($request->getHeader()->getAccount(), $unit, UnitMapper::class, 'unit');
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Unit', 'Unit successfully deleted.', $unit); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Unit', 'Unit successfully deleted.', $unit);
@ -259,6 +263,7 @@ final class ApiController extends Controller
*/ */
public function apiPositionGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiPositionGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Position $position */
$position = PositionMapper::get((int) $request->getData('id')); $position = PositionMapper::get((int) $request->getData('id'));
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Position', 'Position successfully returned.', $position); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Position', 'Position successfully returned.', $position);
} }
@ -278,6 +283,7 @@ final class ApiController extends Controller
*/ */
public function apiPositionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiPositionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Position $position */
$position = PositionMapper::get((int) $request->getData('id')); $position = PositionMapper::get((int) $request->getData('id'));
$this->deleteModel($request->getHeader()->getAccount(), $position, PositionMapper::class, 'position'); $this->deleteModel($request->getHeader()->getAccount(), $position, PositionMapper::class, 'position');
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Position', 'Position successfully deleted.', $position); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Position', 'Position successfully deleted.', $position);
@ -298,6 +304,7 @@ final class ApiController extends Controller
*/ */
public function apiPositionSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiPositionSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Position $old */
$old = clone PositionMapper::get((int) $request->getData('id')); $old = clone PositionMapper::get((int) $request->getData('id'));
$new = $this->updatePositionFromRequest($request); $new = $this->updatePositionFromRequest($request);
$this->updateModel($request->getHeader()->getAccount(), $old, $new, PositionMapper::class, 'position'); $this->updateModel($request->getHeader()->getAccount(), $old, $new, PositionMapper::class, 'position');
@ -315,6 +322,7 @@ final class ApiController extends Controller
*/ */
private function updatePositionFromRequest(RequestAbstract $request) : Position private function updatePositionFromRequest(RequestAbstract $request) : Position
{ {
/** @var Position $position */
$position = PositionMapper::get((int) $request->getData('id')); $position = PositionMapper::get((int) $request->getData('id'));
$position->setName((string) ($request->getData('name') ?? $position->getName())); $position->setName((string) ($request->getData('name') ?? $position->getName()));
$position->setDescriptionRaw((string) ($request->getData('description') ?? $position->getDescriptionRaw())); $position->setDescriptionRaw((string) ($request->getData('description') ?? $position->getDescriptionRaw()));
@ -432,6 +440,7 @@ final class ApiController extends Controller
*/ */
public function apiDepartmentGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiDepartmentGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Department $department */
$department = DepartmentMapper::get((int) $request->getData('id')); $department = DepartmentMapper::get((int) $request->getData('id'));
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Department', 'Department successfully returned.', $department); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Department', 'Department successfully returned.', $department);
} }
@ -451,6 +460,7 @@ final class ApiController extends Controller
*/ */
public function apiDepartmentSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiDepartmentSet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Department $old */
$old = clone DepartmentMapper::get((int) $request->getData('id')); $old = clone DepartmentMapper::get((int) $request->getData('id'));
$new = $this->updateDepartmentFromRequest($request); $new = $this->updateDepartmentFromRequest($request);
$this->updateModel($request->getHeader()->getAccount(), $old, $new, DepartmentMapper::class, 'department'); $this->updateModel($request->getHeader()->getAccount(), $old, $new, DepartmentMapper::class, 'department');
@ -468,6 +478,7 @@ final class ApiController extends Controller
*/ */
private function updateDepartmentFromRequest(RequestAbstract $request) : Department private function updateDepartmentFromRequest(RequestAbstract $request) : Department
{ {
/** @var Department $department */
$department = DepartmentMapper::get((int) $request->getData('id')); $department = DepartmentMapper::get((int) $request->getData('id'));
$department->setName((string) ($request->getData('name') ?? $department->getName())); $department->setName((string) ($request->getData('name') ?? $department->getName()));
$department->setDescriptionRaw((string) ($request->getData('description') ?? $department->getDescriptionRaw())); $department->setDescriptionRaw((string) ($request->getData('description') ?? $department->getDescriptionRaw()));
@ -498,6 +509,7 @@ final class ApiController extends Controller
*/ */
public function apiDepartmentDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiDepartmentDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Department $department */
$department = DepartmentMapper::get((int) $request->getData('id')); $department = DepartmentMapper::get((int) $request->getData('id'));
$this->deleteModel($request->getHeader()->getAccount(), $department, DepartmentMapper::class, 'department'); $this->deleteModel($request->getHeader()->getAccount(), $department, DepartmentMapper::class, 'department');
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Department', 'Department successfully deleted.', $department); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Department', 'Department successfully deleted.', $department);

16
Controller/BackendController.php
View File

@ -57,8 +57,10 @@ final class BackendController extends Controller
if ($request->getData('ptype') === '-') { if ($request->getData('ptype') === '-') {
$view->setData('units', UnitMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('units', UnitMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25));
} else { } elseif ($request->getData('ptype') === '+') {
$view->setData('units', UnitMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('units', UnitMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25));
} else {
$view->setData('units', UnitMapper::getAfterPivot(0, null, 25));
} }
return $view; return $view;
@ -115,14 +117,17 @@ final class BackendController extends Controller
$view->setTemplate('/Modules/Organization/Theme/Backend/organigram'); $view->setTemplate('/Modules/Organization/Theme/Backend/organigram');
/** @var Unit[] $units */
$units = UnitMapper::getAll(); $units = UnitMapper::getAll();
$unitTree = $this->createOrgTree($units); $unitTree = $this->createOrgTree($units);
$view->setData('unitTree', $unitTree); $view->setData('unitTree', $unitTree);
/** @var Department[] $departments */
$departments = DepartmentMapper::getAll(); $departments = DepartmentMapper::getAll();
$depTree = $this->createOrgTree($departments); $depTree = $this->createOrgTree($departments);
$view->setData('departmentTree', $depTree); $view->setData('departmentTree', $depTree);
/** @var Position[] $positions */
$positions = PositionMapper::getAll(); $positions = PositionMapper::getAll();
$posTree = $this->createOrgTree($positions); $posTree = $this->createOrgTree($positions);
$view->setData('positionTree', $posTree); $view->setData('positionTree', $posTree);
@ -168,6 +173,7 @@ final class BackendController extends Controller
$tree[$ref][$parent] = ['obj' => null, 'children' => [], 'index' => 0]; $tree[$ref][$parent] = ['obj' => null, 'children' => [], 'index' => 0];
} }
// For some stupid reason the next line is too complicated for phpstan and the error it creates is insane/wrong!
/** @phpstan-ignore-next-line */ /** @phpstan-ignore-next-line */
$tree[$ref][$parent]['children'][] = &$tree[$ref][$component->getId()]; $tree[$ref][$parent]['children'][] = &$tree[$ref][$component->getId()];
} }
@ -228,8 +234,10 @@ final class BackendController extends Controller
if ($request->getData('ptype') === '-') { if ($request->getData('ptype') === '-') {
$view->setData('departments', DepartmentMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('departments', DepartmentMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25));
} else { } elseif ($request->getData('ptype') === '+') {
$view->setData('departments', DepartmentMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('departments', DepartmentMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25));
} else {
$view->setData('departments', DepartmentMapper::getAfterPivot(0, null, 25));
} }
return $view; return $view;
@ -320,8 +328,10 @@ final class BackendController extends Controller
if ($request->getData('ptype') === '-') { if ($request->getData('ptype') === '-') {
$view->setData('positions', PositionMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('positions', PositionMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25));
} else { } elseif ($request->getData('ptype') === '+') {
$view->setData('positions', PositionMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('positions', PositionMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25));
} else {
$view->setData('positions', PositionMapper::getAfterPivot(0, null, 25));
} }
return $view; return $view;