refactor: [WIP] Migrate category controller.

Signed-off-by: Rubén D <nuxsmin@syspass.org>
This commit is contained in:
Rubén D
2022-06-11 09:16:27 +02:00
parent 54bedda0b2
commit 52c6fa2e3f
10 changed files with 771 additions and 494 deletions

View File

@@ -0,0 +1,61 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use SP\Core\Application;
use SP\Domain\Category\CategoryServiceInterface;
use SP\Domain\CustomField\CustomFieldServiceInterface;
use SP\Modules\Web\Controllers\ControllerBase;
use SP\Modules\Web\Controllers\Traits\JsonTrait;
use SP\Modules\Web\Forms\CategoryForm;
use SP\Mvc\Controller\ItemTrait;
use SP\Mvc\Controller\WebControllerHelper;
/**
* A base class for all save actions
*/
abstract class CategorySaveBase extends ControllerBase
{
use JsonTrait, ItemTrait;
protected CategoryServiceInterface $categoryService;
protected CustomFieldServiceInterface $customFieldService;
protected CategoryForm $form;
public function __construct(
Application $application,
WebControllerHelper $webControllerHelper,
CategoryServiceInterface $categoryService,
CustomFieldServiceInterface $customFieldService
) {
parent::__construct($application, $webControllerHelper);
$this->checkLoggedIn();
$this->categoryService = $categoryService;
$this->customFieldService = $customFieldService;
$this->form = new CategoryForm($application, $this->request);
}
}

View File

@@ -0,0 +1,106 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use SP\Core\Acl\Acl;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Application;
use SP\Core\Exceptions\ConstraintException;
use SP\Core\Exceptions\QueryException;
use SP\Core\Exceptions\SPException;
use SP\DataModel\CategoryData;
use SP\Domain\Category\CategoryServiceInterface;
use SP\Domain\Common\Services\ServiceException;
use SP\Domain\CustomField\CustomFieldServiceInterface;
use SP\Infrastructure\Common\Repositories\NoSuchItemException;
use SP\Modules\Web\Controllers\ControllerBase;
use SP\Mvc\Controller\ItemTrait;
use SP\Mvc\Controller\WebControllerHelper;
/**
* A base class for all viewable actions
*/
abstract class CategoryViewBase extends ControllerBase
{
use ItemTrait;
private CategoryServiceInterface $categoryService;
private CustomFieldServiceInterface $customFieldService;
public function __construct(
Application $application,
WebControllerHelper $webControllerHelper,
CategoryServiceInterface $categoryService,
CustomFieldServiceInterface $customFieldService
) {
parent::__construct($application, $webControllerHelper);
$this->checkLoggedIn();
$this->categoryService = $categoryService;
$this->customFieldService = $customFieldService;
}
/**
* Sets view data for displaying category's data
*
* @param int|null $categoryId
*
* @throws ConstraintException
* @throws NoSuchItemException
* @throws QueryException
* @throws SPException
* @throws ServiceException
*/
protected function setViewData(?int $categoryId = null)
{
$this->view->addTemplate('category', 'itemshow');
$category = $categoryId
? $this->categoryService->getById($categoryId)
: new CategoryData();
$this->view->assign('category', $category);
$this->view->assign('nextAction', Acl::getActionRoute(ActionsInterface::ITEMS_MANAGE));
if ($this->view->isView === true) {
$this->view->assign('disabled', 'disabled');
$this->view->assign('readonly', 'readonly');
} else {
$this->view->assign('disabled', false);
$this->view->assign('readonly', false);
}
$this->view->assign(
'showViewCustomPass',
$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_VIEW_PASS)
);
$this->view->assign(
'customFields',
$this->getCustomFieldsForItem(ActionsInterface::CATEGORY, $categoryId, $this->customFieldService)
);
}
}

View File

@@ -0,0 +1,71 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use Exception;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Events\Event;
use SP\Http\JsonResponse;
use SP\Modules\Web\Controllers\Traits\JsonTrait;
/**
* CreateController
*/
final class CreateController extends CategoryViewBase
{
use JsonTrait;
/**
* @return bool
* @throws \JsonException
*/
public function createAction(): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_CREATE)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->view->assign('header', __('New Category'));
$this->view->assign('isView', false);
$this->view->assign('route', 'category/saveCreate');
$this->setViewData();
$this->eventDispatcher->notifyEvent('show.category.create', new Event($this));
return $this->returnJsonResponseData(['html' => $this->render()]);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent('exception', new Event($e));
return $this->returnJsonResponseException($e);
}
}
}

