ilGuidedTourAdminGUI Class Reference

@ilCtrl_Calls ilGuidedTourAdminGUI: ilGuidedTourPageGUI, ilExportGUI, ilRepoStandardUploadHandlerGUI More...

Collaboration diagram for ilGuidedTourAdminGUI:

Public Member Functions
	__construct (protected \ILIAS\Help\GuidedTour\InternalDataService $data, protected \ILIAS\Help\GuidedTour\InternalDomainService $domain, protected \ILIAS\Help\GuidedTour\InternalGUIService $gui)
	executeCommand ()
	forwardToPageObject ()
	saveTour ()
	saveSettings ()
	saveStep ()
	editStep (int $step_id)
	editPage (int $step_id)
	confirmStepDeletion (int $step_id)
	deleteStep ()

Protected Member Functions
	setSettingsTabs (string $active)
	listTours ()
	getResetTourModal (int $tour_id)
	resetTour ()
	getDeleteTourModal (int $tour_id)
	deleteTour ()
	getCreateForm ()
	addTour ()
	editSettings ()
	getSettingsForm ()
	setStepsHeader ()
	setSingleStepHeader ()
	listSteps ()
	getStepTable ()
	addStep ()
	getStepForm (?Step $step=null)
	setSubTabs (string $active)
	idSettings ()
	getIdForm ()
	saveIdSettings ()
	saveOrder ()
	importTourForm ()
	getImportForm ()
	handleImportUpload (FileUpload $upload, UploadResult $result)
	importTourFile (string $filename, string $path)
	importTour ()

Protected Attributes
ILIAS Help GuidedTour UserFinished UserFinishedManager	$finish_manager
ILIAS Help GuidedTour Tour TourManager	$tm

Private Attributes
ILIAS Help GuidedTour Step StepManager	$step_manager

Detailed Description

@ilCtrl_Calls ilGuidedTourAdminGUI: ilGuidedTourPageGUI, ilExportGUI, ilRepoStandardUploadHandlerGUI

Definition at line 32 of file class.ilGuidedTourAdminGUI.php.

Constructor & Destructor Documentation

__construct()

ilGuidedTourAdminGUI::__construct	(	protected \ILIAS\Help\GuidedTour\InternalDataService	$data,
		protected \ILIAS\Help\GuidedTour\InternalDomainService	$domain,
		protected \ILIAS\Help\GuidedTour\InternalGUIService	$gui
	)

Definition at line 38 of file class.ilGuidedTourAdminGUI.php.

      {
        $ctrl = $this->gui->ctrl();
        $this->tm = $domain->tour();
        $ctrl->saveParameterByClass(self::class, "tour_id");
        $this->step_manager = $domain->step();
        $this->finish_manager = $domain->userFinished();
    }

Member Function Documentation

addStep()

ilGuidedTourAdminGUI::addStep ( )

protected

Definition at line 505 of file class.ilGuidedTourAdminGUI.php.

                                : void
    {
        $this->setSingleStepHeader();
        $mt = $this->gui->ui()->mainTemplate();
        $lng = $this->domain->lng();
        $mt->setOnScreenMessage("info", $lng->txt("gdtr_edit_step_info"));
        $mt->setContent($this->getStepForm()->render());
    }

References $lng, getStepForm(), and setSingleStepHeader().

Here is the call graph for this function:

addTour()

ilGuidedTourAdminGUI::addTour ( )

protected

Definition at line 329 of file class.ilGuidedTourAdminGUI.php.

                                : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $mt->setContent($this->getCreateForm()->render());
    }

References getCreateForm().

Here is the call graph for this function:

confirmStepDeletion()

ilGuidedTourAdminGUI::confirmStepDeletion

(

int

$step_id

)

Definition at line 672 of file class.ilGuidedTourAdminGUI.php.

                                                     : void
    {
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $table = $this->getStepTable();
        $step = $this->step_manager->getById($step_id);
        $ctrl->setParameterByClass(self::class, "step_id", $step_id);
        $title = $this->step_manager->getStepName($step->getType());
        if ($step->getElementId() !== "") {
            $title .= " (" . $step->getElementId() . ")";
        }
        $table->renderDeletionConfirmation(
            $lng->txt("gdtr_delete_step"),
            $lng->txt("gdtr_delete_step_mess"),
            "deleteStep",
            [
                $step_id => $title
            ]
        );
    }

