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.

References setType().

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilFormSectionHeaderGUI::checkInput ( )

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

     {
         return true;
     }

◆ getInfo()

ilFormSectionHeaderGUI::getInfo ( )

Get Information Text.

Returns: string Information Text

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

References $info.

Referenced by insert().

     {
         return $this->info;
     }

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.

     {
         return $this->parentform;
     }

◆ getPostVar()

ilFormSectionHeaderGUI::getPostVar ( )

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

     {
         // nothing to do since is a header
     }

◆ getSectionIcon()

ilFormSectionHeaderGUI::getSectionIcon ( )

Get section icon.

public

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

Referenced by insert().

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

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().

     {
         return $this->title;
     }

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.

     {
         return $this->type;
     }

◆ insert()

ilFormSectionHeaderGUI::insert ( $a_tpl )

Insert property html.

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

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

     {
         $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 ( $a_info )

Set Information Text.

Parameters

string $a_info Information Text

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

References info().

     {
         $this->info = $a_info;
     }

Here is the call graph for this function:

◆ setParentForm()

ilFormSectionHeaderGUI::setParentForm ( $a_parentform )

Set Parent Form.

Parameters

object $a_parentform Parent Form

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

     {
         $this->parentform = $a_parentform;
     }

◆ setSectionAnchor()

ilFormSectionHeaderGUI::setSectionAnchor ( $value )

set section label;

Parameters

unknown_type $value

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

     {
         $this->section_anchor = $value;
     }

◆ setSectionIcon()

ilFormSectionHeaderGUI::setSectionIcon	(	$a_file,
		$a_alt
	)

Set section icon.

public

Parameters

string	path to icon
string	alternative text

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

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

◆ setTitle()

ilFormSectionHeaderGUI::setTitle ( $a_title )

Set Title.

Parameters

string $a_title Title

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

     {
         $this->title = $a_title;
     }

◆ setType()

ilFormSectionHeaderGUI::setType ( $a_type )

Set Type.

Parameters

string $a_type Type

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

References $a_type.

Referenced by __construct().

     {
         $this->type = $a_type;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilFormSectionHeaderGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

     {
         // nothing to do since is a header
     }

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:

Services/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

◆ $section_anchor

◆ $section_icon

◆ $title

◆ $type