ilTRBLNumericStyleValueInputGUI Class Reference

This class represents a numeric style property with all/top/right/bottom/left in a property form. More...

Inheritance diagram for ilTRBLNumericStyleValueInputGUI:

Collaboration diagram for ilTRBLNumericStyleValueInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	setAllValue ($a_allvalue)
	Set All Value. More...
	getAllValue ()
	Get All Value. More...
	setTopValue ($a_topvalue)
	Set Top Value. More...
	getTopValue ()
	Get Top Value. More...
	setBottomValue ($a_bottomvalue)
	Set Bottom Value. More...
	getBottomValue ()
	Get Bottom Value. More...
	setLeftValue ($a_leftvalue)
	Set Left Value. More...
	getLeftValue ()
	Get Left Value. More...
	setRightValue ($a_rightvalue)
	Set Right Value. More...
	getRightValue ()
	Get Right Value. More...
	setAllowPercentage ($a_allowpercentage)
	Set Allow Percentage. More...
	getAllowPercentage ()
	Get Allow Percentage. More...
	checkInput ()
	Check input, strip slashes etc. More...
	insert (&$a_tpl)
	Insert property html. More...
	setValueByArray ($a_values)
	Set value by array. More...
Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getType ()
	Get Type. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setPostVar ($a_postvar)
	Set Post Variable. More...
	getPostVar ()
	Get Post Variable. More...
	getFieldId ()
	Get Post Variable. More...
	setInfo ($a_info)
	Set Information Text. More...
	getInfo ()
	Get Information Text. More...
	setAlert ($a_alert)
	Set Alert Text. More...
	getAlert ()
	Get Alert Text. More...
	setRequired ($a_required)
	Set Required. More...
	getRequired ()
	Get Required. More...
	setDisabled ($a_disabled)
	Set Disabled. More...
	getDisabled ()
	Get Disabled. More...
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm ($a_parentform)
	Set Parent Form. More...
	getParentForm ()
	Get Parent Form. More...
	setParent ($a_val)
	Set Parent GUI object. More...
	getParent ()
	Get Parent GUI object. More...
	getSubForm ()
	Get sub form html. More...
	hideSubForm ()
	Sub form hidden on init? More...
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...
	getHiddenTitle ()
	Get hidden title. More...
	getItemByPostVar ($a_post_var)
	Get item by post var. More...
	serializeData ()
	serialize data More...
	unserializeData ($a_data)
	unserialize data More...
	writeToSession ()
	Write to session. More...
	clearFromSession ()
	Clear session value. More...
	readFromSession ()
	Read from session. More...
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...
	getMulti ()
	Get Multi. More...
	setMultiValues (array $a_values)
	Set multi values. More...
	getMultiValues ()
	Get multi values. More...
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...
	getFormLabelFor ()
	Get label "for" attribute value for form. More...

Protected Attributes
	$user
	$value
	$allowpercentage = true
Protected Attributes inherited from ilFormPropertyGUI
	$ctrl
	$lng
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...
	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

This class represents a numeric style property with all/top/right/bottom/left 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.ilTRBLNumericStyleValueInputGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 47 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        parent::__construct($a_title, $a_postvar);
        $this->setType("style_numeric");
        $this->dirs = array("all", "top", "bottom", "left", "right");
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilFormPropertyGUI\setType(), and user().

Here is the call graph for this function:

Member Function Documentation