References $lng, and getStepTable().

Here is the call graph for this function:

deleteStep()

ilGuidedTourAdminGUI::deleteStep

(

)

Definition at line 693 of file class.ilGuidedTourAdminGUI.php.

                                : void
    {
        $ctrl = $this->gui->ctrl();
        $mt = $this->gui->ui()->mainTemplate();
        $lng = $this->domain->lng();
        $tour_id = $this->gui->standardRequest()->getTourId();
        $step_id = $this->gui->standardRequest()->getStepId();
 
        $this->step_manager->delete($tour_id, $step_id);
        $mt->setOnScreenMessage("success", $lng->txt("gdtr_deleted_step"), true);
        $ctrl->redirectByClass(self::class, "listSteps");
    }

References $lng.

deleteTour()

ilGuidedTourAdminGUI::deleteTour ( )

protected

Definition at line 310 of file class.ilGuidedTourAdminGUI.php.

                                   : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $tour_id = $this->gui->standardRequest()->getTourId();
        $this->tm->deleteTour($tour_id);
        $mt->setOnScreenMessage("success", $lng->txt("gdtr_deleted_tour"), true);
        $ctrl->redirectByClass(self::class, "listTours");
    }

References $lng.

editPage()

ilGuidedTourAdminGUI::editPage

(

int

$step_id

)

Definition at line 593 of file class.ilGuidedTourAdminGUI.php.

                                          : void
    {
        $ctrl = $this->gui->ctrl();
        $ctrl->setParameterByClass(self::class, "step_id", $step_id);
        $ctrl->redirectByClass(ilGuidedTourPageGUI::class, "edit");
    }

editSettings()

ilGuidedTourAdminGUI::editSettings ( )

protected

Definition at line 351 of file class.ilGuidedTourAdminGUI.php.

                                     : void
    {
        $this->setStepsHeader();
        $this->setSettingsTabs("settings");
        $mt = $this->gui->ui()->mainTemplate();
        $mt->setContent($this->getSettingsForm()->render());
    }

References getSettingsForm(), setSettingsTabs(), and setStepsHeader().

Here is the call graph for this function:

editStep()

ilGuidedTourAdminGUI::editStep

(

int

$step_id

)

Definition at line 580 of file class.ilGuidedTourAdminGUI.php.

                                          : void
    {
        $mt = $this->gui->mainTemplate();
        $lng = $this->domain->lng();
        $this->setSingleStepHeader();
        $mt->setOnScreenMessage("info", $lng->txt("gdtr_edit_step_info"));
        $ctrl = $this->gui->ctrl();
        $ctrl->setParameterByClass(self::class, "step_id", $step_id);
        $step = $this->step_manager->getById($step_id);
        $form = $this->getStepForm($step);
        $mt->setContent($form->render());
    }

References $lng, getStepForm(), and setSingleStepHeader().

Here is the call graph for this function:

executeCommand()

ilGuidedTourAdminGUI::executeCommand

(

)

Definition at line 50 of file class.ilGuidedTourAdminGUI.php.

                                    : void
    {
        $ctrl = $this->gui->ctrl();
        $mt = $this->gui->ui()->mainTemplate();
 
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("listTours");
 
        switch ($next_class) {
            case strtolower(ilExportGUI::class):
                $this->setStepsHeader();
                $this->setSettingsTabs("export");
                $tour_id = $this->gui->standardRequest()->getTourId();
                $exp_gui = new ilExportGUI($this->gui->objectGUI($tour_id));
                $exp_gui->addFormat("xml");
                $ctrl->forwardCommand($exp_gui);
                break;
 
            case strtolower(ilGuidedTourPageGUI::class):
                $mt = $this->gui->mainTemplate();
                $lng = $this->domain->lng();
                $this->setStepsHeader();
                $mt->setOnScreenMessage("info", $lng->txt("gdtr_edit_page_info"));
                $ctrl->setReturnByClass(self::class, "listSteps");
                $ctrl->saveParameterByClass(self::class, "step_id");
                $ret = $this->forwardToPageObject();
                $mt->setContent($ret);
                break;
 
            case strtolower(ilRepoStandardUploadHandlerGUI::class):
                $form = $this->getImportForm();
                $gui = $form->getRepoStandardUploadHandlerGUI("import");
                $ctrl->forwardCommand($gui);
                break;
 
            default:
                if (in_array($cmd, [
                    "listTours",
                    "addTour",
                    "saveTour",
                    "deleteTour",
                    "listSteps",
                    "addStep",
                    "saveStep",
                    "tableCommand",
                    "editStep",
                    "editPage",
                    "editSettings",
                    "saveSettings",
                    "idSettings",
                    "saveIdSettings",
                    "saveOrder",
                    "confirmStepDeletion",
                    "deleteStep",
                    "resetTour",
                    "importTourForm",
                    "importTour"
                ])) {
                    $this->$cmd();
                }
        }
    }