View File

@@ -0,0 +1,99 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use Exception;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
use SP\Http\JsonResponse;
/**
* DeleteController
*/
final class DeleteController extends CategorySaveBase
{
/**
* Delete action
*
* @param int|null $id
*
* @return bool
* @throws \JsonException
*/
public function deleteAction(?int $id = null): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_DELETE)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
if ($id === null) {
$this->categoryService->deleteByIdBatch($this->getItemsIdFromRequest($this->request));
$this->deleteCustomFieldsForItem(ActionsInterface::CATEGORY, $id, $this->customFieldService);
$this->eventDispatcher->notifyEvent(
'delete.category',
new Event(
$this,
EventMessage::factory()->addDescription(__u('Categories deleted'))
)
);
return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Categories deleted'));
}
$this->categoryService->delete($id);
$this->deleteCustomFieldsForItem(ActionsInterface::CATEGORY, $id, $this->customFieldService);
$this->eventDispatcher->notifyEvent(
'delete.category',
new Event(
$this,
EventMessage::factory()
->addDescription(__u('Category deleted'))
->addDetail(__u('Category'), $id)
)
);
return $this->returnJsonResponse(
JsonResponse::JSON_SUCCESS,
__u('Category deleted')
);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent('exception', new Event($e));
return $this->returnJsonResponseException($e);
}
}
}

View File

@@ -0,0 +1,76 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use Exception;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Events\Event;
use SP\Http\JsonResponse;
use SP\Modules\Web\Controllers\Traits\JsonTrait;
/**
* EditController
*/
final class EditController extends CategoryViewBase
{
use JsonTrait;
/**
* Edit action
*
* @param int $id
*
* @return bool
* @throws \JsonException
*/
public function editAction(int $id): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_EDIT)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->view->assign('header', __('Edit Category'));
$this->view->assign('isView', false);
$this->view->assign('route', 'category/saveEdit/'.$id);
$this->setViewData($id);
$this->eventDispatcher->notifyEvent('show.category.edit', new Event($this));
return $this->returnJsonResponseData(['html' => $this->render()]);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent('exception', new Event($e));
return $this->returnJsonResponseException($e);
}
}
}

View File

@@ -0,0 +1,87 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use Exception;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
use SP\Core\Exceptions\ValidationException;
use SP\Http\JsonResponse;
/**
* SaveCreateAction
*/
final class SaveCreateAction extends CategorySaveBase
{
/**
* @return bool
* @throws \JsonException
*/
public function saveCreateAction(): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_CREATE)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->form->validateFor(ActionsInterface::CATEGORY_CREATE);
$itemData = $this->form->getItemData();
$id = $this->categoryService->create($itemData);
$this->eventDispatcher->notifyEvent(
'create.category',
new Event(
$this,
EventMessage::factory()
->addDescription(__u('Category added'))
->addDetail(__u('Category'), $itemData->getName())
)
);
$this->addCustomFieldsForItem(
ActionsInterface::CATEGORY,
$id,
$this->request,
$this->customFieldService
);
return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Category added'));
} catch (ValidationException $e) {
return $this->returnJsonResponseException($e);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent('exception', new Event($e));
return $this->returnJsonResponseException($e);
}
}
}

View File

@@ -0,0 +1,91 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use Exception;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
use SP\Core\Exceptions\ValidationException;
use SP\Http\JsonResponse;
/**
* SaveEditController
*/
final class SaveEditController extends CategorySaveBase
{
/**
* Saves edit action
*
* @param int $id
*
* @return bool
* @throws \JsonException
*/
public function saveEditAction(int $id): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_EDIT)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->form->validateFor(ActionsInterface::CATEGORY_EDIT, $id);
$itemData = $this->form->getItemData();
$this->categoryService->update($itemData);
$this->eventDispatcher->notifyEvent(
'edit.category',
new Event(
$this,
EventMessage::factory()
->addDescription(__u('Category updated'))
->addDetail(__u('Category'), $itemData->getName())
)
);
$this->updateCustomFieldsForItem(
ActionsInterface::CATEGORY,
$id,
$this->request,
$this->customFieldService
);
return $this->returnJsonResponse(JsonResponse::JSON_SUCCESS, __u('Category updated'));
} catch (ValidationException $e) {
return $this->returnJsonResponseException($e);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent('exception', new Event($e));
return $this->returnJsonResponseException($e);
}
}
}

