This class represents a non editable value in a property form. More...

Inheritance diagram for ilNonEditableValueGUI:

Collaboration diagram for ilNonEditableValueGUI:

Public Member Functions
	__construct ($a_title="", $a_id="")
	Constructor.
	checkInput ()
	Check input, strip slashes etc.
	setType ($a_type)
	Set Type.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	render ()
	render
	insert (&$a_tpl)
	Insert property html.
	setValueByArray ($a_values)
	Set value by array.
	getTableFilterHTML ()
	Get HTML for table filter.
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem.
	getSubItems ()
	Get Subitems.
	checkSubItemsInput ()
	Check SubItems.
	getSubForm ()
	Get sub form html.
	getItemByPostVar ($a_post_var)
	Get item by post var.
Public Member Functions inherited from ilFormPropertyGUI
&	executeCommand ()
	Execute command.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)

Protected Attributes
	$type
	$value
	$title
	$info
	$section_icon
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()
Protected Attributes inherited from ilFormPropertyGUI
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""

Detailed Description

This class represents a non editable value 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 11 of file class.ilNonEditableValueGUI.php.

Constructor & Destructor Documentation

ilNonEditableValueGUI::__construct	(	$a_title = `""`,
		$a_id = `""`
	)

Constructor.

Parameters

Reimplemented from ilFormPropertyGUI.

Definition at line 24 of file class.ilNonEditableValueGUI.php.

References setTitle(), and setType().

        {
                parent::__construct($a_title, $a_id);
                $this->setTitle($a_title);
                $this->setType("non_editable_value");
        }

Here is the call graph for this function:

Member Function Documentation

ilNonEditableValueGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

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

References $_POST, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), and ilUtil\stripSlashes().

        {
                $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                return $this->checkSubItemsInput();
        }

Here is the call graph for this function:

ilNonEditableValueGUI::getInfo ( )

Get Information Text.

Returns: string Information Text

Reimplemented from ilFormPropertyGUI.

Definition at line 92 of file class.ilNonEditableValueGUI.php.

References $info.

        {
                return $this->info;
        }

ilNonEditableValueGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 162 of file class.ilNonEditableValueGUI.php.

References render().

        {
                $html = $this->render();
                return $html;
        }

Here is the call graph for this function:

ilNonEditableValueGUI::getTitle ( )

Get Title.

Returns: string Title

Reimplemented from ilFormPropertyGUI.

Definition at line 72 of file class.ilNonEditableValueGUI.php.

References $title.

        {
                return $this->title;
        }

ilNonEditableValueGUI::getType ( )

Get Type.

Returns: string Type

Reimplemented from ilFormPropertyGUI.

Definition at line 52 of file class.ilNonEditableValueGUI.php.

References $type.

        {
                return $this->type;
        }

ilNonEditableValueGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 112 of file class.ilNonEditableValueGUI.php.

References $value.

Referenced by render().

        {
                return $this->value;
        }

Here is the caller graph for this function:

ilNonEditableValueGUI::insert ( & $a_tpl )

Insert property html.

Definition at line 135 of file class.ilNonEditableValueGUI.php.

References render().

        {
                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $this->render());
                $a_tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

ilNonEditableValueGUI::render ( )

render

Definition at line 120 of file class.ilNonEditableValueGUI.php.

References $tpl, ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), getValue(), and ilUtil\prepareFormOutput().

Referenced by getTableFilterHTML(), and insert().

        {
                $tpl = new ilTemplate("tpl.non_editable_value.html", true, true, "Services/Form");
                $tpl->setVariable("VALUE", ilUtil::prepareFormOutput($this->getValue()));
                $tpl->setVariable("ID", $this->getFieldId());
                $tpl->setVariable('NON_EDITABLE_ID',$this->getPostVar());
                $tpl->parseCurrentBlock();
                
                return $tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilNonEditableValueGUI::setInfo ( $a_info )

Set Information Text.

Parameters

string $a_info Information Text

Reimplemented from ilFormPropertyGUI.

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

Referenced by ilSetupGUI\initBasicSettingsForm(), and ilObjLinkResourceGUI\initFormLink().

        {
                $this->info = $a_info;
        }

Here is the caller graph for this function:

ilNonEditableValueGUI::setTitle ( $a_title )

Set Title.

Parameters

string $a_title Title

Reimplemented from ilFormPropertyGUI.

Definition at line 62 of file class.ilNonEditableValueGUI.php.

Referenced by __construct().

        {
                $this->title = $a_title;
        }

Here is the caller graph for this function:

ilNonEditableValueGUI::setType ( $a_type )

Set Type.

Parameters

string $a_type Type

Reimplemented from ilFormPropertyGUI.

Definition at line 42 of file class.ilNonEditableValueGUI.php.

Referenced by __construct().

        {
                $this->type = $a_type;
        }

Here is the caller graph for this function:

ilNonEditableValueGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Definition at line 102 of file class.ilNonEditableValueGUI.php.

Referenced by ilPaymentStatisticGUI\addCustomer(), ilObjPaymentSettingsGUI\addCustomerObject(), ilPaymentObjectGUI\addPrice(), ilObjPaymentSettingsGUI\addPriceObject(), ilUserProfile\addStandardFieldsToForm(), ilPaymentObjectGUI\editDetails(), ilObjPaymentSettingsGUI\editDetailsObject(), ilPaymentStatisticGUI\editStatistic(), ilObjPaymentSettingsGUI\editStatisticObject(), ilObjPaymentSettingsGUI\editVendorObject(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationType(), ilCourseRegistrationGUI\fillRegistrationType(), ilSetupGUI\initClientDbForm(), ilSetupGUI\initClientIniForm(), ilSetupGUI\initClientOverviewForm(), ilCalendarAppointmentGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilObjUserGUI\initForm(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjCalendarSettingsGUI\initFormSettings(), ilObjSystemFolderGUI\initServerInfoForm(), ilECSSettingsGUI\initSettingsForm(), ilObjFileBasedLMGUI\initSettingsForm(), ilObjContentObjectGUI\initStylePropertiesForm(), ilObjSCORM2004LearningModuleGUI\initStylePropertiesForm(), ilObjWikiGUI\initStylePropertiesForm(), ilContainerGUI\initStylePropertiesForm(), ilObjForumGUI\initTopicCreateForm(), ilObjCertificateSettingsGUI\settings(), setValueByArray(), ilRegistrationGUI\showCustomFields(), ilPurchaseBMFGUI\showPersonalData(), ilPurchaseBaseGUI\showPersonalData(), ilObjComponentSettingsGUI\showPluginSlotInfo(), and ilPaymentObjectGUI\showSelectedObject().

        {
                $this->value = $a_value;
        }

Here is the caller graph for this function:

ilNonEditableValueGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 147 of file class.ilNonEditableValueGUI.php.

References ilFormPropertyGUI\getPostVar(), ilSubEnabledFormPropertyGUI\getSubItems(), and setValue().

        {
                if (isset($a_values[$this->getPostVar()]))
                {
                        $this->setValue($a_values[$this->getPostVar()]);
                }
                foreach($this->getSubItems() as $item)
                {
                        $item->setValueByArray($a_values);
                }
        }