ilDclTableViewGUI: ilDclTableViewEditGUI More...

Collaboration diagram for ilDclTableViewGUI:

Public Member Functions
	__construct (ilDclTableListGUI $a_parent_obj, int $table_id=0)
	Constructor. More...

	executeCommand ()

	getParentObj ()

	show ()

	confirmDeleteTableviews ()
	Confirm deletion of multiple fields. More...

	checkViewsLeft (int $delete_count)
	redirects if there are no tableviews left after deletion of {$delete_count} tableviews More...

	saveTableViewOrder ()
	invoked by ilDclTableViewTableGUI More...

Protected Member Functions
	checkAccess ()

	getItems ()

	getActions (ilDclTableView $tableview)

	deleteTableviews ()

Protected Attributes
ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$renderer

ilCtrl	$ctrl

ilLanguage	$lng

ilToolbarGUI	$toolbar

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

ilDclTable	$table

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ilDclTableListGUI	$parent_obj

Detailed Description

ilDclTableViewGUI: ilDclTableViewEditGUI

Definition at line 26 of file class.ilDclTableViewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclTableViewGUI::__construct	(	ilDclTableListGUI	$a_parent_obj,
		int	$table_id = `0`
	)

Constructor.

Parameters

ilDclTableListGUI	$a_parent_obj
int	$table_id

Definition at line 45 of file class.ilDclTableViewGUI.php.

