ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilNumericStyleValueInputGUI Class Reference

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

+ Inheritance diagram for ilNumericStyleValueInputGUI:
+ Collaboration diagram for ilNumericStyleValueInputGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor.
 setValue ($a_value)
 Set Value.
 getValue ()
 Get Value.
 setAllowPercentage ($a_allowpercentage)
 Set Allow Percentage.
 getAllowPercentage ()
 Get Allow Percentage.
 checkInput ()
 Check input, strip slashes etc.
 insert (&$a_tpl)
 Insert property html.
 setValueByArray ($a_values)
 Set value by array.
- Public Member Functions inherited from ilFormPropertyGUI
executeCommand ()
 Execute command.
 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.
 setParentForm ($a_parentform)
 Set Parent Form.
 getParentForm ()
 Get Parent Form.
 setParent ($a_val)
 Set Parent GUI object.
 getParent ()
 Get Parent GUI object.
 getSubForm ()
 Get sub form html.
 hideSubForm ()
 Sub form hidden on init?
 setHiddenTitle ($a_val)
 Set hidden title (for screenreaders)
 getHiddenTitle ()
 Get hidden title.
 getItemByPostVar ($a_post_var)
 Get item by post var.
 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

 $value
 $allowpercentage = true
- 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
 setType ($a_type)
 Set Type.
 getMultiIconsHTML ()
 Get HTML for multiple value icons.

Detailed Description

This class represents a numeric style property 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.ilNumericStyleValueInputGUI.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented from ilFormPropertyGUI.

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

References ilFormPropertyGUI\setType().

{
parent::__construct($a_title, $a_postvar);
$this->setType("style_numeric");
}

+ Here is the call graph for this function:

Member Function Documentation

ilNumericStyleValueInputGUI::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 94 of file class.ilNumericStyleValueInputGUI.php.

References $_POST, $lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), setValue(), and ilUtil\stripSlashes().

{
global $lng;
$num_value = $_POST[$this->getPostVar()]["num_value"] =
trim(ilUtil::stripSlashes($_POST[$this->getPostVar()]["num_value"]));
$num_unit = $_POST[$this->getPostVar()]["num_unit"] =
trim(ilUtil::stripSlashes($_POST[$this->getPostVar()]["num_unit"]));
if ($this->getRequired() && trim($num_value) == "")
{
$this->setAlert($lng->txt("msg_input_is_required"));
return false;
}
if (!is_numeric($num_value) && $num_value != "")
{
$this->setAlert($lng->txt("sty_msg_input_must_be_numeric"));
return false;
}
if (trim($num_value) != "")
{
$this->setValue($num_value.$num_unit);
}
return true;
}

+ Here is the call graph for this function:

ilNumericStyleValueInputGUI::getAllowPercentage ( )

Get Allow Percentage.

Returns
boolean Allow Percentage

Definition at line 84 of file class.ilNumericStyleValueInputGUI.php.

References $allowpercentage.

Referenced by insert().

+ Here is the caller graph for this function:

ilNumericStyleValueInputGUI::getValue ( )

Get Value.

Returns
string Value

Definition at line 64 of file class.ilNumericStyleValueInputGUI.php.

References $value.

Referenced by insert().

{
return $this->value;
}

+ Here is the caller graph for this function:

ilNumericStyleValueInputGUI::insert ( $a_tpl)

Insert property html.

Definition at line 128 of file class.ilNumericStyleValueInputGUI.php.

References $tpl, $value, ilObjStyleSheet\_getStyleParameterNumericUnits(), getAllowPercentage(), ilFormPropertyGUI\getPostVar(), and getValue().

{
$tpl = new ilTemplate("tpl.prop_style_numeric.html", true, true, "Services/Style");
$tpl->setVariable("POSTVAR", $this->getPostVar());
$value = strtolower(trim($this->getValue()));
$current_unit = "";
foreach ($unit_options as $u)
{
if (substr($value, strlen($value) - strlen($u)) == $u)
{
$current_unit = $u;
}
}
$tpl->setVariable("VAL_NUM",
substr($value, 0, strlen($value) - strlen($current_unit)));
if ($current_unit == "")
{
$current_unit = "px";
}
foreach ($unit_options as $option)
{
$tpl->setCurrentBlock("unit_option");
$tpl->setVariable("VAL_UNIT", $option);
$tpl->setVariable("TXT_UNIT", $option);
if ($current_unit == $option)
{
$tpl->setVariable("UNIT_SELECTED", 'selected="selected"');
}
$tpl->parseCurrentBlock();
}
$a_tpl->setCurrentBlock("prop_generic");
$a_tpl->setVariable("PROP_GENERIC", $tpl->get());
$a_tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

ilNumericStyleValueInputGUI::setAllowPercentage (   $a_allowpercentage)

Set Allow Percentage.

Parameters
boolean$a_allowpercentageAllow Percentage

Definition at line 74 of file class.ilNumericStyleValueInputGUI.php.

Referenced by ilObjStyleSheetGUI\initTagStyleForm(), and ilObjStyleSheetGUI\initTemplateGenerationForm().

{
$this->allowpercentage = $a_allowpercentage;
}

+ Here is the caller graph for this function:

ilNumericStyleValueInputGUI::setValue (   $a_value)

Set Value.

Parameters
string$a_valueValue

Definition at line 54 of file class.ilNumericStyleValueInputGUI.php.

Referenced by checkInput(), and setValueByArray().

{
$this->value = $a_value;
}

+ Here is the caller graph for this function:

ilNumericStyleValueInputGUI::setValueByArray (   $a_values)

Set value by array.

Parameters
array$a_valuesvalue array

Definition at line 175 of file class.ilNumericStyleValueInputGUI.php.

References $ilUser, ilFormPropertyGUI\getPostVar(), and setValue().

{
global $ilUser;
$this->setValue($a_values[$this->getPostVar()]["num_value"].
$a_values[$this->getPostVar()]["num_unit"]);
}

+ Here is the call graph for this function:

Field Documentation

ilNumericStyleValueInputGUI::$allowpercentage = true
protected

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

Referenced by getAllowPercentage().

ilNumericStyleValueInputGUI::$value
protected

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

Referenced by getValue(), and insert().


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