checkInput()

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

    {
        $lng = $this->lng;
        
        foreach ($this->dirs as $dir) {
            $num_value = $_POST[$this->getPostVar()][$dir]["num_value"] =
                trim(ilUtil::stripSlashes($_POST[$this->getPostVar()][$dir]["num_value"]));
            $num_unit = $_POST[$this->getPostVar()][$dir]["num_unit"] =
                trim(ilUtil::stripSlashes($_POST[$this->getPostVar()][$dir]["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) != "") {
                switch ($dir) {
                    case "all": $this->setAllValue($num_value . $num_unit); break;
                    case "top": $this->setTopValue($num_value . $num_unit); break;
                    case "bottom": $this->setBottomValue($num_value . $num_unit); break;
                    case "left": $this->setLeftValue($num_value . $num_unit); break;
                    case "right": $this->setRightValue($num_value . $num_unit); break;
                }
            }
        }
        
        return true;
    }

References $_POST, ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\setAlert(), setAllValue(), setBottomValue(), setLeftValue(), setRightValue(), setTopValue(), and ilUtil\stripSlashes().

Here is the call graph for this function:

getAllowPercentage()

ilTRBLNumericStyleValueInputGUI::getAllowPercentage

(

)

Get Allow Percentage.

Returns

boolean Allow Percentage

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

    {
        return $this->allowpercentage;
    }

References $allowpercentage.

Referenced by insert().

Here is the caller graph for this function:

getAllValue()

ilTRBLNumericStyleValueInputGUI::getAllValue

(

)

Get All Value.

Returns

string All Value

Definition at line 73 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        return $this->allvalue;
    }

Referenced by insert().

Here is the caller graph for this function:

getBottomValue()

ilTRBLNumericStyleValueInputGUI::getBottomValue

(

)

Get Bottom Value.

Returns

string Bottom Value

Definition at line 113 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        return $this->bottomvalue;
    }

Referenced by insert().

Here is the caller graph for this function:

getLeftValue()

ilTRBLNumericStyleValueInputGUI::getLeftValue

(

)

Get Left Value.

Returns

string Left Value

Definition at line 133 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        return $this->leftvalue;
    }

Referenced by insert().

Here is the caller graph for this function:

getRightValue()

ilTRBLNumericStyleValueInputGUI::getRightValue

(

)

Get Right Value.

Returns

string Right Value

Definition at line 153 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        return $this->rightvalue;
    }

Referenced by insert().

Here is the caller graph for this function:

getTopValue()

ilTRBLNumericStyleValueInputGUI::getTopValue

(

)

Get Top Value.

Returns

string Top Value

Definition at line 93 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        return $this->topvalue;
    }

Referenced by insert().

Here is the caller graph for this function:

insert()

ilTRBLNumericStyleValueInputGUI::insert

(

&

$a_tpl

)

Insert property html.

Definition at line 223 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        $lng = $this->lng;
        
        $layout_tpl = new ilTemplate("tpl.prop_trbl_layout.html", true, true, "Services/Style/Content");
        
        foreach ($this->dirs as $dir) {
            $tpl = new ilTemplate("tpl.prop_trbl_style_numeric.html", true, true, "Services/Style/Content");
            $unit_options = ilObjStyleSheet::_getStyleParameterNumericUnits(!$this->getAllowPercentage());
            
            switch ($dir) {
                case "all": $value = strtolower(trim($this->getAllValue())); break;
                case "top": $value = strtolower(trim($this->getTopValue())); break;
                case "bottom": $value = strtolower(trim($this->getBottomValue())); break;
                case "left": $value = strtolower(trim($this->getLeftValue())); break;
                case "right": $value = strtolower(trim($this->getRightValue())); break;
            }
    
            $current_unit = "";
            foreach ($unit_options as $u) {
                if (substr($value, strlen($value) - strlen($u)) == $u) {
                    $current_unit = $u;
                }
            }
            $disp_val = 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();
            }
            
            $tpl->setVariable("POSTVAR", $this->getPostVar());
            $tpl->setVariable("VAL_NUM", $disp_val);
            $tpl->setVariable("TXT_DIR", $lng->txt("sty_$dir"));
            $tpl->setVariable("DIR", $dir);
            
            $layout_tpl->setVariable(strtoupper($dir), $tpl->get());
        }
        
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $layout_tpl->get());
        $a_tpl->parseCurrentBlock();
    }

