ILIAS\Exercise\Assignment\PanelBuilderUI Class Reference

Collaboration diagram for ILIAS\Exercise\Assignment\PanelBuilderUI:

Public Member Functions
	__construct (PropertyAndActionBuilderUI $prop_builder, \ILIAS\UI\Factory $ui_factory, \ILIAS\UI\Renderer $ui_renderer, \ilCtrl $ctrl, \ilLanguage $lng)
	getPanel (Assignment $ass, int $user_id)
	getPanelViews (Assignment $ass, int $user_id)

Protected Member Functions
	addPropertyToItemProperties (array &$props, ?array $prop)
	renderActionButton (\ilTemplate $tpl, ?Component $c)
	renderLinkList (\ilTemplate $tpl, string $sec)

Protected Attributes
ILIAS UI Renderer	$ui_renderer
ilCtrl	$ctrl
ilLanguage	$lng
PropertyAndActionBuilderUI	$prop_builder
ILIAS UI Factory	$ui_factory

Detailed Description

Definition at line 30 of file PanelBuilderUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Exercise\Assignment\PanelBuilderUI::__construct	(	PropertyAndActionBuilderUI	$prop_builder,
		\ILIAS\UI\Factory	$ui_factory,
		\ILIAS\UI\Renderer	$ui_renderer,
		\ilCtrl	$ctrl,
		\ilLanguage	$lng
	)

Definition at line 38 of file PanelBuilderUI.php.

References ILIAS\Exercise\Assignment\PanelBuilderUI\$ctrl, ILIAS\Exercise\Assignment\PanelBuilderUI\$lng, ILIAS\Exercise\Assignment\PanelBuilderUI\$prop_builder, ILIAS\Exercise\Assignment\PanelBuilderUI\$ui_factory, ILIAS\Exercise\Assignment\PanelBuilderUI\$ui_renderer, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->prop_builder = $prop_builder;
        $this->ctrl = $ctrl;
        $this->lng = $lng;
    }

Here is the call graph for this function:

Member Function Documentation

addPropertyToItemProperties()

ILIAS\Exercise\Assignment\PanelBuilderUI::addPropertyToItemProperties ( array &  $props, ?array  $prop  )

protected

Definition at line 52 of file PanelBuilderUI.php.

                                                                               : void
    {
        if ($prop) {
            $props[$prop["prop"]] = $prop["val"];
        }
    }

getPanel()

ILIAS\Exercise\Assignment\PanelBuilderUI::getPanel	(	Assignment	$ass,
		int	$user_id
	)

Definition at line 59 of file PanelBuilderUI.php.

References ILIAS\Exercise\Assignment\PanelBuilderUI\$prop_builder, ILIAS\Exercise\Assignment\Assignment\$title, ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\build(), ILIAS\Exercise\Assignment\Assignment\getTitle(), ILIAS\Repository\lng(), ILIAS\Exercise\Assignment\PanelBuilderUI\renderActionButton(), and ILIAS\Exercise\Assignment\PanelBuilderUI\renderLinkList().

                                                           : \ILIAS\UI\Component\Panel\Standard
    {
        $pb = $this->prop_builder;
        $pb->build($ass, $user_id);

        // schedule card
        $sections = [];
        foreach ($pb->getProperties($pb::SEC_SCHEDULE) as $prop) {
            $sections[] = $this->ui_factory->legacy()->content($prop["prop"] . ": " . $prop["val"]);
        }
        $schedule_card = $this->ui_factory->card()->standard($this->lng->txt("exc_schedule"))
            ->withSections($sections);

        $sub_panels = [];
        $include_schedule = $pb->getInstructionsHidden();
        foreach ($pb->getSections($include_schedule) as $sec => $title) {
            $sec_empty = true;
            $ctpl = new \ilTemplate(
                "tpl.panel_content.html",
                true,
                true,
                "components/ILIAS/Exercise/Assignment"
            );

            // properties
            foreach ($pb->getProperties($sec) as $prop) {
                if ($prop["prop"] === "") {
                    $ctpl->setCurrentBlock("entry_no_label");
                    $ctpl->setVariable("VALUE_NO_LABEL", $prop["val"]);
                    $ctpl->parseCurrentBlock();
                } else {
                    $ctpl->setCurrentBlock("entry");
                    $ctpl->setVariable("LABEL", $prop["prop"]);
                    $ctpl->setVariable("VALUE", $prop["val"]);
                    $ctpl->parseCurrentBlock();
                }
                $sec_empty = false;
            }

            // actions
            $this->renderActionButton($ctpl, $pb->getMainAction($sec));
            foreach ($pb->getActions($sec) as $action) {
                $this->renderActionButton($ctpl, $action);
                $sec_empty = false;
            }

            if (count($pb->getActions($sec)) > 0) {
                $sec_empty = false;
            }

            // links
            $this->renderLinkList($ctpl, $sec);

            $sub_panel = $this->ui_factory->panel()->sub(
                $title,
                $this->ui_factory->legacy()->content($ctpl->get())
            );
            if ($sec === $pb::SEC_INSTRUCTIONS && !$pb->getInstructionsHidden()) {
                $sub_panel = $sub_panel->withFurtherInformation($schedule_card);
                $sec_empty = false;
            }
            if (!$sec_empty) {
                $sub_panels[] = $sub_panel;
            }
        }

        $panel = $this->ui_factory->panel()->standard(
            $ass->getTitle(),
            $sub_panels
        );

        return $panel;
    }