References $lng, forwardToPageObject(), getImportForm(), setSettingsTabs(), and setStepsHeader().

Here is the call graph for this function:

forwardToPageObject()

ilGuidedTourAdminGUI::forwardToPageObject

(

)

Definition at line 143 of file class.ilGuidedTourAdminGUI.php.

                                         : string
    {
        $tabs = $this->gui->tabs();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $step_id = $this->gui->standardRequest()->getStepId();
        $tour_id = $this->gui->standardRequest()->getTourId();
 
        $tabs->clearTargets();
 
        $tabs->setBackTarget(
            $lng->txt("back"),
            $ctrl->getLinkTargetByClass(ilGuidedTourPageGUI::class, "edit")
        );
 
        if (!ilGuidedTourPage::_exists(
            "gdtr",
            $step_id
        )) {
            $new_page_object = new ilGuidedTourPage();
            $new_page_object->setParentId($tour_id);
            $new_page_object->setId($step_id);
            $new_page_object->createFromXML();
        }
 
        // get page object
        $page_gui = new ilGuidedTourPageGUI($step_id);
        /*$page_gui->setStyleId(
            $style->getEffectiveStyleId()
        );*/
        $page_gui->setTemplateTargetVar("ADM_CONTENT");
        $page_gui->setFileDownloadLink("");
        $page_gui->setPresentationTitle("");
        $page_gui->setTemplateOutput(false);
 
        // style tab
        //$page_gui->setTabHook($this, "addPageTabs");
 
        return $ctrl->forwardCommand($page_gui);
    }

References $lng, and ilPageObject\_exists().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

getCreateForm()

ilGuidedTourAdminGUI::getCreateForm ( )

protected

Definition at line 321 of file class.ilGuidedTourAdminGUI.php.

                                      : FormAdapterGUI
    {
        $lng = $this->domain->lng();
        return $this->gui->form([self::class], "saveTour")
            ->section("sec", $lng->txt("gdtr_add_tour"))
            ->addStdTitleAndDescription(0, "gdtr");
    }

References $lng.

Referenced by addTour(), and saveTour().

Here is the caller graph for this function:

getDeleteTourModal()

ilGuidedTourAdminGUI::getDeleteTourModal ( int  $tour_id )

protected

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

                                                       : \ILIAS\UI\Component\Modal\Interruptive
    {
        $tour = $this->tm->getByObjId($tour_id);
        $f = $this->gui->ui()->factory();
        $r = $this->gui->ui()->renderer();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $del_items = [];
        $del_items[] = $f->modal()->interruptiveItem()->keyValue(
            (string) $tour_id,
            $tour->getTitle(),
            ""
        );
        $ctrl->setParameterByClass(self::class, "tour_id", $tour_id);
        $action = $ctrl->getLinkTargetByClass(self::class, "deleteTour");
 
        return $f->modal()->interruptive(
            $lng->txt("gdtr_delete_tour"),
            $lng->txt("gdtr_delete_tour_mess"),
            $action
        )->withAffectedItems($del_items);
    }

References Vendor\Package\$f, and $lng.

Referenced by listTours().

Here is the caller graph for this function:

getIdForm()

ilGuidedTourAdminGUI::getIdForm ( )

protected

Definition at line 625 of file class.ilGuidedTourAdminGUI.php.

                                  : FormAdapterGUI
    {
        $lng = $this->domain->lng();
        $id_pres = $this->domain->idPresentation();
        return $this
            ->gui
            ->form([self::class], "saveIdSettings")
            ->section("sec", $lng->txt("gdtr_id_settings"))
            ->text(
                "users",
                $lng->txt("gdtr_id_pres_users"),
                $lng->txt("gdtr_id_pres_users_info"),
                $id_pres->getIdPresentationUsers()
            );
    }

