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 bool $in_repository)
	executeCommand ()

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

Protected Attributes
ILIAS Blog ReadingTime BlogSettingsGUI	$reading_time_gui
ilSetting	$global_settings
ILIAS Notes DomainService	$notes

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 bool	$in_repository
	)

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

      {
        $this->notes = $domain->notes();
        $this->global_settings = $domain->settings();
        $this->reading_time_gui = $gui->readingTime()->settingsGUI($obj_id);
    }

Member Function Documentation

edit()

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

protected

Definition at line 60 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 46 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 67 of file class.SettingsGUI.php.

References $lng, ILIAS\Repository\Form\addOnline(), ILIAS\Repository\Form\addStdTitleAndDescription(), ILIAS\Repository\int(), ilObjBlog\NAV_MODE_LIST, and ilObjBlog\NAV_MODE_MONTH.

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

                                    : FormAdapterGUI
    {
        $settings = $this->domain->blogSettings()->getByObjId($this->obj_id);

        $lng = $this->domain->lng();
        $form = $this->gui->form(self::class, "save")
                          ->section("general", $lng->txt("blog_edit"))
                          ->addStdTitleAndDescription(
                              $this->obj_id,
                              "blog"
                          );

        if ($this->in_repository) {
            $form = $form->checkbox(
                "approval",
                $lng->txt("blog_enable_approval"),
                $lng->txt("blog_enable_approval_info"),
                $settings->getApproval()
            );
        }

        $form = $form->checkbox(
            "notes",
            $lng->txt("blog_enable_notes"),
            "",
            $this->notes->commentsActive($this->obj_id)
        );

        if ($this->global_settings->get('enable_global_profiles')) {
            $form = $form->checkbox(
                "rss",
                $lng->txt("blog_enable_rss"),
                "blog_enable_rss_info",
                $settings->getRss()
            );
        }

        $form = $form->section("availibility", $lng->txt("rep_activation_availability"))
            ->addOnline($this->obj_id, "blog");

        $form = $form->section("nav", $lng->txt("blog_settings_navigation"))
                     ->switch("nav_mode", $lng->txt("blog_nav_mode"), "", (string) $settings->getNavMode())
                     ->group(
                         (string) \ilObjBlog::NAV_MODE_LIST,
                         $lng->txt("blog_nav_mode_month_list"),
                         $lng->txt("blog_nav_mode_month_list_info")
                     )
                     ->number(
                         "nav_list_mon",
                         $lng->txt("blog_nav_mode_month_list_num_month"),
                         $lng->txt("blog_nav_mode_month_list_num_month_info"),
                         (int) $settings->getNavModeListMonths(),
                         1
                     )
                     ->number(
                         "nav_list_mon_with_post",
                         $lng->txt("blog_nav_mode_month_list_num_month_with_post"),
                         $lng->txt("blog_nav_mode_month_list_num_month_with_post_info"),
                         (int) $settings->getNavModeListMonthsWithPostings()
                     )
                     ->group(
                         (string) \ilObjBlog::NAV_MODE_MONTH,
                         $lng->txt("blog_nav_mode_month_single"),
                         $lng->txt("blog_nav_mode_month_single_info")
                     )
                     ->end();

        if ($this->in_repository) {
            $form = $form->checkbox(
                "nav_authors",
                $lng->txt("blog_enable_nav_authors"),
                $lng->txt("blog_enable_nav_authors_info"),
                $settings->getAuthors()
            );
        }

        $form = $form
            ->checkbox(
                "keywords",
                $lng->txt("blog_enable_keywords"),
                $lng->txt("blog_enable_keywords_info"),
                $settings->getKeywords()
            )
            ->section("presentation", $lng->txt("blog_presentation_frame"));

        if ($this->in_repository) {
            $form = $form->addStdTile(
                $this->obj_id,
                "blog"
            );
        }

        $info = ($this->in_repository)
            ? $lng->txt("blog_profile_picture_repository_info")
            : "";

        $form = $form->checkbox(
            "ppic",
            $lng->txt("blog_profile_picture"),
            $info,
            $settings->getProfilePicture()
        );

        $form = $this->reading_time_gui->addSettingToFormAdapter($form);

        $form = $form
            ->section("pres_overview", $lng->txt("blog_presentation_overview"))
            ->number(
                "ov_list_post_num",
                $lng->txt("blog_list_num_postings"),
                $lng->txt("blog_list_num_postings_info"),
                (int) $settings->getOverviewPostings()
            )
            ->optional(
                "abss",
                $lng->txt("blog_abstract_shorten"),
                "",
                $settings->getAbstractShorten()
            )
            ->number(
                "abssl",
                $lng->txt("blog_abstract_shorten_length"),
                $lng->txt("blog_abstract_shorten_characters"),
                $settings->getAbstractShortenLength()
            )->required()
            ->end()
            ->optional(
                "absi",
                $lng->txt("blog_abstract_image"),
                $lng->txt("blog_abstract_image_info"),
                $settings->getAbstractImage()
            )
            ->number(
                "absiw",
                $lng->txt("blog_abstract_image_width"),
                $lng->txt("blog_abstract_image_pixels"),
                $settings->getAbstractImageWidth(),
                32
            )->required()
            ->number(
                "absih",
                $lng->txt("blog_abstract_image_height"),
                $lng->txt("blog_abstract_image_pixels"),
                $settings->getAbstractImageHeight(),
                32
            )->required()
            ->end();

        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 218 of file class.SettingsGUI.php.

References $lng, ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), ILIAS\Repository\int(), and ilObjBlog\NAV_MODE_LIST.

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

        $old_settings = $this->domain->blogSettings()->getByObjId($this->obj_id);

        if ($form->isValid()) {
            $form->saveStdTitleAndDescription(
                $this->obj_id,
                "blog"
            );
            $form->saveStdTile(
                $this->obj_id,
                "blog"
            );
            $form->saveOnline(
                $this->obj_id,
                "blog"
            );

            $this->notes->activateComments($this->obj_id, (bool) $form->getData("notes"));

            $this->reading_time_gui->saveSettingFromFormAdapter($form);

            $settings = $this->data->settings(
                $this->obj_id,
                (bool) $form->getData("ppic"),
                "",
                "",
                $this->global_settings->get('enable_global_profiles')
                    ? (bool) $form->getData("ppic")
                    : false,
                $this->in_repository
                    ? (bool) $form->getData("approval")
                    : false,
                (bool) $form->getData("abss"),
                (bool) $form->getData("abss")
                    ? (int) $form->getData("abssl")
                    : 0,
                (bool) $form->getData("absi"),
                (bool) $form->getData("absi")
                    ? (int) $form->getData("absiw")
                    : 0,
                (bool) $form->getData("absi")
                    ? (int) $form->getData("absih")
                    : 0,
                (bool) $form->getData("keywords"),
                $this->in_repository
                    ? (bool) $form->getData("nav_authors")
                    : false,
                (int) $form->getData("nav_mode"),
                (int) $form->getData("nav_mode") === \ilObjBlog::NAV_MODE_LIST
                    ? (int) $form->getData("nav_list_mon_with_post")
                    : 0,
                (int) $form->getData("nav_mode") === \ilObjBlog::NAV_MODE_LIST
                    ? (int) $form->getData("nav_list_mon")
                    : 0,
                (int) $form->getData("ov_list_post_num"),
                $old_settings->getOrder()
            );

            $this->domain->blogSettings()->update($settings);

            $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 31 of file class.SettingsGUI.php.

$notes

ILIAS Notes DomainService ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI::$notes

protected

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

$reading_time_gui

ILIAS Blog ReadingTime BlogSettingsGUI ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI::$reading_time_gui

protected

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

---

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

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