. */ 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\ValidationException; use SP\DataModel\CustomFieldDefinitionData; use SP\Domain\Auth\Services\AuthException; use SP\Domain\CustomField\Services\CustomFieldDefService; use SP\Domain\CustomField\Services\CustomFieldTypeService; use SP\Html\DataGrid\DataGridInterface; use SP\Http\JsonResponse; use SP\Infrastructure\Common\Repositories\NoSuchItemException; use SP\Modules\Web\Controllers\Helpers\Grid\CustomFieldGrid; use SP\Modules\Web\Controllers\Traits\JsonTrait; use SP\Modules\Web\Forms\CustomFieldDefForm; use SP\Mvc\Controller\CrudControllerInterface; use SP\Mvc\Controller\ItemTrait; use SP\Mvc\View\Components\SelectItemAdapter; /** * Class CustomFieldController * * @package SP\Modules\Web\Controllers */ final class CustomFieldController extends ControllerBase implements CrudControllerInterface { use JsonTrait, ItemTrait; protected ?CustomFieldDefService $customFieldService = null; /** * Search action * * @return bool * @throws \DI\DependencyException * @throws \DI\NotFoundException * @throws \JsonException * @throws \SP\Core\Exceptions\ConstraintException * @throws \SP\Core\Exceptions\QueryException */ public function searchAction(): bool { if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_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 ); $customFieldGrid = $this->dic->get(CustomFieldGrid::class); return $customFieldGrid->updatePager( $customFieldGrid->getGrid($this->customFieldService->search($itemSearchData)), $itemSearchData ); } /** * @return bool * @throws \DI\DependencyException * @throws \DI\NotFoundException * @throws \JsonException */ public function createAction(): bool { try { if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_CREATE)) { return $this->returnJsonResponse( JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation') ); } $this->view->assign('header', __('New Field')); $this->view->assign('isView', false); $this->view->assign('route', 'customField/saveCreate'); $this->setViewData(); $this->eventDispatcher->notifyEvent( 'show.customField.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 custom field's data * * @param int|null $customFieldId * * @throws ConstraintException * @throws QueryException * @throws NoSuchItemException */ protected function setViewData(?int $customFieldId = null): void { $this->view->addTemplate('custom_field', 'itemshow'); $customField = $customFieldId ? $this->customFieldService->getById($customFieldId) : new CustomFieldDefinitionData(); $this->view->assign('field', $customField); $this->view->assign( 'types', SelectItemAdapter::factory(CustomFieldTypeService::getItemsBasic()) ->getItemsFromModelSelected([$customField->getTypeId()]) ); $this->view->assign( 'modules', SelectItemAdapter::factory(CustomFieldDefService::getFieldModules()) ->getItemsFromArraySelected([$customField->getModuleId()]) ); $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); } } /** * 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::CUSTOMFIELD_EDIT)) { return $this->returnJsonResponse( JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation') ); } $this->view->assign('header', __('Edit Field')); $this->view->assign('isView', false); $this->view->assign('route', 'customField/saveEdit/' . $id); $this->setViewData($id); $this->eventDispatcher->notifyEvent( 'show.customField.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 \DI\DependencyException * @throws \DI\NotFoundException * @throws \JsonException */ public function deleteAction(?int $id = null): bool { try { if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_DELETE)) { return $this->returnJsonResponse( JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation') ); } if ($id === null) { $this->customFieldService ->deleteByIdBatch($this->getItemsIdFromRequest($this->request)); $this->eventDispatcher->notifyEvent( 'delete.customField.selection', new Event( $this, EventMessage::factory() ->addDescription(__u('Fields deleted')) ) ); return $this->returnJsonResponse( JsonResponse::JSON_SUCCESS, __u('Fields deleted') ); } $this->customFieldService->delete($id); $this->eventDispatcher->notifyEvent( 'delete.customField', new Event($this) ); return $this->returnJsonResponse( JsonResponse::JSON_SUCCESS, __u('Field 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::CUSTOMFIELD_CREATE)) { return $this->returnJsonResponse( JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation') ); } $form = new CustomFieldDefForm($this->dic); $form->validateFor(ActionsInterface::CUSTOMFIELD_CREATE, null); $itemData = $form->getItemData(); $this->customFieldService->create($itemData); $this->eventDispatcher->notifyEvent( 'create.customField', new Event( $this, EventMessage::factory() ->addDescription(__u('Field added')) ->addDetail(__u('Field'), $itemData->getName()) ) ); return $this->returnJsonResponse( JsonResponse::JSON_SUCCESS, __u('Field 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::CUSTOMFIELD_EDIT)) { return $this->returnJsonResponse( JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation') ); } $form = new CustomFieldDefForm($this->dic, $id); $form->validateFor(ActionsInterface::CUSTOMFIELD_EDIT, null); $itemData = $form->getItemData(); $this->customFieldService->update($itemData); $this->eventDispatcher->notifyEvent( 'edit.customField', new Event( $this, EventMessage::factory() ->addDescription(__u('Field updated')) ->addDetail(__u('Field'), $itemData->getName()) ) ); return $this->returnJsonResponse( JsonResponse::JSON_SUCCESS, __u('Field 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 \DI\DependencyException * @throws \DI\NotFoundException * @throws \JsonException */ public function viewAction(int $id): bool { try { if (!$this->acl->checkUserAccess(ActionsInterface::CUSTOMFIELD_VIEW)) { return $this->returnJsonResponse( JsonResponse::JSON_ERROR, __u('You don\'t have permission to do this operation') ); } $this->view->assign('header', __('View Field')); $this->view->assign('isView', true); $this->setViewData($id); $this->eventDispatcher->notifyEvent( 'show.customField', new Event($this) ); } catch (Exception $e) { processException($e); $this->eventDispatcher->notifyEvent( 'exception', new Event($e) ); return $this->returnJsonResponse( JsonResponse::JSON_ERROR, $e->getMessage() ); } return $this->returnJsonResponseData(['html' => $this->render()]); } /** * Initialize class * * @throws AuthException * @throws DependencyException * @throws NotFoundException * @throws SessionTimeout */ protected function initialize(): void { $this->checkLoggedIn(); $this->customFieldService = $this->dic->get(CustomFieldDefService::class); } }