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

Inheritance diagram for ilBackgroundPositionInputGUI:

Collaboration diagram for ilBackgroundPositionInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setHorizontalValue ($a_horizontalvalue)
	Set Horizontal Value. More...

	getHorizontalValue ()
	Get Horizontal Value. More...

	setVerticalValue ($a_verticalvalue)
	Set Vertical Value. More...

	getVerticalValue ()
	Get Vertical Value. More...

	getValue ()
	Get value. More...

	setValue ($a_val)
	Set value. 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...

Protected Attributes
	$user

	$value

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 background position 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.ilBackgroundPositionInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBackgroundPositionInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        parent::__construct($a_title, $a_postvar);
        $this->setType("border_width");
        $this->dirs = array("horizontal", "vertical");
    }

References $DIC, ilFormPropertyGUI\setType(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilBackgroundPositionInputGUI::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 137 of file class.ilBackgroundPositionInputGUI.php.

    {
        $lng = $this->lng;
        
        foreach ($this->dirs as $dir) {
            $type = $_POST[$this->getPostVar()][$dir]["type"] =
                ilUtil::stripSlashes($_POST[$this->getPostVar()][$dir]["type"]);
            $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"]));
            $pre_value = $_POST[$this->getPostVar()][$dir]["pre_calue"] =
                ilUtil::stripSlashes($_POST[$this->getPostVar()][$dir]["pre_value"]);
                
            /*
            if ($this->getRequired() && trim($num_value) == "")
            {
                $this->setAlert($lng->txt("msg_input_is_required"));
 
                return false;
            }*/
            
            if (!is_numeric($num_value) && trim($num_value) != "") {
                $this->setAlert($lng->txt("sty_msg_input_must_be_numeric"));
                return false;
            }
            
            $value = "";
            if ($type == "numeric") {
                if ($num_value != "") {
                    $value = $num_value . $num_unit;
                }
            } else {
                $value = $pre_value;
            }
            
            if (trim($value) != "") {
                switch ($dir) {
                    case "horizontal": $this->setHorizontalValue($value); break;
                    case "vertical": $this->setVerticalValue($value); break;
                }
            }
        }
        
        return true;
    }

References $_POST, ilFormPropertyGUI\$lng, ilFormPropertyGUI\$type, $value, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\setAlert(), setHorizontalValue(), setVerticalValue(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ getHorizontalValue()

ilBackgroundPositionInputGUI::getHorizontalValue ( )

Get Horizontal Value.

Returns: string Horizontal Value

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

    {
        return $this->horizontalvalue;
    }

Referenced by getValue(), and insert().

Here is the caller graph for this function:

◆ getValue()

ilBackgroundPositionInputGUI::getValue ( )

Get value.

Definition at line 100 of file class.ilBackgroundPositionInputGUI.php.

    {
        if ($this->getHorizontalValue() != "") {
            if ($this->getVerticalValue() != "") {
                return $this->getHorizontalValue() . " " . $this->getVerticalValue();
            } else {
                return $this->getHorizontalValue();
            }
        } else {
            if ($this->getVerticalValue() != "") {
                return "left " . $this->getVerticalValue();
            }
        }
        return "";
    }

References getHorizontalValue(), and getVerticalValue().

Here is the call graph for this function:

◆ getVerticalValue()

ilBackgroundPositionInputGUI::getVerticalValue ( )

Get Vertical Value.

Returns: string Vertical Value

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

    {
        return $this->verticalvalue;
    }

Referenced by getValue(), and insert().

Here is the caller graph for this function:

◆ insert()

ilBackgroundPositionInputGUI::insert ( & $a_tpl )

Insert property html.

Definition at line 187 of file class.ilBackgroundPositionInputGUI.php.

    {
        $lng = $this->lng;
        
        $layout_tpl = new ilTemplate("tpl.prop_hv_layout.html", true, true, "Services/Style/Content");
        
        foreach ($this->dirs as $dir) {
            $tpl = new ilTemplate("tpl.prop_background_position.html", true, true, "Services/Style/Content");
            $unit_options = ilObjStyleSheet::_getStyleParameterNumericUnits();
            $pre_options = ilObjStyleSheet::_getStyleParameterValues("background-position");
            $pre_options = $pre_options[$dir];
            switch ($dir) {
                case "horizontal": $value = strtolower(trim($this->getHorizontalValue())); break;
                case "vertical": $value = strtolower(trim($this->getVerticalValue())); break;
            }
    
            if (in_array($value, $pre_options)) {
                $current_type = "pre";
                $tpl->setVariable("PREDEFINED_SELECTED", 'checked="checked"');
            } else {
                $current_type = "unit";
                $tpl->setVariable("NUMERIC_SELECTED", 'checked="checked"');
 
                $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";
                }
                $tpl->setVariable("VAL_NUM", $disp_val);
            }
            
            foreach ($unit_options as $option) {
                $tpl->setCurrentBlock("unit_option");
                $tpl->setVariable("VAL_UNIT", $option);
                $tpl->setVariable("TXT_UNIT", $option);
                if ($current_type == "unit" && $current_unit == $option) {
                    $tpl->setVariable("UNIT_SELECTED", 'selected="selected"');
                }
                $tpl->parseCurrentBlock();
            }
            
            foreach ($pre_options as $option) {
                $tpl->setCurrentBlock("pre_option");
                $tpl->setVariable("VAL_PRE", $option);
                $tpl->setVariable("TXT_PRE", $option);
                if ($current_type == "pre" && $value == $option) {
                    $tpl->setVariable("PRE_SELECTED", 'selected="selected"');
                }
                $tpl->parseCurrentBlock();
            }
 
            $tpl->setVariable("POSTVAR", $this->getPostVar());
            $tpl->setVariable("TXT_DIR", $lng->txt("sty_$dir"));
            $tpl->setVariable("DIR", $dir);
            
            $layout_tpl->setVariable(strtoupper($dir), $tpl->get());
        }
        $layout_tpl->setVariable("COLSPAN", "2");
        
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $layout_tpl->get());
        $a_tpl->parseCurrentBlock();
    }

