ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI Class Reference

Collaboration diagram for ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI:

Public Member Functions
	__construct (protected InternalDataService $data, protected InternalDomainService $domain, protected InternalGUIService $gui, protected int $obj_id, protected int $ref_id)
	executeCommand ()

Protected Member Functions
	edit ()
	getEditForm ()
	save ()

Protected Attributes
ilSetting	$global_settings

Detailed Description

Definition at line 28 of file class.SettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI::__construct	(	protected InternalDataService	$data,
		protected InternalDomainService	$domain,
		protected InternalGUIService	$gui,
		protected int	$obj_id,
		protected int	$ref_id
	)

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

      {
        $this->global_settings = $this->domain->settings();
    }

Member Function Documentation

edit()

ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI::edit ( )

protected

Definition at line 56 of file class.SettingsGUI.php.

References ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm().

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

Here is the call graph for this function:

executeCommand()

ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI::executeCommand

(

)

Definition at line 42 of file class.SettingsGUI.php.

                                    : void
    {
        $ctrl = $this->gui->ctrl();
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("edit");

        switch ($next_class) {
            default:
                if (in_array($cmd, ["edit", "save"])) {
                    $this->$cmd();
                }
        }
    }

getEditForm()

ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI::getEditForm ( )

protected

Definition at line 63 of file class.SettingsGUI.php.

