Class ilContainerStartObjectsGUI. More...

Collaboration diagram for ilContainerStartObjectsGUI:

Public Member Functions
	__construct (ilObject $a_parent_obj)

	executeCommand ()

	setTabs (string $a_active="manage")

	askDeleteStarter (array $start_obj_ids)

	addStarter (array $selected_ref_ids)

Protected Member Functions
	checkPermission (string $a_cmd)

	listStructureObject ()

	buildObjectsTable ()

	saveSortingObject ()

	deleteStarterObject ()

	selectStarterObject ()

	buildPossibleObjectsTable ()

Protected Attributes
ilCtrl	$ctrl

ilTabsGUI	$tabs_gui

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

UIFactory	$ui_factory

ilObject	$object

ilContainerStartObjects	$start_object

StandardGUIRequest	$request

ILIAS Style Content GUIService	$content_style_gui

ILIAS Style Content Object ObjectFacade	$content_style_domain

Detailed Description

Class ilContainerStartObjectsGUI.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilContainerStartObjectsGUI: ilContainerStartObjectsPageGUI

Definition at line 31 of file class.ilContainerStartObjectsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilContainerStartObjectsGUI::__construct ( ilObject $a_parent_obj )

Definition at line 47 of file class.ilContainerStartObjectsGUI.php.

References $DIC, $lng, $tpl, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObject\getRefId(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\Repository\settings(), and ILIAS\Repository\toolbar().

     {
         global $DIC;
 
         $this->access = $DIC->access();
         $this->settings = $DIC->settings();
         $this->toolbar = $DIC->toolbar();
         $this->ui_factory = $DIC->ui()->factory();
         $ilCtrl = $DIC->ctrl();
         $ilTabs = $DIC->tabs();
         $lng = $DIC->language();
         $tpl = $DIC["tpl"];
 
         $this->ctrl = $ilCtrl;
         $this->tabs_gui = $ilTabs;
         $this->lng = $lng;
         $this->tpl = $tpl;
         $this->object = $a_parent_obj;
 
         $this->start_object = new ilContainerStartObjects(
             $this->object->getRefId(),
             $this->object->getId()
         );
 
         $this->request = $DIC->container()
             ->internal()
             ->gui()
             ->standardRequest();
 
         $this->lng->loadLanguageModule("crs");
         $cs = $DIC->contentStyle();
         $this->content_style_domain = $cs->domain()->styleForRefId($a_parent_obj->getRefId());
         $this->content_style_gui = $cs->gui();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addStarter()

ilContainerStartObjectsGUI::addStarter ( array $selected_ref_ids )

Parameters

int[] $selected_ref_ids

Definition at line 287 of file class.ilContainerStartObjectsGUI.php.

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

                                                        : void
     {
         $this->checkPermission('write');
 
         if (count($selected_ref_ids) === 0) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, "selectStarter");
         }
 
         $added = 0;
         foreach ($selected_ref_ids as $item_ref_id) {
             if (!$this->start_object->exists($item_ref_id)) {
                 ++$added;
                 $this->start_object->add($item_ref_id);
             }
         }
         if ($added) {
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('crs_added_starters'), true);
             $this->ctrl->redirect($this, "listStructure");
         } else {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('crs_starters_already_assigned'), true);
             $this->ctrl->redirect($this, "selectStarter");
         }
     }

Here is the call graph for this function:

◆ askDeleteStarter()

ilContainerStartObjectsGUI::askDeleteStarter ( array $start_obj_ids )

Parameters

int[] $start_obj_ids

Definition at line 212 of file class.ilContainerStartObjectsGUI.php.