References $lng.

Referenced by idSettings(), and saveIdSettings().

Here is the caller graph for this function:

getImportForm()

ilGuidedTourAdminGUI::getImportForm ( )

protected

Definition at line 712 of file class.ilGuidedTourAdminGUI.php.

                                      : FormAdapterGUI
    {
        $lng = $this->domain->lng();
        return $this->gui->form([self::class], "importTour")
            ->section("sec", $lng->txt("gdtr_import_tour"))
            ->file(
                "import",
                $lng->txt("import_file"),
                $this->handleImportUpload(...),
                "id",
                "",
                1,
                ["application/zip"]
            );
    }

References $lng.

Referenced by executeCommand(), and importTourForm().

Here is the caller graph for this function:

getResetTourModal()

ilGuidedTourAdminGUI::getResetTourModal ( int  $tour_id )

protected

Definition at line 252 of file class.ilGuidedTourAdminGUI.php.

                                                      : \ILIAS\UI\Component\Modal\Interruptive
    {
        $tour = $this->tm->getByObjId($tour_id);
        $f = $this->gui->ui()->factory();
        $r = $this->gui->ui()->renderer();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $res_items = [];
        $res_items[] = $f->modal()->interruptiveItem()->keyValue(
            (string) $tour_id,
            $tour->getTitle(),
            ""
        );
        $ctrl->setParameterByClass(self::class, "tour_id", $tour_id);
        $action = $ctrl->getLinkTargetByClass(self::class, "resetTour");
 
        return $f->modal()->interruptive(
            $lng->txt("gdtr_reset_tour"),
            $lng->txt("gdtr_reset_tour_mess"),
            $action
        )->withAffectedItems($res_items)
         ->withActionButtonLabel($lng->txt("gdtr_reset_tour"));
    }

References Vendor\Package\$f, and $lng.

Referenced by listTours().

Here is the caller graph for this function:

getSettingsForm()

ilGuidedTourAdminGUI::getSettingsForm ( )

protected

Definition at line 359 of file class.ilGuidedTourAdminGUI.php.

                                        : FormAdapterGUI
    {
        $tour_id = $this->gui->standardRequest()->getTourId();
        $lng = $this->domain->lng();
        $settings = $this->domain->tourSettings()->getByObjId($tour_id);
        $perm_val = (string) $settings?->getPermission()->value;
        if ($perm_val === "0") {
            $perm_val = "";
        }
        $lang_val = (string) $settings?->getLanguage();
        $lang_vals = $this->domain->tourSettings()->getLangOptions($lang_val);
        if ($perm_val === "0") {
            $perm_val = "";
        }
        return $this
            ->gui
            ->form([self::class], "saveSettings")
            ->section("sec", $lng->txt("settings"))
            ->addStdTitleAndDescription($tour_id, "gdtr")
            ->checkbox(
                "active",
                $lng->txt("gdtr_active"),
                "",
                $settings?->isActive()
            )
            ->text(
                "screen_ids",
                $lng->txt("gdtr_screen_ids"),
                $lng->txt("gdtr_screen_ids_info"),
                $settings?->getScreenIds()
            )
            ->select(
                "permission",
                $lng->txt("gdtr_permission"),
                [
                    (string) PermissionType::Read->value => $lng->txt("read"),
                    (string) PermissionType::Write->value => $lng->txt("write"),
                    (string) PermissionType::Create->value => $lng->txt("create"),
                ],
                $lng->txt("gdtr_permission_info"),
                $perm_val
            )
            ->select(
                "lang",
                $lng->txt("gdtr_language"),
                $lang_vals,
                $lng->txt("gdtr_language_info"),
                $lang_val
            );
 
    }

References $lng, ILIAS\Repository\Form\addStdTitleAndDescription(), ILIAS\Help\GuidedTour\Settings\Create, and getLanguage().

Referenced by editSettings(), and saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

getStepForm()

ilGuidedTourAdminGUI::getStepForm ( ?Step  $step = null )

protected

