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

Inheritance diagram for ilBackgroundImageInputGUI:

Collaboration diagram for ilBackgroundImageInputGUI:

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

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setImages ($a_images)
	Set Images. More...

	getImages ()
	Get Images. 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 image 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.ilBackgroundImageInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBackgroundImageInputGUI::__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.ilBackgroundImageInputGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        parent::__construct($a_title, $a_postvar);
        $this->setType("background_image");
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilBackgroundImageInputGUI::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 101 of file class.ilBackgroundImageInputGUI.php.

    {
        $lng = $this->lng;
        
        $type = $_POST[$this->getPostVar()]["type"] =
            ilUtil::stripSlashes($_POST[$this->getPostVar()]["type"]);
        $int_value = $_POST[$this->getPostVar()]["int_value"] =
            ilUtil::stripSlashes($_POST[$this->getPostVar()]["int_value"]);
        $ext_value = $_POST[$this->getPostVar()]["ext_value"] =
            ilUtil::stripSlashes($_POST[$this->getPostVar()]["ext_value"]);
            
        if ($this->getRequired() && $type == "ext" && trim($ext_value) == "") {
            $this->setAlert($lng->txt("msg_input_is_required"));
 
            return false;
        }
 
        if ($type == "external") {
            $this->setValue($ext_value);
        } else {
            $this->setValue($int_value);
        }
        
        return true;
    }

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

Here is the call graph for this function:

◆ getImages()

ilBackgroundImageInputGUI::getImages ( )

Get Images.

Returns: array Images

Definition at line 91 of file class.ilBackgroundImageInputGUI.php.

    {
        return $this->images;
    }

Referenced by insert().

Here is the caller graph for this function:

◆ getValue()

ilBackgroundImageInputGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 71 of file class.ilBackgroundImageInputGUI.php.

    {
        return $this->value;
    }

References $value.

Referenced by insert().

Here is the caller graph for this function:

◆ insert()

ilBackgroundImageInputGUI::insert ( & $a_tpl )

Insert property html.

Definition at line 130 of file class.ilBackgroundImageInputGUI.php.

    {
        $tpl = new ilTemplate("tpl.prop_background_image.html", true, true, "Services/Style/Content");
 
        $tpl->setVariable("POSTVAR", $this->getPostVar());
        
        $int_options = array_merge(array("" => ""), $this->getImages());
        
        $value = trim($this->getValue());
 
        if (is_int(strpos($value, "/"))) {
            $current_type = "ext";
            $tpl->setVariable("EXTERNAL_SELECTED", 'checked="checked"');
            $tpl->setVariable("VAL_EXT", ilUtil::prepareFormOutput($value));
        } else {
            $current_type = "int";
            $tpl->setVariable("INTERNAL_SELECTED", 'checked="checked"');
        }
        
        foreach ($int_options as $option) {
            $tpl->setCurrentBlock("int_option");
            $tpl->setVariable("VAL_INT", $option);
            $tpl->setVariable("TXT_INT", $option);
 
            if ($current_type == "int" && $value == $option) {
                $tpl->setVariable("INT_SELECTED", 'selected="selected"');
            }
            $tpl->parseCurrentBlock();
        }
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
        $a_tpl->parseCurrentBlock();
    }

References $tpl, $value, getImages(), ilFormPropertyGUI\getPostVar(), getValue(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

◆ setImages()

ilBackgroundImageInputGUI::setImages ( $a_images )

Set Images.

Parameters

array $a_images Images

Definition at line 81 of file class.ilBackgroundImageInputGUI.php.

    {
        $this->images = $a_images;
    }

◆ setValue()

ilBackgroundImageInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Definition at line 61 of file class.ilBackgroundImageInputGUI.php.

    {
        $this->value = $a_value;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

◆ setValueByArray()

ilBackgroundImageInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 170 of file class.ilBackgroundImageInputGUI.php.

    {
        $ilUser = $this->user;
        
        if ($a_values[$this->getPostVar()]["type"] == "internal") {
            $this->setValue($a_values[$this->getPostVar()]["int_value"]);
        } else {
            $this->setValue($a_values[$this->getPostVar()]["ext_value"]);
        }
    }