improve docblocks for Mapper:: variables

This commit is contained in:
Dennis Eichhorn 2020-05-02 10:13:21 +02:00
parent d2478b31ec
commit 506f7f19d4
2 changed files with 30 additions and 6 deletions

View File

@ -380,6 +380,7 @@ final class ApiController extends Controller
*/ */
public function apiGroupUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiGroupUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Group $old */
$old = clone GroupMapper::get((int) $request->getData('id')); $old = clone GroupMapper::get((int) $request->getData('id'));
$new = $this->updateGroupFromRequest($request); $new = $this->updateGroupFromRequest($request);
$this->updateModel($request->getHeader()->getAccount(), $old, $new, GroupMapper::class, 'group'); $this->updateModel($request->getHeader()->getAccount(), $old, $new, GroupMapper::class, 'group');
@ -533,6 +534,7 @@ final class ApiController extends Controller
*/ */
public function apiAccountGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiAccountGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Account $account */
$account = AccountMapper::get((int) $request->getData('id')); $account = AccountMapper::get((int) $request->getData('id'));
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Account', 'Account successfully returned', $account); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Account', 'Account successfully returned', $account);
} }
@ -576,9 +578,12 @@ final class ApiController extends Controller
*/ */
public function apiAccountGroupFind(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiAccountGroupFind(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Account[] $accounts */
$accounts = \array_values(AccountMapper::find((string) ($request->getData('search') ?? ''))); $accounts = \array_values(AccountMapper::find((string) ($request->getData('search') ?? '')));
$groups = \array_values(GroupMapper::find((string) ($request->getData('search') ?? '')));
$data = []; /** @var Group[] $groups */
$groups = \array_values(GroupMapper::find((string) ($request->getData('search') ?? '')));
$data = [];
foreach ($accounts as $account) { foreach ($accounts as $account) {
$temp = $account->jsonSerialize(); $temp = $account->jsonSerialize();
@ -750,6 +755,7 @@ final class ApiController extends Controller
*/ */
public function apiAccountDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiAccountDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Account $account */
$account = AccountMapper::get((int) ($request->getData('id'))); $account = AccountMapper::get((int) ($request->getData('id')));
$this->deleteModel($request->getHeader()->getAccount(), $account, AccountMapper::class, 'account'); $this->deleteModel($request->getHeader()->getAccount(), $account, AccountMapper::class, 'account');
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Account', 'Account successfully deleted', $account); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Account', 'Account successfully deleted', $account);
@ -770,6 +776,7 @@ final class ApiController extends Controller
*/ */
public function apiAccountUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiAccountUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var Account $old */
$old = clone AccountMapper::get((int) $request->getData('id')); $old = clone AccountMapper::get((int) $request->getData('id'));
$new = $this->updateAccountFromRequest($request); $new = $this->updateAccountFromRequest($request);
$this->updateModel($request->getHeader()->getAccount(), $old, $new, AccountMapper::class, 'account'); $this->updateModel($request->getHeader()->getAccount(), $old, $new, AccountMapper::class, 'account');
@ -793,6 +800,7 @@ final class ApiController extends Controller
*/ */
private function updateAccountFromRequest(RequestAbstract $request, bool $allowPassword = false) : Account private function updateAccountFromRequest(RequestAbstract $request, bool $allowPassword = false) : Account
{ {
/** @var Account $account */
$account = AccountMapper::get((int) ($request->getData('id'))); $account = AccountMapper::get((int) ($request->getData('id')));
$account->setName((string) ($request->getData('login') ?? $account->getName())); $account->setName((string) ($request->getData('login') ?? $account->getName()));
$account->setName1((string) ($request->getData('name1') ?? $account->getName1())); $account->setName1((string) ($request->getData('name1') ?? $account->getName1()));
@ -885,6 +893,7 @@ final class ApiController extends Controller
*/ */
public function apiAccountPermissionGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiAccountPermissionGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var AccountPermission $account */
$account = AccountPermissionMapper::get((int) $request->getData('id')); $account = AccountPermissionMapper::get((int) $request->getData('id'));
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully returned', $account); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully returned', $account);
} }
@ -904,8 +913,9 @@ final class ApiController extends Controller
*/ */
public function apiGroupPermissionGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiGroupPermissionGet(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
$account = GroupPermissionMapper::get((int) $request->getData('id')); /** @var GroupPermission $group */
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully returned', $account); $group = GroupPermissionMapper::get((int) $request->getData('id'));
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully returned', $group);
} }
/** /**
@ -923,6 +933,7 @@ final class ApiController extends Controller
*/ */
public function apiGroupPermissionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiGroupPermissionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var GroupPermission $permission */
$permission = GroupPermissionMapper::get((int) $request->getData('id')); $permission = GroupPermissionMapper::get((int) $request->getData('id'));
$this->deleteModel($request->getHeader()->getAccount(), $permission, GroupPermissionMapper::class, 'group-permission'); $this->deleteModel($request->getHeader()->getAccount(), $permission, GroupPermissionMapper::class, 'group-permission');
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully deleted', $permission); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully deleted', $permission);
@ -943,6 +954,7 @@ final class ApiController extends Controller
*/ */
public function apiAccountPermissionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiAccountPermissionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var AccountPermission $permission */
$permission = AccountPermissionMapper::get((int) $request->getData('id')); $permission = AccountPermissionMapper::get((int) $request->getData('id'));
$this->deleteModel($request->getHeader()->getAccount(), $permission, AccountPermissionMapper::class, 'user-permission'); $this->deleteModel($request->getHeader()->getAccount(), $permission, AccountPermissionMapper::class, 'user-permission');
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully deleted', $permission); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully deleted', $permission);
@ -963,6 +975,7 @@ final class ApiController extends Controller
*/ */
public function apiUserPermissionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiUserPermissionDelete(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var AccountPermission $permission */
$permission = AccountPermissionMapper::get((int) $request->getData('id')); $permission = AccountPermissionMapper::get((int) $request->getData('id'));
$this->deleteModel($request->getHeader()->getAccount(), $permission, AccountPermissionMapper::class, 'user-permission'); $this->deleteModel($request->getHeader()->getAccount(), $permission, AccountPermissionMapper::class, 'user-permission');
$this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully deleted', $permission); $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Permission', 'Permission successfully deleted', $permission);
@ -1083,6 +1096,7 @@ final class ApiController extends Controller
*/ */
public function createPermissionFromRequest(RequestAbstract $request) : PermissionAbstract public function createPermissionFromRequest(RequestAbstract $request) : PermissionAbstract
{ {
/** @var AccountPermission||GroupPermission $permission */
$permission = ((int) $request->getData('permissionowner')) === PermissionOwner::GROUP ? new GroupPermission((int) $request->getData('permissionref')) : new AccountPermission((int) $request->getData('permissionref')); $permission = ((int) $request->getData('permissionowner')) === PermissionOwner::GROUP ? new GroupPermission((int) $request->getData('permissionref')) : new AccountPermission((int) $request->getData('permissionref'));
$permission->setUnit(empty($request->getData('permissionunit')) ? null : (int) $request->getData('permissionunit')); $permission->setUnit(empty($request->getData('permissionunit')) ? null : (int) $request->getData('permissionunit'));
$permission->setApp(empty($request->getData('permissionapp')) ? null : (string) $request->getData('permissionapp')); $permission->setApp(empty($request->getData('permissionapp')) ? null : (string) $request->getData('permissionapp'));
@ -1116,7 +1130,10 @@ final class ApiController extends Controller
*/ */
public function apiAccountPermissionUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiAccountPermissionUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var AccountPermission $old */
$old = clone AccountPermissionMapper::get((int) $request->getData('id')); $old = clone AccountPermissionMapper::get((int) $request->getData('id'));
/** @var AccountPermission $new */
$new = $this->updatePermissionFromRequest(AccountPermissionMapper::get((int) $request->getData('id')), $request); $new = $this->updatePermissionFromRequest(AccountPermissionMapper::get((int) $request->getData('id')), $request);
$this->updateModel($request->getHeader()->getAccount(), $old, $new, AccountPermissionMapper::class, 'account-permission'); $this->updateModel($request->getHeader()->getAccount(), $old, $new, AccountPermissionMapper::class, 'account-permission');
@ -1138,7 +1155,10 @@ final class ApiController extends Controller
*/ */
public function apiGroupPermissionUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void public function apiGroupPermissionUpdate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
{ {
/** @var GroupPermission $old */
$old = clone GroupPermissionMapper::get((int) $request->getData('id')); $old = clone GroupPermissionMapper::get((int) $request->getData('id'));
/** @var GroupPermission $new */
$new = $this->updatePermissionFromRequest(GroupPermissionMapper::get((int) $request->getData('id')), $request); $new = $this->updatePermissionFromRequest(GroupPermissionMapper::get((int) $request->getData('id')), $request);
$this->updateModel($request->getHeader()->getAccount(), $old, $new, GroupPermissionMapper::class, 'group-permission'); $this->updateModel($request->getHeader()->getAccount(), $old, $new, GroupPermissionMapper::class, 'group-permission');

View File

@ -117,8 +117,10 @@ final class BackendController extends Controller
if ($request->getData('ptype') === '-') { if ($request->getData('ptype') === '-') {
$view->setData('accounts', AccountMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('accounts', AccountMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25));
} else { } elseif ($request->getData('ptype') === '+') {
$view->setData('accounts', AccountMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('accounts', AccountMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25));
} else {
$view->setData('accounts', AccountMapper::getAfterPivot(0, null, 25));
} }
return $view; return $view;
@ -197,8 +199,10 @@ final class BackendController extends Controller
if ($request->getData('ptype') === '-') { if ($request->getData('ptype') === '-') {
$view->setData('groups', GroupMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('groups', GroupMapper::getBeforePivot((int) ($request->getData('id') ?? 0), null, 25));
} else { } elseif ($request->getData('ptype') === '+') {
$view->setData('groups', GroupMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25)); $view->setData('groups', GroupMapper::getAfterPivot((int) ($request->getData('id') ?? 0), null, 25));
} else {
$view->setData('groups', GroupMapper::getAfterPivot(0, null, 25));
} }
return $view; return $view;