References ilFormPropertyGUI\$lng, $tpl, $value, ilObjStyleSheet\_getStyleParameterNumericUnits(), getAllowPercentage(), getAllValue(), getBottomValue(), getLeftValue(), ilFormPropertyGUI\getPostVar(), getRightValue(), and getTopValue().

Here is the call graph for this function:

setAllowPercentage()

ilTRBLNumericStyleValueInputGUI::setAllowPercentage

(

$a_allowpercentage

)

Set Allow Percentage.

Parameters

boolean

$a_allowpercentage

Allow Percentage

Definition at line 163 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        $this->allowpercentage = $a_allowpercentage;
    }

setAllValue()

ilTRBLNumericStyleValueInputGUI::setAllValue

(

$a_allvalue

)

Set All Value.

Parameters

string

$a_allvalue

All Value

Definition at line 63 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        $this->allvalue = $a_allvalue;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

setBottomValue()

ilTRBLNumericStyleValueInputGUI::setBottomValue

(

$a_bottomvalue

)

Set Bottom Value.

Parameters

string

$a_bottomvalue

Bottom Value

Definition at line 103 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        $this->bottomvalue = $a_bottomvalue;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

setLeftValue()

ilTRBLNumericStyleValueInputGUI::setLeftValue

(

$a_leftvalue

)

Set Left Value.

Parameters

string

$a_leftvalue

Left Value

Definition at line 123 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        $this->leftvalue = $a_leftvalue;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

setRightValue()

ilTRBLNumericStyleValueInputGUI::setRightValue

(

$a_rightvalue

)

Set Right Value.

Parameters

string

$a_rightvalue

Right Value

Definition at line 143 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        $this->rightvalue = $a_rightvalue;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

setTopValue()

ilTRBLNumericStyleValueInputGUI::setTopValue

(

$a_topvalue

)

Set Top Value.

Parameters

string

$a_topvalue

Top Value

Definition at line 83 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        $this->topvalue = $a_topvalue;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

setValueByArray()

ilTRBLNumericStyleValueInputGUI::setValueByArray

(

$a_values

)

Set value by array.

Parameters

array

$a_values

value array

Definition at line 280 of file class.ilTRBLNumericStyleValueInputGUI.php.

    {
        $ilUser = $this->user;
        
        $this->setAllValue($a_values[$this->getPostVar()]["all"]["num_value"] .
            $a_values[$this->getPostVar()]["all"]["num_unit"]);
        $this->setBottomValue($a_values[$this->getPostVar()]["bottom"]["num_value"] .
            $a_values[$this->getPostVar()]["bottom"]["num_unit"]);
        $this->setTopValue($a_values[$this->getPostVar()]["top"]["num_value"] .
            $a_values[$this->getPostVar()]["top"]["num_unit"]);
        $this->setLeftValue($a_values[$this->getPostVar()]["left"]["num_value"] .
            $a_values[$this->getPostVar()]["left"]["num_unit"]);
        $this->setRightValue($a_values[$this->getPostVar()]["right"]["num_value"] .
            $a_values[$this->getPostVar()]["right"]["num_unit"]);
    }

References $ilUser, $user, ilFormPropertyGUI\getPostVar(), setAllValue(), setBottomValue(), setLeftValue(), setRightValue(), and setTopValue().

Here is the call graph for this function:

Field Documentation

$allowpercentage

ilTRBLNumericStyleValueInputGUI::$allowpercentage = true

protected

Definition at line 39 of file class.ilTRBLNumericStyleValueInputGUI.php.

Referenced by getAllowPercentage().

$user

ilTRBLNumericStyleValueInputGUI::$user

protected

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

Referenced by setValueByArray().

$value

ilTRBLNumericStyleValueInputGUI::$value

protected

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

Referenced by insert().

---

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

• Services/Style/Content/classes/class.ilTRBLNumericStyleValueInputGUI.php