ilDclTableListGUI: ilDclFieldListGUI, ilDclFieldEditGUI, ilDclTableViewGUI, ilDclTableEditGUI More...

Collaboration diagram for ilDclTableListGUI:

Public Member Functions
	__construct (ilObjDataCollectionGUI $a_parent_obj)

	getObjId ()

	getRefId ()

	executeCommand ()
	execute command More...

	listTables ()

	getDataCollectionObject ()

Protected Member Functions
	getItems ()

	getActions (ilDclTable $table)

	setTabs (string $active)

	save ()

	checkAccess ()

Protected Attributes
ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$renderer

ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

ilToolbarGUI	$toolbar

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ilObjDataCollectionGUI	$parent_obj

Detailed Description

ilDclTableListGUI: ilDclFieldListGUI, ilDclFieldEditGUI, ilDclTableViewGUI, ilDclTableEditGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilDclTableListGUI::__construct ( ilObjDataCollectionGUI $a_parent_obj )

Definition at line 39 of file class.ilDclTableListGUI.php.

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

     {
         global $DIC;
         $main_tpl = $DIC->ui()->mainTemplate();
         $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();
 
         $this->tabs->setSetupMode(true);
         $DIC->help()->setScreenId('dcl_tables');
 
         $this->parent_obj = $a_parent_obj;
 
         if (!$this->checkAccess()) {
             $main_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()

ilDclTableListGUI::checkAccess ( )

protected

Definition at line 268 of file class.ilDclTableListGUI.php.

References $ref_id, and ilObjDataCollectionAccess\hasWriteAccess().

Referenced by __construct().

                                     : bool
     {
         $ref_id = $this->parent_obj->getRefId();
 
         return ilObjDataCollectionAccess::hasWriteAccess($ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilDclTableListGUI::executeCommand ( )

execute command

Definition at line 77 of file class.ilDclTableListGUI.php.

References $DIC, $ref_id, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), setTabs(), and ILIAS\Repository\tabs().

                                     : void
     {
         global $DIC;
         $cmd = $this->ctrl->getCmd('listTables');
 
         $next_class = $this->ctrl->getNextClass($this);
 
         $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
 
         switch ($next_class) {
             case 'ildcltableeditgui':
                 $this->tabs->clearTargets();
                 if ($cmd != 'create') {
                     $this->setTabs('settings');
                 } else {
                     $this->tabs->setBackTarget(
                         $this->lng->txt('back'),
                         $this->ctrl->getLinkTarget($this, 'listTables')
                     );
                 }
                 $ilDclTableEditGUI = new ilDclTableEditGUI($this);
                 $this->ctrl->forwardCommand($ilDclTableEditGUI);
                 break;
 
             case 'ildclfieldlistgui':
                 $this->tabs->clearTargets();
                 $this->setTabs('fields');
                 $ilDclFieldListGUI = new ilDclFieldListGUI($this);
                 $this->ctrl->forwardCommand($ilDclFieldListGUI);
                 break;
 
             case "ildclfieldeditgui":
                 $this->tabs->clearTargets();
                 $this->setTabs("fields");
                 $ilDclFieldEditGUI = new ilDclFieldEditGUI($this);
                 $this->ctrl->forwardCommand($ilDclFieldEditGUI);
                 break;
 
             case 'ildcltableviewgui':
                 $this->tabs->clearTargets();
                 $this->setTabs('tableviews');
                 $ilDclTableViewGUI = new ilDclTableViewGUI($this);
                 $this->ctrl->forwardCommand($ilDclTableViewGUI);
                 break;
 
             default:
                 $this->ctrl->clearParameterByClass(ilObjDataCollectionGUI::class, 'table_id');
                 $this->$cmd();
         }
     }

Here is the call graph for this function:

◆ getActions()

ilDclTableListGUI::getActions ( ilDclTable $table )

protected

Returns: Shy[]

Definition at line 181 of file class.ilDclTableListGUI.php.

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

Referenced by getItems().

                                                     : array
     {
         $this->ctrl->setParameterByClass(ilObjDataCollectionGUI::class, 'table_id', $table->getId());
 
         $actions = [];
         $actions[] = $this->ui_factory->button()->shy(
             $this->lng->txt('settings'),
             $this->ctrl->getLinkTargetByClass(ilDclTableEditGUI::class, 'edit'),
         );
 
         $actions[] = $this->ui_factory->button()->shy(
             $this->lng->txt('dcl_list_fields'),
             $this->ctrl->getLinkTargetByClass(ilDclFieldListGUI::class, 'listFields')
         );
 
         $actions[] = $this->ui_factory->button()->shy(
             $this->lng->txt('dcl_tableviews'),
             $this->ctrl->getLinkTargetByClass(ilDclTableViewGUI::class, 'show')
         );
 
         $actions[] = $this->ui_factory->button()->shy(
             $this->lng->txt('delete'),
             $this->ctrl->getLinkTargetByClass(ilDclTableEditGUI::class, 'confirmDelete')
         );
 
         if ($table->getOrder() !== 10) {
             $actions[] = $this->ui_factory->button()->shy(
                 $this->lng->txt('set_as_default'),
                 $this->ctrl->getLinkTargetByClass(ilDclTableEditGUI::class, 'setAsDefault')
             );
         }
 
         return $actions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDataCollectionObject()

ilDclTableListGUI::getDataCollectionObject ( )

Definition at line 275 of file class.ilDclTableListGUI.php.

                                              : ilObjDataCollection
     {
         return $this->parent_obj->getDataCollectionObject();
     }

◆ getItems()

ilDclTableListGUI::getItems ( )

protected

Definition at line 147 of file class.ilDclTableListGUI.php.

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

Referenced by listTables().

                                  : array
     {
         $items = [];
         foreach ($this->parent_obj->getDataCollectionObject()->getTables() as $table) {
 
             $this->ctrl->setParameterByClass(ilObjDataCollectionGUI::class, 'table_id', $table->getId());
             $item = $this->ui_factory->item()->standard(
                 $this->ui_factory->link()->standard(
                     $table->getTitle(),
                     $this->ctrl->getLinkTargetByClass(ilDclFieldListGUI::class, 'listFields')
                 )
             )
                 ->withProperties([
                     $this->lng->txt('visible') => $this->lng->txt($table->getIsVisible() ? 'yes' : 'no'),
                     $this->lng->txt('comments') => $this->lng->txt($table->getPublicCommentsEnabled() ? 'active' : 'inactive')
                 ])
                 ->withActions(
                     $this->ui_factory->dropdown()->standard(
                         $this->getActions($table)
                     )
                 );
 
             if ($table->getOrder() === 10) {
                 $item = $item->withDescription($this->lng->txt('default'));
             }
             $items[] = $item;
         }
         return $items;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilDclTableListGUI::getObjId ( )

Definition at line 64 of file class.ilDclTableListGUI.php.

Referenced by ilDclFieldListGUI\__construct(), ilDclFieldEditGUI\__construct(), and ilDclTableEditGUI\__construct().

                               : int
     {
         return $this->parent_obj->getObjectId();
     }

Here is the caller graph for this function:

◆ getRefId()

ilDclTableListGUI::getRefId ( )

Definition at line 69 of file class.ilDclTableListGUI.php.

                               : int
     {
         return $this->parent_obj->getRefId();
     }

◆ listTables()

ilDclTableListGUI::listTables ( )

Definition at line 128 of file class.ilDclTableListGUI.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_table"),
             $this->ctrl->getLinkTargetByClass('ilDclTableEditGUI', 'create')
         );
         $this->toolbar->addStickyItem($add_new);
 
         $this->tpl->setContent(
             $this->renderer->render(
                 $this->ui_factory->panel()->listing()->standard(
                     $this->lng->txt('dcl_tables'),
                     [$this->ui_factory->item()->group('', $this->getItems())]
                 )
             )
         );
     }

Here is the call graph for this function:

◆ save()

ilDclTableListGUI::save ( )

protected

Definition at line 237 of file class.ilDclTableListGUI.php.

References $comments, ILIAS\Repository\ctrl(), ilDclCache\getTableCache(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                              : void
     {
         if ($this->http->wrapper()->post()->has("comments")) {
             $comments = $this->http->wrapper()->post()->retrieve(
                 'comments',
                 $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->string())
             );
         }
         if ($this->http->wrapper()->post()->has("visible")) {
             $visible = $this->http->wrapper()->post()->retrieve(
                 'visible',
                 $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->string())
             );
         }
         $orders = $this->http->wrapper()->post()->retrieve(
             'order',
             $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->string())
         );
         asort($orders);
         $order = 10;
         foreach (array_keys($orders) as $table_id) {
             $table = ilDclCache::getTableCache($table_id);
             $table->setOrder($order);
             $table->setPublicCommentsEnabled(isset($comments[$table_id]));
             $table->setIsVisible(isset($visible[$table_id]));
             $table->doUpdate();
             $order += 10;
         }
         $this->ctrl->redirect($this);
     }

Here is the call graph for this function:

◆ setTabs()

ilDclTableListGUI::setTabs ( string $active )

protected

Definition at line 216 of file class.ilDclTableListGUI.php.

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

Referenced by executeCommand().

                                               : void
     {
         $this->tabs->setBackTarget($this->lng->txt('dcl_tables'), $this->ctrl->getLinkTarget($this, 'listTables'));
         $this->tabs->addTab(
             'settings',
             $this->lng->txt('settings'),
             $this->ctrl->getLinkTargetByClass('ilDclTableEditGUI', 'edit')
         );
         $this->tabs->addTab(
             'fields',
             $this->lng->txt('dcl_list_fields'),
             $this->ctrl->getLinkTargetByClass('ilDclFieldListGUI', 'listFields')
         );
         $this->tabs->addTab(
             'tableviews',
             $this->lng->txt('dcl_tableviews'),
             $this->ctrl->getLinkTargetByClass('ilDclTableViewGUI')
         );
         $this->tabs->activateTab($active);
     }