View File

@@ -0,0 +1,106 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Application;
use SP\Core\Exceptions\ConstraintException;
use SP\Core\Exceptions\QueryException;
use SP\Core\Exceptions\SPException;
use SP\Domain\Category\CategoryServiceInterface;
use SP\Html\DataGrid\DataGridInterface;
use SP\Http\JsonResponse;
use SP\Modules\Web\Controllers\ControllerBase;
use SP\Modules\Web\Controllers\Helpers\Grid\CategoryGrid;
use SP\Modules\Web\Controllers\Traits\JsonTrait;
use SP\Mvc\Controller\ItemTrait;
use SP\Mvc\Controller\WebControllerHelper;
/**
* SearchController
*/
final class SearchController extends ControllerBase
{
use JsonTrait, ItemTrait;
private CategoryServiceInterface $categoryService;
private CategoryGrid $categoryGrid;
public function __construct(
Application $application,
WebControllerHelper $webControllerHelper,
CategoryServiceInterface $categoryService,
CategoryGrid $categoryGrid
) {
parent::__construct($application, $webControllerHelper);
$this->checkLoggedIn();
$this->categoryService = $categoryService;
$this->categoryGrid = $categoryGrid;
}
/**
* Search action
*
* @return bool
* @throws ConstraintException
* @throws QueryException
* @throws SPException
* @throws \JsonException
*/
public function searchAction(): bool
{
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_SEARCH)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->view->addTemplate('datagrid-table', 'grid');
$this->view->assign('index', $this->request->analyzeInt('activetab', 0));
$this->view->assign('data', $this->getSearchGrid());
return $this->returnJsonResponseData(['html' => $this->render()]);
}
/**
* getSearchGrid
*
* @throws ConstraintException
* @throws QueryException
*/
protected function getSearchGrid(): DataGridInterface
{
$itemSearchData = $this->getSearchData($this->configData->getAccountCount(), $this->request);
return $this->categoryGrid->updatePager(
$this->categoryGrid->getGrid($this->categoryService->search($itemSearchData)),
$itemSearchData
);
}
}

View File

@@ -0,0 +1,74 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers\Category;
use Exception;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Events\Event;
use SP\Http\JsonResponse;
use SP\Modules\Web\Controllers\Traits\JsonTrait;
/**
* ViewController
*/
final class ViewController extends CategoryViewBase
{
use JsonTrait;
/**
* View action
*
* @param int $id
*
* @return bool
* @throws \JsonException
*/
public function viewAction(int $id): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_VIEW)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->view->assign('header', __('View Category'));
$this->view->assign('isView', true);
$this->setViewData($id);
$this->eventDispatcher->notifyEvent('show.category', new Event($this));
return $this->returnJsonResponseData(['html' => $this->render()]);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent('exception', new Event($e));
return $this->returnJsonResponseException($e);
}
}
}

View File

