ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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
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.

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

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.

41 : bool
42 {
43 return true;
44 }

◆ getInfo()

ilFormSectionHeaderGUI::getInfo ( )

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

84 : string
85 {
86 return $this->info;
87 }

References $info.

◆ getParentForm()

ilFormSectionHeaderGUI::getParentForm ( )

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

95 {
96 return $this->parentform;
97 }
This class represents a property form user interface.

◆ getPostVar()

ilFormSectionHeaderGUI::getPostVar ( )

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

129 : string
130 {
131 return "";
132 }

◆ getSectionIcon()

ilFormSectionHeaderGUI::getSectionIcon ( )

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

64 : array
65 {
66 return $this->section_icon ?: array();
67 }

◆ getTitle()

ilFormSectionHeaderGUI::getTitle ( )

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

74 : string
75 {
76 return $this->title;
77 }

◆ getType()

ilFormSectionHeaderGUI::getType ( )

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

51 : string
52 {
53 return $this->type;
54 }

References $type.

◆ insert()

ilFormSectionHeaderGUI::insert ( ilTemplate  $a_tpl)

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

104 : void
105 {
106 $section_icon = $this->getSectionIcon();
107
108 if (isset($section_icon['file']) && is_file($section_icon['file'])) {
109 $a_tpl->setCurrentBlock("title_icon");
110 $a_tpl->setVariable("IMG_ICON", $section_icon['file']);
111 $a_tpl->setVariable('IMG_ALT', $section_icon['alt']);
112 $a_tpl->parseCurrentBlock();
113 }
114
115 $a_tpl->setCurrentBlock("header");
116 $a_tpl->setVariable("TXT_TITLE", $this->getTitle());
117 $a_tpl->setVariable("TXT_DESCRIPTION", $this->getInfo());
118 $a_tpl->setVariable('HEAD_COLSPAN', 2);
119 if (isset($this->section_anchor)) {
120 $a_tpl->setVariable('LABEL', $this->section_anchor);
121 }
122 $a_tpl->parseCurrentBlock();
123 }
setVariable($variable, $value='')
Sets a variable value.
Definition: IT.php:544
setCurrentBlock(string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)
parseCurrentBlock(string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)

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.

79 : void
80 {
81 $this->info = $a_info;
82 }

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.

89 : void
90 {
91 $this->parentform = $a_parentform;
92 }

◆ setSectionAnchor()

ilFormSectionHeaderGUI::setSectionAnchor ( string  $value)

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

99 : void
100 {
101 $this->section_anchor = $value;
102 }

◆ setSectionIcon()

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

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

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

◆ setTitle()

ilFormSectionHeaderGUI::setTitle ( string  $a_title)

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

69 : void
70 {
71 $this->title = $a_title;
72 }

◆ setType()

ilFormSectionHeaderGUI::setType ( string  $a_type)

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

46 : void
47 {
48 $this->type = $a_type;
49 }

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.

125 : void
126 {
127 }

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: