Public Member Functions | Protected Member Functions | Protected Attributes

ilFormPropertyGUI Class Reference
[Services/Form]

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

Inheritance diagram for ilFormPropertyGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor.
 getType ()
 Get Type.
 setTitle ($a_title)
 Set Title.
 getTitle ()
 Get Title.
 setPostVar ($a_postvar)
 Set Post Variable.
 getPostVar ()
 Get Post Variable.
 getFieldId ()
 Get Post Variable.
 setInfo ($a_info)
 Set Information Text.
 getInfo ()
 Get Information Text.
 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.
 checkInput ()
 Check input, strip slashes etc.
 getSubForm ()
 Get sub form html.
 getSubformMode ()

Protected Member Functions

 setType ($a_type)
 Set Type.

Protected Attributes

 $type
 $title
 $postvar
 $info
 $alert
 $required = false

Detailed Description

This class represents a property in a property form.

Author:
Alex Killing <alex.killing@gmx.de>
Version:
$Id$

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

Constructor & Destructor Documentation

ilFormPropertyGUI::__construct ( $  a_title = "",
$  a_postvar = "" 
)

Constructor.

Parameters:
string $a_title Title
string $a_postvar Post Variable

Reimplemented in ilCheckboxInputGUI, ilCustomInputGUI, ilDateTimeInputGUI, ilDurationInputGUI, ilFeedUrlInputGUI, ilFileInputGUI, ilImageFileInputGUI, ilLocationInputGUI, ilRadioGroupInputGUI, ilRegExpInputGUI, ilSelectInputGUI, ilTextAreaInputGUI, and ilTextInputGUI.

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

References setDisabled(), setPostVar(), and setTitle().

        {
                $this->setTitle($a_title);
                $this->setPostVar($a_postvar);
                $this->setDisabled(false);
        }

Here is the call graph for this function:

Member Function Documentation

ilFormPropertyGUI::checkInput (  ) 

Check input, strip slashes etc.

set alert, if input is not ok.

Returns:
boolean Input ok, true/false

Reimplemented in ilCheckboxInputGUI, ilDateTimeInputGUI, ilDurationInputGUI, ilFeedUrlInputGUI, ilFileInputGUI, ilLocationInputGUI, ilRadioGroupInputGUI, ilRegExpInputGUI, ilSelectInputGUI, ilTextAreaInputGUI, and ilTextInputGUI.

Definition at line 211 of file class.ilFormPropertyGUI.php.

        {
                return false;           // please overwrite
        }

ilFormPropertyGUI::getAlert (  ) 

Get Alert Text.

Returns:
string Alert Text

Definition at line 161 of file class.ilFormPropertyGUI.php.

        {
                return $this->alert;
        }

ilFormPropertyGUI::getDisabled (  ) 

Get Disabled.

Returns:
boolean Disabled

Definition at line 201 of file class.ilFormPropertyGUI.php.

