ilFormSectionHeaderGUI Class Reference

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

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

Constructor & Destructor Documentation

__construct()

ilFormSectionHeaderGUI::__construct

(

)

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

References setType().

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

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilFormSectionHeaderGUI::checkInput

(

)

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

                                : bool
    {
        return true;
    }

getInfo()

ilFormSectionHeaderGUI::getInfo

(

)

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

References $info.

Referenced by insert().

                             : string
    {
        return $this->info;
    }

Here is the caller graph for this function:

getParentForm()

ilFormSectionHeaderGUI::getParentForm

(

)

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

References $parentform.

                                   : ilPropertyFormGUI
    {
        return $this->parentform;
    }

getPostVar()

ilFormSectionHeaderGUI::getPostVar

(

)

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

                                : string
    {
        return "";
    }

getSectionIcon()

ilFormSectionHeaderGUI::getSectionIcon

(

)

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

Referenced by insert().

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

Here is the caller graph for this function:

getTitle()

ilFormSectionHeaderGUI::getTitle

(

)

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

References $title.

Referenced by insert().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

ilFormSectionHeaderGUI::getType

(

)

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

References $type.

                             : string
    {
        return $this->type;
    }

insert()

ilFormSectionHeaderGUI::insert

(

ilTemplate

$a_tpl

)

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

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

                                             : 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();
    }

Here is the call graph for this function:

setInfo()

ilFormSectionHeaderGUI::setInfo

(

string

$a_info

)

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

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

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

Here is the call graph for this function:

setParentForm()

ilFormSectionHeaderGUI::setParentForm

(

ilPropertyFormGUI

$a_parentform

)

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

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

setSectionAnchor()

ilFormSectionHeaderGUI::setSectionAnchor

(

string

$value

)

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

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

setSectionIcon()

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

Definition at line 55 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 68 of file class.ilFormSectionHeaderGUI.php.

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

setType()

ilFormSectionHeaderGUI::setType

(

string

$a_type

)

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

Referenced by __construct().

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

Here is the caller graph for this function:

setValueByArray()

ilFormSectionHeaderGUI::setValueByArray

(

array

$a_values

)

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

                                                    : void
    {
    }

Field Documentation

$info

string ilFormSectionHeaderGUI::$info = ""

protected

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

Referenced by getInfo().

$parentform

ilPropertyFormGUI ilFormSectionHeaderGUI::$parentform = null

protected

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

Referenced by getParentForm().

$section_anchor

string ilFormSectionHeaderGUI::$section_anchor = ""

protected

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

$section_icon

array ilFormSectionHeaderGUI::$section_icon = []

protected

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

$title

string ilFormSectionHeaderGUI::$title = ""

protected

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

Referenced by getTitle().

$type

string ilFormSectionHeaderGUI::$type = ""

protected

Definition at line 28 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