@@ -1,494 +0,0 @@
<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2021, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Modules\Web\Controllers;
use DI\DependencyException;
use DI\NotFoundException;
use Exception;
use SP\Core\Acl\Acl;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
use SP\Core\Exceptions\ConstraintException;
use SP\Core\Exceptions\QueryException;
use SP\Core\Exceptions\SessionTimeout;
use SP\Core\Exceptions\SPException;
use SP\Core\Exceptions\ValidationException;
use SP\DataModel\CategoryData;
use SP\Domain\Auth\Services\AuthException;
use SP\Domain\Category\Services\CategoryService;
use SP\Domain\Common\Services\ServiceException;
use SP\Html\DataGrid\DataGridInterface;
use SP\Http\JsonResponse;
use SP\Infrastructure\Common\Repositories\NoSuchItemException;
use SP\Modules\Web\Controllers\Helpers\Grid\CategoryGrid;
use SP\Modules\Web\Controllers\Traits\JsonTrait;
use SP\Modules\Web\Forms\CategoryForm;
use SP\Mvc\Controller\CrudControllerInterface;
use SP\Mvc\Controller\ItemTrait;
/**
* Class CategoryController
*
* @package SP\Modules\Web\Controllers
*/
final class CategoryController extends ControllerBase implements CrudControllerInterface
{
use JsonTrait, ItemTrait;
protected ?CategoryService $categoryService = null;
/**
* Search action
*
* @return bool
* @throws DependencyException
* @throws NotFoundException
* @throws ConstraintException
* @throws QueryException
* @throws SPException
* @throws \JsonException
*/
public function searchAction(): bool
{
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_SEARCH)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->view->addTemplate('datagrid-table', 'grid');
$this->view->assign(
'index',
$this->request->analyzeInt('activetab', 0)
);
$this->view->assign('data', $this->getSearchGrid());
return $this->returnJsonResponseData(['html' => $this->render()]);
}
/**
* getSearchGrid
*
* @throws DependencyException
* @throws NotFoundException
* @throws ConstraintException
* @throws QueryException
*/
protected function getSearchGrid(): DataGridInterface
{
$itemSearchData = $this->getSearchData(
$this->configData->getAccountCount(),
$this->request
);
$itemsGridHelper = $this->dic->get(CategoryGrid::class);
return $itemsGridHelper->updatePager(
$itemsGridHelper->getGrid($this->categoryService->search($itemSearchData)),
$itemSearchData
);
}
/**
* @return bool
* @throws DependencyException
* @throws NotFoundException
* @throws \JsonException
*/
public function createAction(): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_CREATE)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->view->assign('header', __('New Category'));
$this->view->assign('isView', false);
$this->view->assign('route', 'category/saveCreate');
$this->setViewData();
$this->eventDispatcher->notifyEvent(
'show.category.create',
new Event($this)
);
return $this->returnJsonResponseData(['html' => $this->render()]);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent(
'exception',
new Event($e)
);
return $this->returnJsonResponseException($e);
}
}
/**
* Sets view data for displaying category's data
*
* @param int|null $categoryId
*
* @throws ConstraintException
* @throws DependencyException
* @throws NoSuchItemException
* @throws NotFoundException
* @throws QueryException
* @throws SPException
* @throws ServiceException
*/
protected function setViewData(?int $categoryId = null)
{
$this->view->addTemplate('category', 'itemshow');
$category = $categoryId
? $this->categoryService->getById($categoryId)
: new CategoryData();
$this->view->assign('category', $category);
$this->view->assign(
'nextAction',
Acl::getActionRoute(ActionsInterface::ITEMS_MANAGE)
);
if ($this->view->isView === true) {
$this->view->assign('disabled', 'disabled');
$this->view->assign('readonly', 'readonly');
} else {
$this->view->assign('disabled', false);
$this->view->assign('readonly', false);
}
$this->view->assign(
'showViewCustomPass',
$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_VIEW_PASS)
);
$this->view->assign(
'customFields',
$this->getCustomFieldsForItem(ActionsInterface::CATEGORY, $categoryId)
);
}
/**
* Edit action
*
* @param int $id
*
* @return bool
* @throws DependencyException
* @throws NotFoundException
* @throws \JsonException
*/
public function editAction(int $id): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_EDIT)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->view->assign('header', __('Edit Category'));
$this->view->assign('isView', false);
$this->view->assign('route', 'category/saveEdit/' . $id);
$this->setViewData($id);
$this->eventDispatcher->notifyEvent(
'show.category.edit',
new Event($this)
);
return $this->returnJsonResponseData(['html' => $this->render()]);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent(
'exception',
new Event($e)
);
return $this->returnJsonResponseException($e);
}
}
/**
* Delete action
*
* @param int|null $id
*
* @return bool
* @throws DependencyException
* @throws NotFoundException
* @throws \JsonException
*/
public function deleteAction(?int $id = null): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_DELETE)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
if ($id === null) {
$this->categoryService
->deleteByIdBatch($this->getItemsIdFromRequest($this->request));
$this->deleteCustomFieldsForItem(ActionsInterface::CATEGORY, $id);
$this->eventDispatcher->notifyEvent(
'delete.category',
new Event(
$this,
EventMessage::factory()
->addDescription(__u('Categories deleted'))
)
);
return $this->returnJsonResponse(
JsonResponse::JSON_SUCCESS,
__u('Categories deleted')
);
}
$this->categoryService->delete($id);
$this->deleteCustomFieldsForItem(ActionsInterface::CATEGORY, $id);
$this->eventDispatcher->notifyEvent(
'delete.category',
new Event(
$this,
EventMessage::factory()
->addDescription(__u('Category deleted'))
->addDetail(__u('Category'), $id)
)
);
return $this->returnJsonResponse(
JsonResponse::JSON_SUCCESS,
__u('Category deleted')
);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent(
'exception',
new Event($e)
);
return $this->returnJsonResponseException($e);
}
}
/**
* @return bool
* @throws DependencyException
* @throws NotFoundException
* @throws \JsonException
*/
public function saveCreateAction(): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_CREATE)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$form = new CategoryForm($this->dic);
$form->validateFor(ActionsInterface::CATEGORY_CREATE, null);
$itemData = $form->getItemData();
$id = $this->categoryService->create($itemData);
$this->eventDispatcher->notifyEvent(
'create.category',
new Event(
$this,
EventMessage::factory()
->addDescription(__u('Category added'))
->addDetail(__u('Category'), $itemData->getName())
)
);
$this->addCustomFieldsForItem(
ActionsInterface::CATEGORY,
$id,
$this->request
);
return $this->returnJsonResponse(
JsonResponse::JSON_SUCCESS,
__u('Category added')
);
} catch (ValidationException $e) {
return $this->returnJsonResponseException($e);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent(
'exception',
new Event($e)
);
return $this->returnJsonResponseException($e);
}
}
/**
* Saves edit action
*
* @param int $id
*
* @return bool
* @throws DependencyException
* @throws NotFoundException
* @throws \JsonException
*/
public function saveEditAction(int $id): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_EDIT)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$form = new CategoryForm($this->dic, $id);
$form->validateFor(Acl::CATEGORY_EDIT, null);
$itemData = $form->getItemData();
$this->categoryService->update($itemData);
$this->eventDispatcher->notifyEvent(
'edit.category',
new Event(
$this,
EventMessage::factory()
->addDescription(__u('Category updated'))
->addDetail(__u('Category'), $itemData->getName())
)
);
$this->updateCustomFieldsForItem(
ActionsInterface::CATEGORY,
$id,
$this->request
);
return $this->returnJsonResponse(
JsonResponse::JSON_SUCCESS,
__u('Category updated')
);
} catch (ValidationException $e) {
return $this->returnJsonResponseException($e);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent(
'exception',
new Event($e)
);
return $this->returnJsonResponseException($e);
}
}
/**
* View action
*
* @param int $id
*
* @return bool
* @throws DependencyException
* @throws NotFoundException
* @throws \JsonException
*/
public function viewAction(int $id): bool
{
try {
if (!$this->acl->checkUserAccess(ActionsInterface::CATEGORY_VIEW)) {
return $this->returnJsonResponse(
JsonResponse::JSON_ERROR,
__u('You don\'t have permission to do this operation')
);
}
$this->view->assign('header', __('View Category'));
$this->view->assign('isView', true);
$this->setViewData($id);
$this->eventDispatcher->notifyEvent(
'show.category',
new Event($this)
);
return $this->returnJsonResponseData(['html' => $this->render()]);
} catch (Exception $e) {
processException($e);
$this->eventDispatcher->notifyEvent(
'exception',
new Event($e)
);
return $this->returnJsonResponseException($e);
}
}
/**
* Initialize class
*
* @throws AuthException
* @throws DependencyException
* @throws NotFoundException
* @throws SessionTimeout
*/
protected function initialize(): void
{
$this->checkLoggedIn();
$this->categoryService = $this->dic->get(CategoryService::class);
}
}