Definition at line 514 of file class.ilGuidedTourAdminGUI.php.

                                                      : FormAdapterGUI
    {
        $lng = $this->domain->lng();
        $type_val = (string) $step?->getType()->value;
        $mb_element_id = $step?->getType()->value === StepType::Mainbar->value
            ? $step?->getElementId()
            : null;
        $mt_element_id = $step?->getType()->value === StepType::Metabar->value
            ? $step?->getElementId()
            : null;
        $tab_element_id = $step?->getType()->value === StepType::Tab->value
            ? $step?->getElementId()
            : null;
        return $this->gui->form([self::class], "saveStep")
            ->section("sec", $lng->txt("gdtr_step"))
            ->switch("type", $lng->txt("gdtr_step_type"), "", $type_val)
            ->group((string) StepType::Mainbar->value, $lng->txt("gdtr_mainbar"), $lng->txt("gdtr_mainbar_info"))
            ->text("mb_element_id", $lng->txt("gdtr_element_id"), "", $mb_element_id)
            ->group((string) StepType::Metabar->value, $lng->txt("gdtr_metabar"), $lng->txt("gdtr_metabar_info"))
            ->text("mt_element_id", $lng->txt("gdtr_element_id"), "", $mt_element_id)
            ->group((string) StepType::Tab->value, $lng->txt("gdtr_tabs"), $lng->txt("gdtr_tabs_info"))
            ->text("tab_element_id", $lng->txt("gdtr_element_id"), "", $tab_element_id)
            ->group((string) StepType::Form->value, $lng->txt("gdtr_form"), $lng->txt("gdtr_form_info"))
            ->group((string) StepType::Table->value, $lng->txt("gdtr_table"), $lng->txt("gdtr_table_info"))
            ->group((string) StepType::Toolbar->value, $lng->txt("gdtr_toolbar"), $lng->txt("gdtr_toolbar_info"))
            ->group((string) StepType::PrimaryButton->value, $lng->txt("gdtr_primary_button"), $lng->txt("gdtr_primary_button_info"))
            ->end();
    }

References $lng, and ILIAS\Help\GuidedTour\Step\PrimaryButton.

Referenced by addStep(), editStep(), and saveStep().

Here is the caller graph for this function:

getStepTable()

ilGuidedTourAdminGUI::getStepTable ( )

protected

Definition at line 489 of file class.ilGuidedTourAdminGUI.php.

                                     : \ILIAS\Repository\Table\TableAdapterGUI
    {
        return $this->gui->stepTableGUI(
            $this->gui->standardRequest()->getTourId(),
            $this,
            "listSteps"
        );
    }

Referenced by confirmStepDeletion(), listSteps(), and saveOrder().

Here is the caller graph for this function:

handleImportUpload()

ilGuidedTourAdminGUI::handleImportUpload ( FileUpload  $upload, UploadResult  $result  )

protected

Definition at line 728 of file class.ilGuidedTourAdminGUI.php.

     : BasicHandlerResult {
        $new_id = $this->importTourFile($result->getName(), $result->getPath());
        return new BasicHandlerResult(
            '',
            \ILIAS\FileUpload\Handler\HandlerResult::STATUS_OK,
            (string) $new_id,
            ''
        );
    }

idSettings()

ilGuidedTourAdminGUI::idSettings ( )

protected

Definition at line 618 of file class.ilGuidedTourAdminGUI.php.

                                   : void
    {
        $this->setSubTabs("id_settings");
        $mt = $this->gui->ui()->mainTemplate();
        $mt->setContent($this->getIdForm()->render());
    }

References getIdForm(), and setSubTabs().

Here is the call graph for this function:

importTour()

ilGuidedTourAdminGUI::importTour ( )

protected

Definition at line 762 of file class.ilGuidedTourAdminGUI.php.

                                   : void
    {
        $ctrl = $this->gui->ctrl();
        $ctrl->redirectByClass(self::class, "listTours");
    }

importTourFile()

ilGuidedTourAdminGUI::importTourFile ( string  $filename, string  $path  )

protected

Definition at line 742 of file class.ilGuidedTourAdminGUI.php.

     : int {
        $new_id = 0;
        $fname = explode("_", $filename);
        if ($fname[4] == "gdtr") {
            $imp = new ilImport();
            $new_id = $imp->importObject(
                null,
                $path,
                $filename,
                "gdtr",
                "",
                true
            );
        }
        return $new_id;
    }

importTourForm()

ilGuidedTourAdminGUI::importTourForm ( )

protected

