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="", $a_disable_escaping=false)
	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.
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively
	checkSubItemsInput ()
	Check SubItems.
	getSubForm ()
	Get sub form html.
	getItemByPostVar ($a_post_var)
	Get item by post var.
Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor.
&	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)
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi.
	getMulti ()
	Get Multi.
	setMultiValues (array $a_values)
	Set multi values.
	getMultiValues ()
	Get multi values.
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g.

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

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	getMultiIconsHTML ()
	Get HTML for multiple value icons.

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 13 of file class.ilNonEditableValueGUI.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters

Reimplemented in ilNestedOrderingGUI.

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

References setTitle(), and setType().

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

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.

Reimplemented in ilNestedOrderingGUI.

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

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

        {
                if(!is_array($_POST[$this->getPostVar()]))
                {
                        $_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 99 of file class.ilNonEditableValueGUI.php.

References $info.

        {
                return $this->info;
        }

ilNonEditableValueGUI::getTableFilterHTML ( )

Get HTML for table filter.

Implements ilTableFilterItem.

Definition at line 198 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 79 of file class.ilNonEditableValueGUI.php.

References $title.

Referenced by ilPaymentObjectGUI\showSelectedObject().

        {
                return $this->title;
        }

Here is the caller graph for this function:

ilNonEditableValueGUI::getType ( )

Get Type.

Returns: string Type

Reimplemented from ilFormPropertyGUI.

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

References $type.

        {
                return $this->type;
        }

ilNonEditableValueGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 124 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 171 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 132 of file class.ilNonEditableValueGUI.php.

References ilFormPropertyGUI\$postvar, $tpl, $value, ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getMulti(), ilFormPropertyGUI\getMultiIconsHTML(), ilFormPropertyGUI\getPostVar(), getValue(), and ilUtil\prepareFormOutput().

Referenced by getTableFilterHTML(), and insert().

        {
                $tpl = new ilTemplate("tpl.non_editable_value.html", true, true, "Services/Form");
                if ($this->getPostVar() != "")
                {
                        $postvar = $this->getPostVar();
                        if($this->getMulti() && substr($postvar, -2) != "[]")
                        {
                                $postvar .= "[]";
                        }
                        
                        $tpl->setCurrentBlock("hidden");
                        $tpl->setVariable('NON_EDITABLE_ID', $postvar);
                        $tpl->setVariable('MULTI_HIDDEN_ID', $this->getFieldId());
                        $tpl->setVariable("HVALUE", ilUtil::prepareFormOutput($this->getValue()));
                        $tpl->parseCurrentBlock();
                }
                $value = $this->getValue();
                if(!$this->disable_escaping)
                {
                        $value = ilUtil::prepareFormOutput($value);
                }
                $tpl->setVariable("VALUE", $value);
                $tpl->setVariable("ID", $this->getFieldId());
                $tpl->parseCurrentBlock();
                
                if ($this->getMulti() && $postvar!= "" && !$this->getDisabled())
                {
                        $tpl->setVariable("MULTI_ICONS", $this->getMultiIconsHTML());
                }
                
                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 89 of file class.ilNonEditableValueGUI.php.

Referenced by ilSetupGUI\initBasicSettingsForm(), ilObjLinkResourceGUI\initFormLink(), ilBlogPostingGUI\initKeywordsForm(), and ilLicenseGUI\initLicenseForm().

        {
                $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 69 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 49 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 109 of file class.ilNonEditableValueGUI.php.

References ilFormPropertyGUI\getMulti(), and ilFormPropertyGUI\setMultiValues().

Referenced by ilPaymentStatisticGUI\addCustomer(), ilObjPaymentSettingsGUI\addCustomerObject(), ilMemberAgreementGUI\addCustomFields(), ilUserProfile\addStandardFieldsToForm(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilObjTestDynamicQuestionSetConfigGUI\buildForm(), ilTestScoringGUI\buildManScoringParticipantForm(), ilECSMappingSettingsGUI\dInitFormTreeSettings(), ilObjPaymentSettingsGUI\editDetailsObject(), ilBasicSkillGUI\editLevelTrigger(), ilPaymentStatisticGUI\editStatistic(), ilObjPaymentSettingsGUI\editStatisticObject(), ilObjPaymentSettingsGUI\editVendorObject(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationType(), ilDataCollectionDatatype\getInputField(), ilSetupGUI\initClientDbForm(), ilSetupGUI\initClientIniForm(), ilSetupGUI\initClientOverviewForm(), ilObjPortfolioGUI\initCreatePortfolioFromTemplateForm(), ilSetupGUI\initDbSlaveForm(), ilLearningProgressBaseGUI\initEditUserForm(), ilAdvancedMDSettingsGUI\initFieldForm(), ilPageLayoutGUI\initForm(), ilCalendarAppointmentGUI\initForm(), ilSkillTemplateReferenceGUI\initForm(), ilDataCollectionFieldEditGUI\initForm(), ilObjMediaObjectGUI\initForm(), ilObjUserGUI\initForm(), ilConditionHandlerGUI\initFormCondition(), ilObjUserFolderGUI\initFormGeneralSettings(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjRoleTemplateGUI\initFormRoleTemplate(), ilObjCalendarSettingsGUI\initFormSettings(), ilObjSCORM2004LearningModuleGUI\initPropertiesEditableForm(), ilObjSCORM2004LearningModuleGUI\initPropertiesForm(), ilObjSurveyGUI\initPropertiesForm(), ilObjSystemFolderGUI\initServerInfoForm(), ilObjFileBasedLMGUI\initSettingsForm(), ilECSSettingsGUI\initSettingsForm(), ilSetupGUI\initSettingsTypeForm(), ilObjContentObjectGUI\initStylePropertiesForm(), ilObjPortfolioBaseGUI\initStylePropertiesForm(), ilObjSCORM2004LearningModuleGUI\initStylePropertiesForm(), ilObjWikiGUI\initStylePropertiesForm(), ilObjGlossaryGUI\initStylePropertiesForm(), ilObjBlogGUI\initStylePropertiesForm(), ilContainerGUI\initStylePropertiesForm(), ilObjPaymentSettingsGUI\InvoiceNumberObject(), ilObjSCORMLearningModuleGUI\properties(), ilObjCertificateSettingsGUI\settings(), setValueByArray(), ilRegistrationGUI\showCustomFields(), ilShopPurchaseGUI\showDetails(), ilAssQuestionHintRequestGUI\showHintCmd(), ilPurchaseBMFGUI\showPersonalData(), ilPurchaseBaseGUI\showPersonalData(), ilObjComponentSettingsGUI\showPluginSlotInfo(), and ilPaymentObjectGUI\showSelectedObject().

        {               
                if($this->getMulti() && is_array($a_value))
                {                                               
                        $this->setMultiValues($a_value);        
                        $a_value = array_shift($a_value);               
                }       
                $this->value = $a_value;
        }

Here is the call graph for this function:

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 183 of file class.ilNonEditableValueGUI.php.

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

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