This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilPanelGUI:

Public Member Functions
	setHeading (string $a_val)

	getHeading ()

	setBody (string $a_val)

	getBody ()

	setFooter (string $a_val)

	getFooter ()

	setPanelStyle (int $a_val)

	getPanelStyle ()

	setHeadingStyle (int $a_val)

	getHeadingStyle ()

	setFooterStyle (int $a_val)

	getFooterStyle ()

	getHTML ()

Static Public Member Functions
static	getInstance ()

Data Fields
const	PANEL_STYLE_PRIMARY = 0

const	PANEL_STYLE_SECONDARY = 1

const	HEADING_STYLE_SUBHEADING = 0

const	HEADING_STYLE_BLOCK = 1

const	FOOTER_STYLE_BLOCK = 0

Protected Member Functions
	__construct ()

Protected Attributes
string	$heading = ""

string	$body = ""

string	$footer = ""

int	$panel_style = 0

int	$heading_style = 0

int	$footer_style = 0

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Simple panel class

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 24 of file class.ilPanelGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPanelGUI::__construct ( )

protected

Definition at line 39 of file class.ilPanelGUI.php.

40 {

41 }

Member Function Documentation

◆ getBody()

ilPanelGUI::getBody ( )

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

                             : string
    {
        return $this->body;
    }

References $body.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getFooter()

ilPanelGUI::getFooter ( )

Definition at line 73 of file class.ilPanelGUI.php.

                               : string
    {
        return $this->footer;
    }

References $footer.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getFooterStyle()

ilPanelGUI::getFooterStyle ( )

Definition at line 103 of file class.ilPanelGUI.php.

                                    : int
    {
        return $this->footer_style;
    }

References $footer_style.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHeading()

ilPanelGUI::getHeading ( )

Definition at line 53 of file class.ilPanelGUI.php.

                                : string
    {
        return $this->heading;
    }

References $heading.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHeadingStyle()

ilPanelGUI::getHeadingStyle ( )

Definition at line 93 of file class.ilPanelGUI.php.

                                     : int
    {
        return $this->heading_style;
    }

References $heading_style.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHTML()

ilPanelGUI::getHTML ( )