Referenced by ilTextInputGUI::insert(), ilTextAreaInputGUI::insert(), ilSelectInputGUI::insert(), ilRadioGroupInputGUI::insert(), and ilDateTimeInputGUI::insert().

        {
                return $this->disabled;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getFieldId (  ) 

Get Post Variable.

Returns:
string Post Variable

Definition at line 118 of file class.ilFormPropertyGUI.php.

References getPostVar().

Referenced by ilTextInputGUI::insert(), ilTextAreaInputGUI::insert(), ilRadioGroupInputGUI::insert(), ilImageFileInputGUI::insert(), ilFileInputGUI::insert(), and ilCheckboxInputGUI::insert().

        {
                $id = str_replace("[", "__", $this->getPostVar());
                $id = str_replace("]", "__", $id);
                
                return $id;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilFormPropertyGUI::getInfo (  ) 

Get Information Text.

Returns:
string Information Text

Definition at line 141 of file class.ilFormPropertyGUI.php.

        {
                return $this->info;
        }

ilFormPropertyGUI::getPostVar (  ) 

Get Post Variable.

Returns:
string Post Variable

Definition at line 108 of file class.ilFormPropertyGUI.php.

Referenced by ilTextInputGUI::checkInput(), ilTextAreaInputGUI::checkInput(), ilSelectInputGUI::checkInput(), ilRegExpInputGUI::checkInput(), ilRadioGroupInputGUI::checkInput(), ilLocationInputGUI::checkInput(), ilFileInputGUI::checkInput(), ilFeedUrlInputGUI::checkInput(), ilDurationInputGUI::checkInput(), ilDateTimeInputGUI::checkInput(), ilCheckboxInputGUI::checkInput(), getFieldId(), ilTextInputGUI::insert(), ilTextAreaInputGUI::insert(), ilSelectInputGUI::insert(), ilRadioGroupInputGUI::insert(), ilLocationInputGUI::insert(), ilImageFileInputGUI::insert(), ilFileInputGUI::insert(), ilDurationInputGUI::insert(), ilDateTimeInputGUI::insert(), ilCheckboxInputGUI::insert(), ilTextInputGUI::setValueByArray(), ilTextAreaInputGUI::setValueByArray(), ilSelectInputGUI::setValueByArray(), ilRadioGroupInputGUI::setValueByArray(), ilLocationInputGUI::setValueByArray(), ilDurationInputGUI::setValueByArray(), ilDateTimeInputGUI::setValueByArray(), and ilCheckboxInputGUI::setValueByArray().

        {
                return $this->postvar;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getRequired (  ) 

Get Required.

Returns:
boolean Required

Definition at line 181 of file class.ilFormPropertyGUI.php.

Referenced by ilTextInputGUI::checkInput(), ilTextAreaInputGUI::checkInput(), ilSelectInputGUI::checkInput(), ilRegExpInputGUI::checkInput(), ilRadioGroupInputGUI::checkInput(), ilLocationInputGUI::checkInput(), ilFileInputGUI::checkInput(), and ilFeedUrlInputGUI::checkInput().

        {
                return $this->required;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::getSubForm (  ) 

Get sub form html.

Reimplemented in ilSubEnabledFormPropertyGUI.

Definition at line 220 of file class.ilFormPropertyGUI.php.

        {
                return "";
        }

ilFormPropertyGUI::getSubformMode (  ) 

Reimplemented in ilSubEnabledFormPropertyGUI.

Definition at line 225 of file class.ilFormPropertyGUI.php.

        {
                return "none";
        }

ilFormPropertyGUI::getTitle (  ) 

Get Title.

Returns:
string Title

Definition at line 88 of file class.ilFormPropertyGUI.php.

        {
                return $this->title;
        }

ilFormPropertyGUI::getType (  ) 

Get Type.

Returns:
string Type

Definition at line 68 of file class.ilFormPropertyGUI.php.

        {
                return $this->type;
        }

ilFormPropertyGUI::setAlert ( $  a_alert  ) 

Set Alert Text.

Parameters:
string $a_alert Alert Text

Definition at line 151 of file class.ilFormPropertyGUI.php.

Referenced by ilTextInputGUI::checkInput(), ilTextAreaInputGUI::checkInput(), ilSelectInputGUI::checkInput(), ilRegExpInputGUI::checkInput(), ilRadioGroupInputGUI::checkInput(), ilLocationInputGUI::checkInput(), ilFileInputGUI::checkInput(), ilFeedUrlInputGUI::checkInput(), and ilDateTimeInputGUI::checkInput().

        {
                $this->alert = $a_alert;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setDisabled ( $  a_disabled  ) 

Set Disabled.

Parameters:
boolean $a_disabled Disabled

Definition at line 191 of file class.ilFormPropertyGUI.php.

Referenced by __construct().

        {
                $this->disabled = $a_disabled;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setInfo ( $  a_info  ) 

Set Information Text.

Parameters:
string $a_info Information Text

Definition at line 131 of file class.ilFormPropertyGUI.php.

        {
                $this->info = $a_info;
        }

ilFormPropertyGUI::setPostVar ( $  a_postvar  ) 

Set Post Variable.

Parameters:
string $a_postvar Post Variable

Definition at line 98 of file class.ilFormPropertyGUI.php.

Referenced by __construct().

        {
                $this->postvar = $a_postvar;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setRequired ( $  a_required  ) 

Set Required.

Parameters:
boolean $a_required Required

Definition at line 171 of file class.ilFormPropertyGUI.php.

        {
                $this->required = $a_required;
        }

ilFormPropertyGUI::setTitle ( $  a_title  ) 

Set Title.

Parameters:
string $a_title Title

Definition at line 78 of file class.ilFormPropertyGUI.php.

Referenced by __construct().

        {
                $this->title = $a_title;
        }

Here is the caller graph for this function:

ilFormPropertyGUI::setType ( $  a_type  )  [protected]

Set Type.

Parameters:
string $a_type Type

Definition at line 58 of file class.ilFormPropertyGUI.php.

Referenced by ilTextAreaInputGUI::__construct(), ilSelectInputGUI::__construct(), ilRegExpInputGUI::__construct(), ilRadioGroupInputGUI::__construct(), ilLocationInputGUI::__construct(), ilImageFileInputGUI::__construct(), ilFileInputGUI::__construct(), ilFeedUrlInputGUI::__construct(), ilDurationInputGUI::__construct(), ilDateTimeInputGUI::__construct(), ilCustomInputGUI::__construct(), and ilCheckboxInputGUI::__construct().

        {
                $this->type = $a_type;
        }

Here is the caller graph for this function:

Field Documentation

ilFormPropertyGUI::$alert [protected]

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

ilFormPropertyGUI::$info [protected]

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

ilFormPropertyGUI::$postvar [protected]

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

ilFormPropertyGUI::$required = false [protected]

Definition at line 38 of file class.ilFormPropertyGUI.php.

ilFormPropertyGUI::$title [protected]

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

ilFormPropertyGUI::$type [protected]

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

The documentation for this class was generated from the following file:
Generated on Fri Dec 13 2013 17:57:15 for ILIAS Release_3_9_x_branch .rev 46835 by  doxygen 1.7.1