Definition at line 706 of file class.ilGuidedTourAdminGUI.php.

                                       : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $mt->setContent($this->getImportForm()->render());
    }

References getImportForm().

Here is the call graph for this function:

listSteps()

ilGuidedTourAdminGUI::listSteps ( )

protected

Definition at line 465 of file class.ilGuidedTourAdminGUI.php.

                                  : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $f = $this->gui->ui()->factory();
        $ctrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
 
        $table = $this->getStepTable();
        if ($table->handleCommand()) {
            return;
        }
 
        $this->setStepsHeader();
        $this->setSettingsTabs("steps");
 
        $b = $f->button()->standard(
            $lng->txt("gdtr_add_step"),
            $ctrl->getLinkTarget($this, "addStep")
        );
        $this->gui->toolbar()->addComponent($b);
 
        $mt->setContent($table->render());
    }

References Vendor\Package\$b, Vendor\Package\$f, $lng, getStepTable(), setSettingsTabs(), and setStepsHeader().

Here is the call graph for this function:

listTours()

ilGuidedTourAdminGUI::listTours ( )

protected

Definition at line 185 of file class.ilGuidedTourAdminGUI.php.

                                  : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $f = $this->gui->ui()->factory();
        $r = $this->gui->ui()->renderer();
        $this->setSubTabs("tours");
        $ctrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
 
        $mt->setOnScreenMessage("info", $lng->txt("gdtr_list_tours_mess"));
 
        $b = $f->button()->standard(
            $lng->txt("gdtr_add_tour"),
            $ctrl->getLinkTarget($this, "addTour")
        );
        $this->gui->toolbar()->addComponent($b);
        $b = $f->button()->standard(
            $lng->txt("gdtr_import_tour"),
            $ctrl->getLinkTarget($this, "importTourForm")
        );
        $this->gui->toolbar()->addComponent($b);
 
        $items = [];
        $ui_items = [];
        foreach ($this->tm->getAll() as $tour) {
            $ctrl->setParameterByClass(self::class, "tour_id", $tour->getId());
            $actions = [];
            $actions[] = $f->link()->standard(
                $lng->txt("gdtr_edit_steps"),
                $ctrl->getLinkTargetByClass(self::class, "listSteps")
            );
            $actions[] = $f->link()->standard(
                $lng->txt("settings"),
                $ctrl->getLinkTargetByClass(self::class, "editSettings")
            );
            $reset_modal = $this->getResetTourModal($tour->getId());
            $actions[] = $f->button()->shy(
                $lng->txt("gdtr_reset_tour"),
                "#"
            )->withOnClick($reset_modal->getShowSignal());
            $ui_items[] = $reset_modal;
            $delete_modal = $this->getDeleteTourModal($tour->getId());
            $actions[] = $f->button()->shy(
                $lng->txt("delete"),
                "#"
            )->withOnClick($delete_modal->getShowSignal());
            $ui_items[] = $delete_modal;
            $properties = [];
            $settings = $this->domain->tourSettings()->getByObjId($tour->getId());
            $properties[$lng->txt("active")] = $settings?->isActive()
                ? $lng->txt("yes")
                : $lng->txt("no");
            $items[] = $f->item()->standard($tour->getTitle())
                ->withActions($f->dropdown()->standard($actions))
                ->withProperties($properties);
        }
        if (count($items) > 0) {
            $grp = $f->item()->group("", $items);
            $panel = $f->panel()->listing()->standard(
                $lng->txt("gdtr_guided_tours"),
                [$grp]
            );
            $ui_items[] = $panel;
            $mt->setContent($r->render($ui_items));
        }
    }

References Vendor\Package\$b, Vendor\Package\$f, $lng, getDeleteTourModal(), getResetTourModal(), and setSubTabs().

Here is the call graph for this function:

resetTour()

ilGuidedTourAdminGUI::resetTour ( )

protected

Definition at line 276 of file class.ilGuidedTourAdminGUI.php.

                                  : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $tour_id = $this->gui->standardRequest()->getTourId();
        $this->finish_manager->resetTour($tour_id);
        $mt->setOnScreenMessage("success", $lng->txt("gdtr_tour_has_been_reset"), true);
        $ctrl->redirectByClass(self::class, "listTours");
    }

References $lng.

saveIdSettings()

ilGuidedTourAdminGUI::saveIdSettings ( )

protected