References ilObject\_getIcon(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and setTabs().

                                                           : void
     {
         if (count($start_obj_ids) === 0) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, "listStructure");
         }
 
         $this->checkPermission('write');
         $this->setTabs();
 
         // display confirmation message
         $cgui = new ilConfirmationGUI();
         $cgui->setFormAction($this->ctrl->getFormAction($this, "listStructure"));
         $cgui->setHeaderText($this->lng->txt("crs_starter_delete_sure"));
         $cgui->setCancel($this->lng->txt("cancel"), "listStructure");
         $cgui->setConfirm($this->lng->txt("remove"), "deleteStarter");
 
         // list objects that should be deleted
         $all = $this->start_object->getStartObjects();
         foreach ($start_obj_ids as $starter_id) {
             $obj_id = ilObject::_lookupObjId($all[$starter_id]["item_ref_id"]);
             $title = ilObject::_lookupTitle($obj_id);
             $icon = ilObject::_getIcon($obj_id, "tiny");
             $alt = $this->lng->txt('obj_' . ilObject::_lookupType($obj_id));
             $cgui->addItem("starter[]", (string) $starter_id, $title, $icon, $alt);
         }
 
         $this->tpl->setContent($cgui->getHTML());
     }

Here is the call graph for this function:

◆ buildObjectsTable()

ilContainerStartObjectsGUI::buildObjectsTable ( )

protected

Definition at line 180 of file class.ilContainerStartObjectsGUI.php.

References ILIAS\Repository\lng().

