. */ namespace SP\Modules\Web\Controllers\Helpers\Grid; use SP\Core\Acl\Acl; use SP\Core\Acl\ActionsInterface; use SP\Domain\CustomField\Services\CustomFieldDefService; use SP\Html\DataGrid\Action\DataGridAction; use SP\Html\DataGrid\Action\DataGridActionSearch; use SP\Html\DataGrid\Action\DataGridActionType; use SP\Html\DataGrid\DataGridData; use SP\Html\DataGrid\DataGridInterface; use SP\Html\DataGrid\DataGridTab; use SP\Html\DataGrid\Layout\DataGridHeader; use SP\Infrastructure\Database\QueryResult; /** * Class CustomFieldGrid * * @package SP\Modules\Web\Controllers\Helpers\Grid */ final class CustomFieldGrid extends GridBase { private ?QueryResult $queryResult = null; /** * @param QueryResult $queryResult * * @return DataGridInterface */ public function getGrid(QueryResult $queryResult): DataGridInterface { $this->queryResult = $queryResult; $grid = $this->getGridLayout(); $searchAction = $this->getSearchAction(); $grid->addDataAction($searchAction); $grid->setPager($this->getPager($searchAction)); $grid->addDataAction($this->getCreateAction()); $grid->addDataAction($this->getEditAction()); $grid->addDataAction($this->getDeleteAction()); $grid->addDataAction( $this->getDeleteAction() ->setName(__('Delete Selected')) ->setTitle(__('Delete Selected')) ->setIsSelection(true), true); $grid->setTime(round(getElapsedTime($this->queryTimeStart), 5)); return $grid; } /** * @return DataGridInterface */ protected function getGridLayout(): DataGridInterface { // Grid $gridTab = new DataGridTab($this->view->getTheme()); $gridTab->setId('tblCustomFields'); $gridTab->setDataRowTemplate('datagrid-rows', 'grid'); $gridTab->setDataPagerTemplate('datagrid-nav-full', 'grid'); $gridTab->setHeader($this->getHeader()); $gridTab->setData($this->getData()); $gridTab->setTitle(__('Custom Fields')); return $gridTab; } /** * @return DataGridHeader */ protected function getHeader(): DataGridHeader { // Grid Header $gridHeader = new DataGridHeader(); $gridHeader->addHeader(__('Name')); $gridHeader->addHeader(__('Module')); $gridHeader->addHeader(__('Type')); $gridHeader->addHeader(__('Properties')); return $gridHeader; } /** * @return DataGridData */ protected function getData(): DataGridData { // Grid Data $gridData = new DataGridData(); $gridData->setDataRowSourceId('id'); $gridData->addDataRowSource('name'); $gridData->addDataRowSource( 'moduleId', false, function ($value) { return CustomFieldDefService::getFieldModuleById($value); } ); $gridData->addDataRowSource('typeName'); $gridData->addDataRowSourceWithIcon( 'isEncrypted', $this->icons->getIconEditPass()->setTitle(__('Encrypted')) ); $gridData->setData($this->queryResult); return $gridData; } /** * @return DataGridActionSearch */ private function getSearchAction(): DataGridActionSearch { // Grid Actions $gridActionSearch = new DataGridActionSearch(); $gridActionSearch->setId(ActionsInterface::CUSTOMFIELD_SEARCH); $gridActionSearch->setType(DataGridActionType::SEARCH_ITEM); $gridActionSearch->setName('frmSearchCustomField'); $gridActionSearch->setTitle(__('Search for Field')); $gridActionSearch->setOnSubmitFunction('appMgmt/search'); $gridActionSearch->addData( 'action-route', Acl::getActionRoute(ActionsInterface::CUSTOMFIELD_SEARCH) ); return $gridActionSearch; } /** * @return DataGridAction */ private function getCreateAction(): DataGridAction { $gridAction = new DataGridAction(); $gridAction->setId(ActionsInterface::CUSTOMFIELD_CREATE); $gridAction->setType(DataGridActionType::MENUBAR_ITEM); $gridAction->setName(__('New Field')); $gridAction->setTitle(__('New Field')); $gridAction->setIcon($this->icons->getIconAdd()); $gridAction->setSkip(true); $gridAction->setOnClickFunction('appMgmt/show'); $gridAction->addData( 'action-route', Acl::getActionRoute(ActionsInterface::CUSTOMFIELD_CREATE) ); return $gridAction; } /** * @return DataGridAction */ private function getEditAction(): DataGridAction { $gridAction = new DataGridAction(); $gridAction->setId(ActionsInterface::CUSTOMFIELD_EDIT); $gridAction->setType(DataGridActionType::EDIT_ITEM); $gridAction->setName(__('Edit Field')); $gridAction->setTitle(__('Edit Field')); $gridAction->setIcon($this->icons->getIconEdit()); $gridAction->setOnClickFunction('appMgmt/show'); $gridAction->addData( 'action-route', Acl::getActionRoute(ActionsInterface::CUSTOMFIELD_EDIT) ); return $gridAction; } /** * @return DataGridAction */ private function getDeleteAction(): DataGridAction { $gridAction = new DataGridAction(); $gridAction->setId(ActionsInterface::CUSTOMFIELD_DELETE); $gridAction->setType(DataGridActionType::DELETE_ITEM); $gridAction->setName(__('Delete Field')); $gridAction->setTitle(__('Delete Field')); $gridAction->setIcon($this->icons->getIconDelete()); $gridAction->setOnClickFunction('appMgmt/delete'); $gridAction->addData( 'action-route', Acl::getActionRoute(ActionsInterface::CUSTOMFIELD_DELETE) ); return $gridAction; } }