Definition at line 641 of file class.ilGuidedTourAdminGUI.php.

                                       : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $form = $this->getIdForm();
        $id_pres = $this->domain->idPresentation();
        $id_pres->saveIdPresentationUsers($form->getData("users"));
        $mt->setOnScreenMessage("success", $lng->txt("msg_obj_modified"), true);
        $ctrl->redirectByClass(self::class, "idSettings");
    }

References $lng, and getIdForm().

Here is the call graph for this function:

saveOrder()

ilGuidedTourAdminGUI::saveOrder ( )

protected

Definition at line 653 of file class.ilGuidedTourAdminGUI.php.

                                  : void
    {
        $ctrl = $this->gui->ctrl();
        $mt = $this->gui->ui()->mainTemplate();
        $lng = $this->domain->lng();
        $ctrl->saveParameterByClass(self::class, "tour_id");
 
        $table = $this->getStepTable();
        $data = $table->getData();
        if (is_array($data)) {
            $this->step_manager->saveOrder(
                $this->gui->standardRequest()->getTourId(),
                $data
            );
            $mt->setOnScreenMessage("success", $lng->txt("msg_obj_modified"), true);
        }
        $ctrl->redirectByClass(self::class, "listSteps");
    }

References $data, $lng, and getStepTable().

Here is the call graph for this function:

saveSettings()

ilGuidedTourAdminGUI::saveSettings

(

)

Definition at line 411 of file class.ilGuidedTourAdminGUI.php.

                                  : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $form = $this->getSettingsForm();
        $tour_id = $this->gui->standardRequest()->getTourId();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
 
        $tour_settings = $this->domain->tourSettings();
        if ($form->isValid()) {
            $form->saveStdTitleAndDescription($tour_id, "gdtr");
            $tour_settings->save($this->data->settings(
                $tour_id,
                (bool) $form->getData("active"),
                $form->getData("screen_ids"),
                PermissionType::from((int) $form->getData("permission")),
                $form->getData("lang")
            ));
            $mt->setOnScreenMessage("success", $lng->txt("msg_obj_modified"), true);
            $ctrl->redirectByClass(self::class, "editSettings");
        } else {
            $mt->setContent($form->render());
        }
    }

References $lng, ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), and getSettingsForm().

Here is the call graph for this function:

saveStep()

ilGuidedTourAdminGUI::saveStep

(

)

Definition at line 543 of file class.ilGuidedTourAdminGUI.php.

                              : void
    {
        $ctrl = $this->gui->ctrl();
        $mt = $this->gui->ui()->mainTemplate();
        $oder_nr = 0;
        if (($step_id = $this->gui->standardRequest()->getStepId()) > 0) {
            $step = $this->step_manager->getById($step_id);
            $oder_nr = $step->getOrderNr();
        }
        $form = $this->getStepForm();
        if ($form->isValid()) {
            $element_id = match ((int) $form->getData("type")) {
                StepType::Mainbar->value => $form->getData("mb_element_id"),
                StepType::Metabar->value => $form->getData("mt_element_id"),
                StepType::Tab->value => $form->getData("tab_element_id"),
                default => ''
            };
            $step = $this->data->step(
                $step_id,
                $this->gui->standardRequest()->getTourId(),
                $oder_nr,
                StepType::from((int) $form->getData("type")),
                $element_id
            );
            if ($step_id > 0) {
                $this->step_manager->update($step);
                $ctrl->redirectByClass(self::class, "listSteps");
            } else {
                $new_id = $this->step_manager->create($step);
                $ctrl->setParameterByClass(self::class, "step_id", $new_id);
                $ctrl->redirectByClass(ilGuidedTourPageGUI::class, "edit");
            }
        } else {
            $mt->setContent($form->render());
        }
    }

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), and getStepForm().

Here is the call graph for this function:

saveTour()

ilGuidedTourAdminGUI::saveTour

(

)

Definition at line 335 of file class.ilGuidedTourAdminGUI.php.

                              : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $form = $this->getCreateForm();
        if ($form->isValid()) {
            $obj_id = $this->tm->createTour("dummy", "");
            $form->saveStdTitleAndDescription($obj_id, "gdtr");
            $mt->setOnScreenMessage("success", $lng->txt("msg_obj_modified"), true);
            $ctrl->redirectByClass(self::class, "listTours");
        } else {
            $mt->setContent($form->render());
        }
    }