Referenced by listStructureObject(), and saveSortingObject().

                                           : TableAdapterGUI
     {
         $builder = new ObjectsTableBuilder(
             $this,
             'listStructure',
             $this->start_object,
             $this->lng,
             $this->ui_factory
         );
         return $builder->getTable();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPossibleObjectsTable()

ilContainerStartObjectsGUI::buildPossibleObjectsTable ( )

protected

Definition at line 272 of file class.ilContainerStartObjectsGUI.php.

References ILIAS\Repository\lng().

Referenced by selectStarterObject().

                                                   : TableAdapterGUI
     {
         $builder = new PossibleObjectsTableBuilder(
             $this,
             'selectStarter',
             $this->start_object,
             $this->lng,
             $this->ui_factory
         );
         return $builder->getTable();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPermission()

ilContainerStartObjectsGUI::checkPermission ( string $a_cmd )

protected

Definition at line 127 of file class.ilContainerStartObjectsGUI.php.

References $access, $ref_id, ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilUtil\redirect().

Referenced by addStarter(), askDeleteStarter(), deleteStarterObject(), executeCommand(), listStructureObject(), and selectStarterObject().

                                                      : void
     {
         $ilAccess = $this->access;
 
         $ref_id = $this->object->getRefId();
         if (!$ilAccess->checkAccess($a_cmd, "", $ref_id)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
             ilUtil::redirect("goto.php?target=" . $this->object->getType() . "_" . $ref_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteStarterObject()

ilContainerStartObjectsGUI::deleteStarterObject ( )

protected

Definition at line 242 of file class.ilContainerStartObjectsGUI.php.

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

                                             : void
     {
         $this->checkPermission('write');
 
         if (count($this->request->getStartObjIds()) === 0) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
         } else {
             foreach ($this->request->getStartObjIds() as $starter_id) {
                 $this->start_object->delete((int) $starter_id);
             }
 
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('crs_starter_deleted'), true);
         }
 
         $this->ctrl->redirect($this, "listStructure");
     }

Here is the call graph for this function:

◆ executeCommand()

ilContainerStartObjectsGUI::executeCommand ( )

Definition at line 82 of file class.ilContainerStartObjectsGUI.php.

References ilPageObject\_exists(), checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilPageObjectGUI\setStyleId().

                                     : void
     {
         switch ($this->ctrl->getNextClass($this)) {
             case "ilcontainerstartobjectspagegui":
                 $this->checkPermission("write");
                 $this->tabs_gui->clearTargets();
                 $this->tabs_gui->setBackTarget(
                     $this->lng->txt("back"),
                     $this->ctrl->getLinkTarget($this, "listStructure")
                 );
 
                 if (!ilContainerStartObjectsPage::_exists("cstr", $this->object->getId())) {
                     // doesn't exist -> create new one
                     $new_page_object = new ilContainerStartObjectsPage();
                     $new_page_object->setParentId($this->object->getId());
                     $new_page_object->setId($this->object->getId());
                     $new_page_object->createFromXML();
                     unset($new_page_object);
                 }
 
                 $this->content_style_gui->addCss(
                     $this->tpl,
                     $this->object->getRefId()
                 );
 
                 $this->ctrl->setReturnByClass("ilcontainerstartobjectspagegui", "edit");
                 $pgui = new ilContainerStartObjectsPageGUI($this->object->getId());
                 $pgui->setStyleId(
                     $this->content_style_domain->getEffectiveStyleId()
                 );
 
                 $ret = $this->ctrl->forwardCommand($pgui);
                 if ($ret) {
                     $this->tpl->setContent($ret);
                 }
                 break;
 
             default:
                 $cmd = $this->ctrl->getCmd("listStructure");
                 $cmd .= "Object";
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ listStructureObject()

ilContainerStartObjectsGUI::listStructureObject ( )

protected

Definition at line 151 of file class.ilContainerStartObjectsGUI.php.

References $ilSetting, $settings, $toolbar, buildObjectsTable(), checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and setTabs().

                                             : void
     {
         $ilToolbar = $this->toolbar;
         $ilSetting = $this->settings;
 
         $this->checkPermission('write');
         $this->setTabs();
 
         $ilToolbar->addButton(
             $this->lng->txt('crs_add_starter'),
             $this->ctrl->getLinkTarget($this, 'selectStarter')
         );
 
         // :TODO: depending on this setting?
         if ($ilSetting->get("enable_cat_page_edit")) {
             $ilToolbar->addButton(
                 $this->lng->txt("cntr_text_media_editor"),
                 $this->ctrl->getLinkTargetByClass("ilContainerStartObjectsPageGUI", "edit")
             );
         }
 
         $table = $this->buildObjectsTable();
         if ($table->handleCommand()) {
             return;
         }
 
         $this->tpl->setContent($table->render());
     }

Here is the call graph for this function:

◆ saveSortingObject()

ilContainerStartObjectsGUI::saveSortingObject ( )

protected

Definition at line 192 of file class.ilContainerStartObjectsGUI.php.

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

                                           : void
     {
         $table = $this->buildObjectsTable();
         $pos = $table->getData();
         if (is_array($pos)) {
             $counter = 0;
             foreach ($pos as $start_id) {
                 $counter += 10;
                 $this->start_object->setObjectPos($start_id, $counter);
             }
 
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('cntr_saved_sorting'), true);
         }
 
         $this->ctrl->redirect($this, "listStructure");
     }

Here is the call graph for this function:

◆ selectStarterObject()

ilContainerStartObjectsGUI::selectStarterObject ( )

protected

Definition at line 259 of file class.ilContainerStartObjectsGUI.php.

References buildPossibleObjectsTable(), checkPermission(), and setTabs().

                                             : void
     {
         $this->checkPermission('write');
         $this->setTabs();
 
         $table = $this->buildPossibleObjectsTable();
         if ($table->handleCommand()) {
             return;
         }
 
         $this->tpl->setContent($table->render());
     }

Here is the call graph for this function:

◆ setTabs()

ilContainerStartObjectsGUI::setTabs ( string $a_active = "manage" )

Definition at line 138 of file class.ilContainerStartObjectsGUI.php.

References $ilSetting, $settings, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by askDeleteStarter(), listStructureObject(), and selectStarterObject().

                                                         : void
     {
         $ilSetting = $this->settings;
 
         $this->tabs_gui->addSubTab(
             "manage",
             $this->lng->txt("cntr_manage"),
             $this->ctrl->getLinkTarget($this, "listStructure")
         );
 
         $this->tabs_gui->activateSubTab($a_active);
     }