References $lng, ilBlockSetting\_lookup(), ilNewsItem\_lookupRSSPeriod(), ILIAS\Repository\Form\addOnline(), ILIAS\Repository\Form\addStdTile(), ILIAS\Repository\Form\addStdTitleAndDescription(), ilObjMediaCast\AUTOPLAY_ACT, ilObjMediaCast\AUTOPLAY_INACT, ilObjMediaCast\AUTOPLAY_NO, ilLearningProgressAccess\checkAccess(), ilObjMediaCast\ORDER_CREATION_DATE_ASC, ilObjMediaCast\ORDER_CREATION_DATE_DESC, ilObjMediaCast\ORDER_MANUAL, ilObjMediaCast\ORDER_TITLE, ilObjMediaCast\VIEW_IMG_GALLERY, ilObjMediaCast\VIEW_PODCAST, and ilObjMediaCast\VIEW_VCAST.

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\edit(), and ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\save().

                                    : FormAdapterGUI
    {
        $settings = $this->domain->mediacastSettings()->getById($this->obj_id);
        $lng = $this->domain->lng();

        $form = $this->gui
            ->form(self::class, "save")
            ->section("general", $lng->txt("mcst_settings"))
            ->addStdTitleAndDescription($this->obj_id, "mcst")
            ->section("avail", $lng->txt("rep_activation_availability"))
            ->addOnline($this->obj_id, "mcst")
            ->section("presentation", $lng->txt("obj_presentation"))
            ->addStdTile($this->obj_id, "mcst")
            ->switch(
                "order",
                $lng->txt("mcst_ordering"),
                "",
                (string) $settings->getSortMode()
            )
            ->group((string) \ilObjMediaCast::ORDER_TITLE, $lng->txt("mcst_ordering_title"))
            ->group((string) \ilObjMediaCast::ORDER_CREATION_DATE_ASC, $lng->txt("mcst_ordering_creation_date_asc"))
            ->group((string) \ilObjMediaCast::ORDER_CREATION_DATE_DESC, $lng->txt("mcst_ordering_creation_date_desc"))
            ->group((string) \ilObjMediaCast::ORDER_MANUAL, $lng->txt("mcst_ordering_manual"))
            ->end()
            ->switch(
                "viewmode",
                $lng->txt("mcst_viewmode"),
                "",
                $settings->getViewMode()
            )
            ->group(\ilObjMediaCast::VIEW_IMG_GALLERY, $lng->txt("mcst_img_gallery"))
            ->group(\ilObjMediaCast::VIEW_PODCAST, $lng->txt("mcst_podcast"))
            ->group(\ilObjMediaCast::VIEW_VCAST, $lng->txt("mcst_video_cast"))
            ->select(
                "autoplaymode",
                $lng->txt("mcst_autoplay"),
                [
                    \ilObjMediaCast::AUTOPLAY_NO => $lng->txt("mcst_no_autoplay"),
                    \ilObjMediaCast::AUTOPLAY_ACT => $lng->txt("mcst_autoplay_active"),
                    \ilObjMediaCast::AUTOPLAY_INACT => $lng->txt("mcst_autoplay_inactive")
                ],
                "",
                (string) $settings->getAutoplayMode()
            )
            ->number(
                "nr_videos",
                $lng->txt("mcst_nr_videos"),
                "",
                max(1, $settings->getNumberInitialVideos()),
                1
            )
            ->end()
            ->checkbox(
                "downloadable",
                $lng->txt("mcst_downloadable"),
                $lng->txt("mcst_downloadable_info"),
                $settings->getDownloadable()
            );

        // Webfeed Section
        $news_set = new \ilSetting("news");
        if ($news_set->get("enable_rss_for_internal")) {
            $form = $form
                ->section("webfeed", $lng->txt("mcst_webfeed"))
                ->switch(
                    "defaultaccess",
                    $lng->txt("news_default_visibility"),
                    "",
                    (string) $settings->getDefaultAccess()
                )
                ->group(
                    "0",
                    $lng->txt("news_visibility_users"),
                    $lng->txt("news_news_item_def_visibility_users_info")
                )
                ->group(
                    "1",
                    $lng->txt("news_visibility_public"),
                    $lng->txt("news_news_item_def_visibility_public_info")
                )
                ->end();

            // Extra Feed
            $public_feed = \ilBlockSetting::_lookup("news", "public_feed", 0, $this->obj_id);
            $form = $form
                ->optional(
                    "extra_feed",
                    $lng->txt("news_public_feed"),
                    $lng->txt("news_public_feed_info"),
                    (bool) $public_feed
                )
                ->number(
                    "keep_rss_min",
                    $lng->txt("news_keep_minimal_x_items"),
                    $lng->txt("news_keep_minimal_x_items_info") . " (" . \ilNewsItem::_lookupRSSPeriod() . " " . ($lng->txt(\ilNewsItem::_lookupRSSPeriod() == 1 ? "day" : "days")) . ")",
                    (int) \ilBlockSetting::_lookup(
                        "news",
                        "keep_rss_min",
                        0,
                        $this->obj_id
                    ),
                    0,
                    100
                )->end();

            // Include Files in RSS
            $form = $form->checkbox(
                "public_files",
                $lng->txt("mcst_incl_files_in_rss"),
                $lng->txt("mcst_incl_files_in_rss_info"),
                $settings->getPublicFiles()
            );
        }

        // Learning Progress Section
        if (\ilLearningProgressAccess::checkAccess($this->ref_id)) {
            $form = $form->section("learning_progress", $lng->txt("learning_progress"))
                         ->checkbox(
                             "auto_det_lp",
                             $lng->txt("mcst_new_items_det_lp"),
                             $lng->txt("mcst_new_items_det_lp_info"),
                             $settings->getNewItemsInLearningProgress()
                         );
        }

        if (!$this->global_settings->get('disable_comments')) {
            $lng->loadLanguageModule("notes");
            // Features Section
            $form = $form->section("features", $lng->txt('obj_features'));
            $form = $form->checkbox(
                "comments",
                $lng->txt("notes_comments"),
                "",
                $this->domain->notes()->commentsActive($this->obj_id)
            );
        }
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI::save ( )

protected

Definition at line 202 of file class.SettingsGUI.php.

References $lng, ilBlockSetting\_write(), ilLearningProgressAccess\checkAccess(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), and ILIAS\Repository\int().

                             : void
    {
        $mt = $this->gui->ui()->mainTemplate();
        $form = $this->getEditForm();
        $ctrl = $this->gui->ctrl();
        $lng = $this->domain->lng();

        $old_settings = $this->domain->mediacastSettings()->getById($this->obj_id);

        if ($form->isValid()) {

            $form->saveStdTitleAndDescription($this->obj_id, "mcst");
            $form->saveStdTile($this->obj_id, "mcst");
            $form->saveOnline($this->obj_id, "mcst");

            $settings = $this->data->settings(
                $this->obj_id,
                (bool) $form->getData("public_files"),
                (bool) $form->getData("downloadable"),
                (int) $form->getData("defaultaccess"),
                (int) $form->getData("order"),
                (string) $form->getData("viewmode"),
                (bool) $form->getData("autoplaymode"),
                (int) $form->getData("nr_videos"),
                \ilLearningProgressAccess::checkAccess($this->ref_id) && (bool) $form->getData("auto_det_lp")
            );
            $this->domain->mediacastSettings()->update($settings);

            if (!$this->global_settings->get('disable_comments')) {
                $this->domain->notes()->activateComments(
                    $this->obj_id,
                    $form->getData("comments")
                );
            }

            $news_set = new \ilSetting("news");
            $enable_internal_rss = $news_set->get("enable_rss_for_internal");

            if ($enable_internal_rss) {
                \ilBlockSetting::_write(
                    "news",
                    "public_feed",
                    (string) $form->getData("extra_feed"),
                    0,
                    $this->obj_id
                );

                \ilBlockSetting::_write(
                    "news",
                    "keep_rss_min",
                    (string) $form->getData("keep_rss_min"),
                    0,
                    $this->obj_id
                );
            }

            $mt->setOnScreenMessage("success", $lng->txt("msg_obj_modified"), true);
            $ctrl->redirectByClass(self::class, "edit");
        } else {
            $mt = $this->gui->ui()->mainTemplate();
            $mt->setContent($form->render());
        }
    }

Here is the call graph for this function:

Field Documentation

$global_settings

ilSetting ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI::$global_settings

protected

Definition at line 30 of file class.SettingsGUI.php.

---

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

• components/ILIAS/MediaCast/Settings/class.SettingsGUI.php