References $lng, and getCreateForm().

Here is the call graph for this function:

setSettingsTabs()

ilGuidedTourAdminGUI::setSettingsTabs ( string  $active )

protected

Definition at line 113 of file class.ilGuidedTourAdminGUI.php.

                                                      : void
    {
        $tabs = $this->gui->tabs();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $tabs->clearTargets();
        $this->gui->help()->setScreenIdComponent("hlps_gdtr");
        $tabs->setBackTarget(
            $lng->txt("gdtr_guided_tours"),
            $ctrl->getLinkTargetByClass(self::class, "listTours")
        );
        $ctrl->saveParameterByClass(self::class, "tour_id");
        $tabs->addTab(
            "steps",
            $lng->txt("gdtr_tour_steps"),
            $ctrl->getLinkTargetByClass(self::class, "listSteps")
        );
        $tabs->addTab(
            "settings",
            $lng->txt("settings"),
            $ctrl->getLinkTargetByClass(self::class, "editSettings")
        );
        $tabs->addTab(
            "export",
            $lng->txt("export"),
            $ctrl->getLinkTargetByClass(ilexportGUI::class, "export", ""),
        );
        $tabs->activateTab($active);
    }

References $lng.

Referenced by editSettings(), executeCommand(), and listSteps().

Here is the caller graph for this function:

setSingleStepHeader()

ilGuidedTourAdminGUI::setSingleStepHeader ( )

protected

Definition at line 453 of file class.ilGuidedTourAdminGUI.php.

                                            : void
    {
        $this->setStepsHeader();
        $tabs = $this->gui->tabs();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $tabs->setBackTarget(
            $lng->txt("back"),
            $ctrl->getLinkTargetByClass(self::class, "listSteps")
        );
    }

References $lng, and setStepsHeader().

Referenced by addStep(), and editStep().

Here is the call graph for this function:

Here is the caller graph for this function:

setStepsHeader()

ilGuidedTourAdminGUI::setStepsHeader ( )

protected

Definition at line 437 of file class.ilGuidedTourAdminGUI.php.

                                       : void
    {
        $tabs = $this->gui->tabs();
        $lng = $this->domain->lng();
        $mt = $this->gui->ui()->mainTemplate();
        $ctrl = $this->gui->ctrl();
        $tour = $this->tm->getByObjId($this->gui->standardRequest()->getTourId());
        $mt->setTitle($lng->txt("guided_tour") . ": " . $tour?->getTitle());
        $mt->setDescription($tour?->getDescription());
        $tabs->clearTargets();
        $tabs->setBackTarget(
            $lng->txt("back"),
            $ctrl->getLinkTargetByClass(self::class, "listTours")
        );
    }

References $lng.

Referenced by editSettings(), executeCommand(), listSteps(), and setSingleStepHeader().

Here is the caller graph for this function:

setSubTabs()

ilGuidedTourAdminGUI::setSubTabs ( string  $active )

protected

Definition at line 600 of file class.ilGuidedTourAdminGUI.php.

                                                 : void
    {
        $tabs = $this->gui->tabs();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
        $tabs->addSubTab(
            "tours",
            $lng->txt("gdtr_tours"),
            $ctrl->getLinkTargetByClass(self::class, "listTours")
        );
        $tabs->addSubTab(
            "id_settings",
            $lng->txt("gdtr_id_settings"),
            $ctrl->getLinkTargetByClass(self::class, "idSettings")
        );
        $tabs->activateSubTab($active);
    }

References $lng.

Referenced by idSettings(), and listTours().

Here is the caller graph for this function:

Field Documentation

$finish_manager

ILIAS Help GuidedTour UserFinished UserFinishedManager ilGuidedTourAdminGUI::$finish_manager

protected

Definition at line 35 of file class.ilGuidedTourAdminGUI.php.

$step_manager

ILIAS Help GuidedTour Step StepManager ilGuidedTourAdminGUI::$step_manager

private

Definition at line 34 of file class.ilGuidedTourAdminGUI.php.

$tm

ILIAS Help GuidedTour Tour TourManager ilGuidedTourAdminGUI::$tm

protected

Definition at line 36 of file class.ilGuidedTourAdminGUI.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Help/GuidedTour/Admin/class.ilGuidedTourAdminGUI.php