References ilFormPropertyGUI\$lng, $tpl, $value, ilObjStyleSheet\_getStyleParameterNumericUnits(), ilObjStyleSheet\_getStyleParameterValues(), getHorizontalValue(), ilFormPropertyGUI\getPostVar(), and getVerticalValue().

Here is the call graph for this function:

◆ setHorizontalValue()

ilBackgroundPositionInputGUI::setHorizontalValue ( $a_horizontalvalue )

Set Horizontal Value.

Parameters

string $a_horizontalvalue Horizontal Value

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

    {
        $this->horizontalvalue = $a_horizontalvalue;
    }

Referenced by checkInput(), setValue(), and setValueByArray().

Here is the caller graph for this function:

◆ setValue()

ilBackgroundPositionInputGUI::setValue ( $a_val )

Set value.

Definition at line 119 of file class.ilBackgroundPositionInputGUI.php.

    {
        $a_val = trim($a_val);
        $a_val_arr = explode(" ", $a_val);
        $hor = trim($a_val_arr[0]);
        $ver = trim($a_val_arr[1]);
        if ($hor == "center" && $ver == "") {
            $ver = "center";
        }
        $this->setHorizontalValue($hor);
        $this->setVerticalValue($ver);
    }

References setHorizontalValue(), and setVerticalValue().

Here is the call graph for this function:

◆ setValueByArray()

ilBackgroundPositionInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 261 of file class.ilBackgroundPositionInputGUI.php.

    {
        $ilUser = $this->user;
        
        if ($a_values[$this->getPostVar()]["horizontal"]["type"] == "predefined") {
            $this->setHorizontalValue($a_values[$this->getPostVar()]["horizontal"]["pre_value"]);
        } else {
            $this->setHorizontalValue($a_values[$this->getPostVar()]["horizontal"]["num_value"] .
                $a_values[$this->getPostVar()]["horizontal"]["num_unit"]);
        }
        if ($a_values[$this->getPostVar()]["vertical"]["type"] == "predefined") {
            $this->setVerticalValue($a_values[$this->getPostVar()]["vertical"]["pre_value"]);
        } else {
            $this->setVerticalValue($a_values[$this->getPostVar()]["vertical"]["num_value"] .
                $a_values[$this->getPostVar()]["vertical"]["num_unit"]);
        }
    }

References $ilUser, $user, ilFormPropertyGUI\getPostVar(), setHorizontalValue(), and setVerticalValue().

Here is the call graph for this function:

◆ setVerticalValue()

ilBackgroundPositionInputGUI::setVerticalValue ( $a_verticalvalue )

Set Vertical Value.

Parameters

string $a_verticalvalue Vertical Value

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

    {
        $this->verticalvalue = $a_verticalvalue;
    }

Referenced by checkInput(), setValue(), and setValueByArray().

Here is the caller graph for this function:

Field Documentation

◆ $user

ilBackgroundPositionInputGUI::$user

protected

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

Referenced by setValueByArray().

◆ $value

ilBackgroundPositionInputGUI::$value

protected

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

Referenced by checkInput(), and insert().

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

Services/Style/Content/classes/class.ilBackgroundPositionInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getHorizontalValue()

◆ getValue()

◆ getVerticalValue()

◆ insert()

◆ setHorizontalValue()

◆ setValue()

◆ setValueByArray()

◆ setVerticalValue()

Field Documentation

◆ $user

◆ $value