References $DIC, checkAccess(), ILIAS\Repository\ctrl(), ilDclCache\getTableCache(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), renderer(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

     {
         global $DIC;
 
         $locator = $DIC['ilLocator'];
         $this->parent_obj = $a_parent_obj;
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->tabs = $DIC->tabs();
         $this->toolbar = $DIC->toolbar();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->ui_factory = $DIC->ui()->factory();
         $this->renderer = $DIC->ui()->renderer();
 
         $DIC->help()->setScreenId('dcl_views');
 
         if ($table_id == 0) {
             $table_id = $this->http->wrapper()->query()->retrieve('table_id', $this->refinery->kindlyTo()->int());
         }
 
         $this->table = ilDclCache::getTableCache($table_id);
 
         $this->ctrl->saveParameterByClass('ilDclTableEditGUI', 'table_id');
         $locator->addItem($this->table->getTitle(), $this->ctrl->getLinkTargetByClass('ilDclTableEditGUI', 'edit'));
         $this->tpl->setLocator();
 
         if (!$this->checkAccess()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
             $this->ctrl->redirectByClass(ilDclRecordListGUI::class, 'listRecords');
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkAccess()

ilDclTableViewGUI::checkAccess ( )

protected

Definition at line 115 of file class.ilDclTableViewGUI.php.

References ilObjDataCollectionAccess\hasAccessToEditTable().

Referenced by __construct().

                                     : bool
     {
         return ilObjDataCollectionAccess::hasAccessToEditTable(
             $this->parent_obj->getDataCollectionObject()->getRefId(),
             $this->table->getId()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkViewsLeft()

ilDclTableViewGUI::checkViewsLeft ( int $delete_count )

redirects if there are no tableviews left after deletion of {$delete_count} tableviews

Parameters

$delete_count number of tableviews to delete

Definition at line 246 of file class.ilDclTableViewGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by confirmDeleteTableviews().

                                                      : void
     {
         if ($delete_count >= count($this->table->getTableViews())) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('dcl_msg_tableviews_delete_all'), true);
             $this->ctrl->redirect($this, 'show');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteTableviews()

ilDclTableViewGUI::confirmDeleteTableviews ( )

Confirm deletion of multiple fields.

Definition at line 196 of file class.ilDclTableViewGUI.php.

References checkViewsLeft(), ILIAS\Repository\ctrl(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

                                              : void
     {
         //at least one view must exist
         $has_dcl_tableview_ids = $this->http->wrapper()->post()->has('dcl_tableview_ids');
         if (!$has_dcl_tableview_ids) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('dcl_delete_views_no_selection'), true);
             $this->ctrl->redirect($this, 'show');
         }
 
         $tableviews = $this->http->wrapper()->post()->retrieve(
             'dcl_tableview_ids',
             $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
         );
         $this->checkViewsLeft(count($tableviews));
 
         $this->tabs->clearSubTabs();
         $conf = new ilConfirmationGUI();
         $conf->setFormAction($this->ctrl->getFormAction($this));
         $conf->setHeaderText($this->lng->txt('dcl_tableviews_confirm_delete'));
 
         foreach ($tableviews as $tableview_id) {
             $conf->addItem('dcl_tableview_ids[]', (string) $tableview_id, ilDclTableView::find($tableview_id)->getTitle());
         }
         $conf->setConfirm($this->lng->txt('delete'), 'deleteTableviews');
         $conf->setCancel($this->lng->txt('cancel'), 'show');
         $this->tpl->setContent($conf->getHTML());
     }

Here is the call graph for this function:

◆ deleteTableviews()

ilDclTableViewGUI::deleteTableviews ( )

protected

Definition at line 224 of file class.ilDclTableViewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                          : void
     {
         $has_dcl_tableview_ids = $this->http->wrapper()->post()->has('dcl_tableview_ids');
         if ($has_dcl_tableview_ids) {
             $tableviews = $this->http->wrapper()->post()->retrieve(
                 'dcl_tableview_ids',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
             foreach ($tableviews as $tableview_id) {
                 ilDclTableView::find($tableview_id)->delete();
             }
         }
 
         $this->table->sortTableViews();
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('dcl_msg_tableviews_deleted'), true);
         $this->ctrl->redirect($this, 'show');
     }

Here is the call graph for this function:

◆ executeCommand()

ilDclTableViewGUI::executeCommand ( )

Definition at line 79 of file class.ilDclTableViewGUI.php.

References ILIAS\Repository\ctrl(), ilDclTableView\findOrGetInstance(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                     : void
     {
         $this->ctrl->saveParameter($this, 'table_id');
         $cmd = $this->ctrl->getCmd("show");
         $next_class = $this->ctrl->getNextClass($this);
 
         switch ($next_class) {
             case strtolower(ilDclTableViewEditGUI::class):
                 if ($this->http->wrapper()->query()->has('tableview_id')) {
                     $tableview_id = $this->http->wrapper()->query()->retrieve(
                         'tableview_id',
                         $this->refinery->kindlyTo()->int()
                     );
                 } else {
                     $tableview_id = 0;
                 }
 
                 $edit_gui = new ilDclTableViewEditGUI(
                     $this,
                     $this->table,
                     ilDclTableView::findOrGetInstance($tableview_id)
                 );
                 $this->ctrl->saveParameter($edit_gui, 'tableview_id');
                 $this->ctrl->forwardCommand($edit_gui);
                 break;
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getActions()

ilDclTableViewGUI::getActions ( ilDclTableView $tableview )

protected

Returns: Shy[]

Definition at line 173 of file class.ilDclTableViewGUI.php.

References ILIAS\Repository\ctrl(), ilDclTableView\getId(), and ILIAS\Repository\lng().

Referenced by getItems().

                                                             : array
     {
         $this->ctrl->setParameterByClass(ilDclTableViewEditGUI::class, 'tableview_id', $tableview->getId());
 
         $actions = [];
         $actions[] = $this->ui_factory->button()->shy(
             $this->lng->txt('edit'),
             $this->ctrl->getLinkTargetByClass(ilDclTableViewEditGUI::class, 'editGeneralSettings')
         );
         $actions[] = $this->ui_factory->button()->shy(
             $this->lng->txt('copy'),
             $this->ctrl->getLinkTargetByClass(ilDclTableViewEditGUI::class, 'copy')
         );
         $actions[] = $this->ui_factory->button()->shy(
             $this->lng->txt('delete'),
             $this->ctrl->getLinkTargetByClass(ilDclTableViewEditGUI::class, 'confirmDelete')
         );
         return $actions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItems()

ilDclTableViewGUI::getItems ( )

protected

Definition at line 150 of file class.ilDclTableViewGUI.php.

References ILIAS\Repository\ctrl(), and getActions().

Referenced by show().

                                  : array
     {
         $items = [];
         foreach ($this->table->getTableViews() as $tableview) {
 
             $this->ctrl->setParameterByClass(ilDclTableViewEditGUI::class, 'tableview_id', $tableview->getId());
             $item = $this->ui_factory->item()->standard(
                 $this->ui_factory->link()->standard(
                     $tableview->getTitle(),
                     $this->ctrl->getLinkTargetByClass(ilDclTableViewEditGUI::class, 'show')
                 )
             )
                 ->withDescription($tableview->getDescription())
                 ->withActions($this->ui_factory->dropdown()->standard($this->getActions($tableview)));
 
             $items[] = $item;
         }
         return $items;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParentObj()

ilDclTableViewGUI::getParentObj ( )

Definition at line 110 of file class.ilDclTableViewGUI.php.

References $parent_obj.

                                   : ilDclTableListGUI
     {
         return $this->parent_obj;
     }

◆ saveTableViewOrder()

ilDclTableViewGUI::saveTableViewOrder ( )

invoked by ilDclTableViewTableGUI

Definition at line 257 of file class.ilDclTableViewGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                         : void
     {
         $orders = $this->http->wrapper()->post()->retrieve(
             'order',
             $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->string())
         );
         asort($orders);
         $tableviews = [];
         foreach (array_keys($orders) as $tableview_id) {
             $tableviews[] = ilDclTableView::find($tableview_id);
         }
         $this->table->sortTableViews($tableviews);
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('dcl_msg_tableviews_order_updated'));
         $this->ctrl->redirect($this);
     }

Here is the call graph for this function:

◆ show()

ilDclTableViewGUI::show ( )

Definition at line 123 of file class.ilDclTableViewGUI.php.

References ILIAS\Repository\ctrl(), getItems(), ILIAS\Repository\lng(), renderer(), and ILIAS\Repository\toolbar().

                           : void
     {
         $add_new = $this->ui_factory->button()->primary(
             $this->lng->txt("dcl_add_new_view"),
             $this->ctrl->getLinkTargetByClass(ilDclTableViewEditGUI::class, 'add')
         );
         $this->toolbar->addStickyItem($add_new);
 
         $this->toolbar->addSeparator();
 
         $switcher = new ilDclSwitcher($this->toolbar, $this->ui_factory, $this->ctrl, $this->lng);
         $switcher->addTableSwitcherToToolbar(
             $this->parent_obj->getDataCollectionObject()->getTables(),
             self::class,
             'show'
         );
 
         $this->tpl->setContent(
             $this->renderer->render(
                 $this->ui_factory->panel()->listing()->standard(
                     sprintf($this->lng->txt('dcl_tableviews_of_X'), $this->table->getTitle()),
                     [$this->ui_factory->item()->group('', $this->getItems())]
                 )
             )
         );
     }