Definition at line 108 of file class.ilPanelGUI.php.

                             : string
    {
        $tpl = new ilTemplate("tpl.panel.html", true, true, "Services/UIComponent/Panel");
 
        $head_outer_div_style = "";
        if ($this->getHeading() !== "") {
            $tpl->setCurrentBlock("heading");
            $tpl->setVariable("HEADING", $this->getHeading());
 
            switch ($this->getHeadingStyle()) {
                case self::HEADING_STYLE_BLOCK:
                    $tpl->setVariable("HEAD_DIV_STYLE", "panel-heading ilBlockHeader");
                    $tpl->setVariable("HEAD_H3_STYLE", "ilBlockHeader");
                    $head_outer_div_style = "il_Block";
                    break;
 
                case self::HEADING_STYLE_SUBHEADING:
                    $tpl->setVariable("HEAD_DIV_STYLE", "panel-heading ilHeader");
                    $tpl->setVariable("HEAD_H3_STYLE", "ilHeader");
                    break;
            }
 
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setVariable("BODY", $this->getBody());
 
        if ($this->getFooter() !== "") {
            $tpl->setCurrentBlock("footer");
            $tpl->setVariable("FOOTER", $this->getFooter());
 
            switch ($this->getFooterStyle()) {
                case self::FOOTER_STYLE_BLOCK:
                    $tpl->setVariable("FOOT_DIV_STYLE", "panel-footer ilBlockInfo");
                    break;
            }
 
            $tpl->parseCurrentBlock();
        }
 
        switch ($this->getPanelStyle()) {
            case self::PANEL_STYLE_SECONDARY:
                $tpl->setVariable("PANEL_STYLE", "panel panel-default " . $head_outer_div_style);
                break;
 
            default:
                $tpl->setVariable("PANEL_STYLE", "panel panel-primary " . $head_outer_div_style);
                break;
        }
 
        return $tpl->get();
    }

References $tpl, FOOTER_STYLE_BLOCK, getBody(), getFooter(), getFooterStyle(), getHeading(), getHeadingStyle(), getPanelStyle(), HEADING_STYLE_BLOCK, HEADING_STYLE_SUBHEADING, and PANEL_STYLE_SECONDARY.

Here is the call graph for this function:

◆ getInstance()

static ilPanelGUI::getInstance ( )

static

Definition at line 43 of file class.ilPanelGUI.php.

                                        : self
    {
        return new ilPanelGUI();
    }

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), SurveyQuestionGUI\addMaterial(), ilTestQuestionSideListGUI\buildPanel(), ilPersonalSkillsGUI\getGapAnalysisHTML(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilUsersGalleryGUI\populateTemplate(), SurveyQuestionGUI\preview(), ilSurveyExecutionGUI\runShowFinishedPage(), ilSystemSupportContactsGUI\showContacts(), ilExPeerReviewGUI\showPeerReviewOverviewObject(), and ilChatroomViewGUI\showRoom().

Here is the caller graph for this function:

◆ getPanelStyle()

ilPanelGUI::getPanelStyle ( )

Definition at line 83 of file class.ilPanelGUI.php.

                                   : int
    {
        return $this->panel_style;
    }

References $panel_style.

Referenced by getHTML().

Here is the caller graph for this function:

◆ setBody()

ilPanelGUI::setBody ( string $a_val )

Definition at line 58 of file class.ilPanelGUI.php.

                                          : void
    {
        $this->body = $a_val;
    }

◆ setFooter()

ilPanelGUI::setFooter ( string $a_val )

Definition at line 68 of file class.ilPanelGUI.php.

                                            : void
    {
        $this->footer = $a_val;
    }

References ILIAS\UI\examples\MainControls\Footer\footer().

Here is the call graph for this function:

◆ setFooterStyle()

ilPanelGUI::setFooterStyle ( int $a_val )

Definition at line 98 of file class.ilPanelGUI.php.

                                              : void
    {
        $this->footer_style = $a_val;
    }

◆ setHeading()

ilPanelGUI::setHeading ( string $a_val )

Definition at line 48 of file class.ilPanelGUI.php.

                                             : void
    {
        $this->heading = $a_val;
    }

◆ setHeadingStyle()

ilPanelGUI::setHeadingStyle ( int $a_val )

Definition at line 88 of file class.ilPanelGUI.php.

                                               : void
    {
        $this->heading_style = $a_val;
    }

◆ setPanelStyle()

ilPanelGUI::setPanelStyle ( int $a_val )

Definition at line 78 of file class.ilPanelGUI.php.

                                             : void
    {
        $this->panel_style = $a_val;
    }

Field Documentation

◆ $body

string ilPanelGUI::$body = ""

protected

Definition at line 33 of file class.ilPanelGUI.php.

Referenced by getBody().

◆ $footer

string ilPanelGUI::$footer = ""

protected

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

Referenced by getFooter().

◆ $footer_style

int ilPanelGUI::$footer_style = 0

protected

Definition at line 37 of file class.ilPanelGUI.php.

Referenced by getFooterStyle().

◆ $heading

string ilPanelGUI::$heading = ""

protected

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

Referenced by getHeading().

◆ $heading_style

int ilPanelGUI::$heading_style = 0

protected

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

Referenced by getHeadingStyle().

◆ $panel_style

int ilPanelGUI::$panel_style = 0

protected

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

Referenced by getPanelStyle().

◆ FOOTER_STYLE_BLOCK

const ilPanelGUI::FOOTER_STYLE_BLOCK = 0

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

Referenced by getHTML().

◆ HEADING_STYLE_BLOCK

const ilPanelGUI::HEADING_STYLE_BLOCK = 1

Definition at line 29 of file class.ilPanelGUI.php.

Referenced by getHTML(), and ilChatroomViewGUI\showRoom().

◆ HEADING_STYLE_SUBHEADING

const ilPanelGUI::HEADING_STYLE_SUBHEADING = 0

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

Referenced by ilTestQuestionSideListGUI\buildPanel(), and getHTML().

◆ PANEL_STYLE_PRIMARY

const ilPanelGUI::PANEL_STYLE_PRIMARY = 0

Definition at line 26 of file class.ilPanelGUI.php.

Referenced by ilPersonalSkillsGUI\getGapAnalysisHTML(), and ilSystemSupportContactsGUI\showContacts().

◆ PANEL_STYLE_SECONDARY

const ilPanelGUI::PANEL_STYLE_SECONDARY = 1

Definition at line 27 of file class.ilPanelGUI.php.

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), ilTestQuestionSideListGUI\buildPanel(), getHTML(), ilLPListOfSettingsGUI\handleLPUsageInfo(), and ilChatroomViewGUI\showRoom().

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

Services/UIComponent/Panel/classes/class.ilPanelGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBody()

◆ getFooter()

◆ getFooterStyle()

◆ getHeading()

◆ getHeadingStyle()

◆ getHTML()

◆ getInstance()

◆ getPanelStyle()

◆ setBody()

◆ setFooter()

◆ setFooterStyle()

◆ setHeading()

◆ setHeadingStyle()

◆ setPanelStyle()

Field Documentation

◆ $body

◆ $footer

◆ $footer_style

◆ $heading

◆ $heading_style

◆ $panel_style

◆ FOOTER_STYLE_BLOCK

◆ HEADING_STYLE_BLOCK

◆ HEADING_STYLE_SUBHEADING

◆ PANEL_STYLE_PRIMARY

◆ PANEL_STYLE_SECONDARY