Here is the call graph for this function:

getPanelViews()

ILIAS\Exercise\Assignment\PanelBuilderUI::getPanelViews	(	Assignment	$ass,
		int	$user_id
	)

Definition at line 153 of file PanelBuilderUI.php.

References ILIAS\Exercise\Assignment\PanelBuilderUI\$prop_builder, and ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\build().

                                                                : array
    {
        $pb = $this->prop_builder;
        $pb->build($ass, $user_id);
        return $pb->getViews();
    }

Here is the call graph for this function:

renderActionButton()

ILIAS\Exercise\Assignment\PanelBuilderUI::renderActionButton ( \ilTemplate  $tpl, ?Component  $c  )

protected

Definition at line 133 of file PanelBuilderUI.php.

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by ILIAS\Exercise\Assignment\PanelBuilderUI\getPanel().

                                                                          : void
    {
        if (!is_null($c) && $c instanceof Button) {
            $tpl->setCurrentBlock("action");
            $tpl->setVariable("BUTTON", $this->ui_renderer->render($c));
            $tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderLinkList()

ILIAS\Exercise\Assignment\PanelBuilderUI::renderLinkList ( \ilTemplate  $tpl, string  $sec  )

protected

Definition at line 142 of file PanelBuilderUI.php.

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by ILIAS\Exercise\Assignment\PanelBuilderUI\getPanel().

                                                                    : void
    {
        foreach ($this->prop_builder->getActions($sec) as $action) {
            if ($action instanceof Link) {
                $tpl->setCurrentBlock("link");
                $tpl->setVariable("LINK", $this->ui_renderer->render($action));
                $tpl->parseCurrentBlock();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ILIAS\Exercise\Assignment\PanelBuilderUI::$ctrl

protected

Definition at line 33 of file PanelBuilderUI.php.

Referenced by ILIAS\Exercise\Assignment\PanelBuilderUI\__construct().

$lng

ilLanguage ILIAS\Exercise\Assignment\PanelBuilderUI::$lng

protected

Definition at line 34 of file PanelBuilderUI.php.

Referenced by ILIAS\Exercise\Assignment\PanelBuilderUI\__construct().

$prop_builder

PropertyAndActionBuilderUI ILIAS\Exercise\Assignment\PanelBuilderUI::$prop_builder

protected

Definition at line 35 of file PanelBuilderUI.php.

Referenced by ILIAS\Exercise\Assignment\PanelBuilderUI\__construct(), ILIAS\Exercise\Assignment\PanelBuilderUI\getPanel(), and ILIAS\Exercise\Assignment\PanelBuilderUI\getPanelViews().

$ui_factory

ILIAS UI Factory ILIAS\Exercise\Assignment\PanelBuilderUI::$ui_factory

protected

Definition at line 36 of file PanelBuilderUI.php.

Referenced by ILIAS\Exercise\Assignment\PanelBuilderUI\__construct().

$ui_renderer

ILIAS UI Renderer ILIAS\Exercise\Assignment\PanelBuilderUI::$ui_renderer

protected

Definition at line 32 of file PanelBuilderUI.php.

Referenced by ILIAS\Exercise\Assignment\PanelBuilderUI\__construct().

---

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

• components/ILIAS/Exercise/Assignment/PanelBuilderUI.php