This class represents a section header in a property form. More...

Collaboration diagram for ilFormSectionHeaderGUI:

Public Member Functions
	__construct ()

	checkInput ()

	setType (string $a_type)

	getType ()

	setSectionIcon (string $a_file, string $a_alt)

	getSectionIcon ()

	setTitle (string $a_title)

	getTitle ()

	setInfo (string $a_info)

	getInfo ()

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setSectionAnchor (string $value)

	insert (ilTemplate $a_tpl)

	setValueByArray (array $a_values)

	getPostVar ()

Protected Attributes
string	$type = ""

string	$title = ""

string	$info = ""

array	$section_icon = []

string	$section_anchor = ""

ilPropertyFormGUI	$parentform = null

Detailed Description

This class represents a section header in a property form.

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

Deprecated:: 12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

◆ __construct()

ilFormSectionHeaderGUI::__construct ( )

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

    {
        $this->setType("section_header");
    }

References setType().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilFormSectionHeaderGUI::checkInput ( )

Definition at line 41 of file class.ilFormSectionHeaderGUI.php.

                                : bool
    {
        return true;
    }

◆ getInfo()

ilFormSectionHeaderGUI::getInfo ( )

Definition at line 84 of file class.ilFormSectionHeaderGUI.php.

                             : string
    {
        return $this->info;
    }

References $info.

◆ getParentForm()

ilFormSectionHeaderGUI::getParentForm ( )

Definition at line 94 of file class.ilFormSectionHeaderGUI.php.

                                   : ilPropertyFormGUI
    {
        return $this->parentform;
    }

◆ getPostVar()

ilFormSectionHeaderGUI::getPostVar ( )

Definition at line 129 of file class.ilFormSectionHeaderGUI.php.

                                : string
    {
        return "";
    }

◆ getSectionIcon()

ilFormSectionHeaderGUI::getSectionIcon ( )

Definition at line 64 of file class.ilFormSectionHeaderGUI.php.

                                    : array
    {
        return $this->section_icon ?: array();
    }

◆ getTitle()

ilFormSectionHeaderGUI::getTitle ( )

Definition at line 74 of file class.ilFormSectionHeaderGUI.php.

                              : string
    {
        return $this->title;
    }

◆ getType()

ilFormSectionHeaderGUI::getType ( )

Definition at line 51 of file class.ilFormSectionHeaderGUI.php.

                             : string
    {
        return $this->type;
    }

References $type.

◆ insert()

ilFormSectionHeaderGUI::insert ( ilTemplate $a_tpl )

Definition at line 104 of file class.ilFormSectionHeaderGUI.php.

                                             : void
    {
        $section_icon = $this->getSectionIcon();
 
        if (isset($section_icon['file']) && is_file($section_icon['file'])) {
            $a_tpl->setCurrentBlock("title_icon");
            $a_tpl->setVariable("IMG_ICON", $section_icon['file']);
            $a_tpl->setVariable('IMG_ALT', $section_icon['alt']);
            $a_tpl->parseCurrentBlock();
        }
 
        $a_tpl->setCurrentBlock("header");
        $a_tpl->setVariable("TXT_TITLE", $this->getTitle());
        $a_tpl->setVariable("TXT_DESCRIPTION", $this->getInfo());
        $a_tpl->setVariable('HEAD_COLSPAN', 2);
        if (isset($this->section_anchor)) {
            $a_tpl->setVariable('LABEL', $this->section_anchor);
        }
        $a_tpl->parseCurrentBlock();
    }

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ setInfo()

ilFormSectionHeaderGUI::setInfo ( string $a_info )

Definition at line 79 of file class.ilFormSectionHeaderGUI.php.

                                           : void
    {
        $this->info = $a_info;
    }

References ILIAS\UI\examples\MessageBox\Info\info().

Here is the call graph for this function:

◆ setParentForm()

ilFormSectionHeaderGUI::setParentForm ( ilPropertyFormGUI $a_parentform )

Definition at line 89 of file class.ilFormSectionHeaderGUI.php.

                                                                  : void
    {
        $this->parentform = $a_parentform;
    }

◆ setSectionAnchor()

ilFormSectionHeaderGUI::setSectionAnchor ( string $value )

Definition at line 99 of file class.ilFormSectionHeaderGUI.php.

                                                   : void
    {
        $this->section_anchor = $value;
    }

◆ setSectionIcon()

ilFormSectionHeaderGUI::setSectionIcon	(	string	$a_file,
		string	$a_alt
	)

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

     : void {
        $this->section_icon['file'] = $a_file;
        $this->section_icon['alt'] = $a_alt;
    }

◆ setTitle()

ilFormSectionHeaderGUI::setTitle ( string $a_title )

Definition at line 69 of file class.ilFormSectionHeaderGUI.php.

                                             : void
    {
        $this->title = $a_title;
    }

◆ setType()

ilFormSectionHeaderGUI::setType ( string $a_type )

Definition at line 46 of file class.ilFormSectionHeaderGUI.php.

                                           : void
    {
        $this->type = $a_type;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setValueByArray()

ilFormSectionHeaderGUI::setValueByArray ( array $a_values )

Definition at line 125 of file class.ilFormSectionHeaderGUI.php.

                                                    : void
    {
    }

Field Documentation

◆ $info

string ilFormSectionHeaderGUI::$info = ""

protected

Definition at line 31 of file class.ilFormSectionHeaderGUI.php.

◆ $parentform

ilPropertyFormGUI ilFormSectionHeaderGUI::$parentform = null

protected

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

◆ $section_anchor

string ilFormSectionHeaderGUI::$section_anchor = ""

protected

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

◆ $section_icon

array ilFormSectionHeaderGUI::$section_icon = []

protected

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

◆ $title

string ilFormSectionHeaderGUI::$title = ""

protected

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

◆ $type

string ilFormSectionHeaderGUI::$type = ""

protected

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

Referenced by getType().

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

components/ILIAS/Form/classes/class.ilFormSectionHeaderGUI.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getInfo()

◆ getParentForm()

◆ getPostVar()

◆ getSectionIcon()

◆ getTitle()

◆ getType()

◆ insert()

◆ setInfo()

◆ setParentForm()

◆ setSectionAnchor()

◆ setSectionIcon()

◆ setTitle()

◆ setType()

◆ setValueByArray()

Field Documentation

◆ $info

◆ $parentform

◆ $section_anchor

◆ $section_icon

◆ $title

◆ $type