ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilFormSectionHeaderGUI Class Reference

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

+ Collaboration diagram for ilFormSectionHeaderGUI:

Public Member Functions

 __construct ()
 Constructor. More...
 
 checkInput ()
 
 setType ($a_type)
 Set Type. More...
 
 getType ()
 Get Type. More...
 
 setSectionIcon ($a_file, $a_alt)
 Set section icon. More...
 
 getSectionIcon ()
 Get section icon. More...
 
 setTitle ($a_title)
 Set Title. More...
 
 getTitle ()
 Get Title. More...
 
 setInfo ($a_info)
 Set Information Text. More...
 
 getInfo ()
 Get Information Text. More...
 
 setParentForm ($a_parentform)
 Set Parent Form. More...
 
 getParentForm ()
 Get Parent Form. More...
 
 setSectionAnchor ($value)
 set section label; More...
 
 insert (&$a_tpl)
 Insert property html. More...
 
 setValueByArray ($a_values)
 Set value by array. More...
 
 getPostVar ()
 

Protected Attributes

 $type
 
 $title
 
 $info
 
 $section_icon
 
 $section_anchor
 

Detailed Description

This class represents a section header in a property form.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilFormSectionHeaderGUI::__construct ( )

Constructor.

Parameters

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

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

References setType().

+ Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilFormSectionHeaderGUI::checkInput ( )

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

50 {
51 return true;
52 }

◆ getInfo()

ilFormSectionHeaderGUI::getInfo ( )

Get Information Text.

Returns
string Information Text

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

References $info.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getParentForm()

ilFormSectionHeaderGUI::getParentForm ( )

Get Parent Form.

Returns
object Parent Form

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

155 {
156 return $this->parentform;
157 }

◆ getPostVar()

ilFormSectionHeaderGUI::getPostVar ( )

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

204 {
205 // nothing to do since is a header
206 }

◆ getSectionIcon()

ilFormSectionHeaderGUI::getSectionIcon ( )

Get section icon.

@access public

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

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

Referenced by insert().

+ Here is the caller graph for this function:

◆ getTitle()

ilFormSectionHeaderGUI::getTitle ( )

Get Title.

Returns
string Title

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

References $title.

Referenced by insert().

+ Here is the caller graph for this function:

◆ getType()

ilFormSectionHeaderGUI::getType ( )

Get Type.

Returns
string Type

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

References $type.

◆ insert()

ilFormSectionHeaderGUI::insert ( $a_tpl)

Insert property html.

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

173 {
174 $section_icon = $this->getSectionIcon();
175
176 if(isset($section_icon['file']) && is_file($section_icon['file']))
177 {
178 $a_tpl->setCurrentBlock("title_icon");
179 $a_tpl->setVariable("IMG_ICON",$section_icon['file']);
180 $a_tpl->setVariable('IMG_ALT',$section_icon['alt']);
181 $a_tpl->parseCurrentBlock();
182 }
183
184 $a_tpl->setCurrentBlock("header");
185 $a_tpl->setVariable("TXT_TITLE", $this->getTitle());
186 $a_tpl->setVariable("TXT_DESCRIPTION", $this->getInfo());
187 $a_tpl->setVariable('HEAD_COLSPAN',2);
188 if (isset($this->section_anchor))
189 $a_tpl->setVariable('LABEL', $this->section_anchor);
190 $a_tpl->parseCurrentBlock();
191 }

References $section_icon, getInfo(), getSectionIcon(), and getTitle().

+ Here is the call graph for this function:

◆ setInfo()

ilFormSectionHeaderGUI::setInfo (   $a_info)

Set Information Text.

Parameters
string$a_infoInformation Text

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

125 {
126 $this->info = $a_info;
127 }

◆ setParentForm()

ilFormSectionHeaderGUI::setParentForm (   $a_parentform)

Set Parent Form.

Parameters
object$a_parentformParent Form

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

145 {
146 $this->parentform = $a_parentform;
147 }

◆ setSectionAnchor()

ilFormSectionHeaderGUI::setSectionAnchor (   $value)

set section label;

Parameters
unknown_type$value

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

164 {
165 $this->section_anchor = $value;
166 }

◆ setSectionIcon()

ilFormSectionHeaderGUI::setSectionIcon (   $a_file,
  $a_alt 
)

Set section icon.

@access public

Parameters
stringpath to icon
stringalternative text

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

83 {
84 $this->section_icon['file'] = $a_file;
85 $this->section_icon['alt'] = $a_alt;
86 }

◆ setTitle()

ilFormSectionHeaderGUI::setTitle (   $a_title)

Set Title.

Parameters
string$a_titleTitle

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

105 {
106 $this->title = $a_title;
107 }

◆ setType()

ilFormSectionHeaderGUI::setType (   $a_type)

Set Type.

Parameters
string$a_typeType

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

60 {
61 $this->type = $a_type;
62 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setValueByArray()

ilFormSectionHeaderGUI::setValueByArray (   $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

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

199 {
200 // nothing to do since is a header
201 }

Field Documentation

◆ $info

ilFormSectionHeaderGUI::$info
protected

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

Referenced by getInfo().

◆ $section_anchor

ilFormSectionHeaderGUI::$section_anchor
protected

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

◆ $section_icon

ilFormSectionHeaderGUI::$section_icon
protected

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

Referenced by insert().

◆ $title

ilFormSectionHeaderGUI::$title
protected

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

Referenced by getTitle().

◆ $type

ilFormSectionHeaderGUI::$type
protected

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

Referenced by getType().


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