ilBackgroundImageInputGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilBackgroundImageInputGUI:

Collaboration diagram for ilBackgroundImageInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")
	setValue (string $a_value)
	getValue ()
	setImages (array $a_images)
	getImages ()
	checkInput ()
	getInput ()
	insert (ilTemplate $a_tpl)
	setValueByArray (array $a_values)
Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")
	executeCommand ()
	getType ()
	setTitle (string $a_title)
	getTitle ()
	setPostVar (string $a_postvar)
	getPostVar ()
	getFieldId ()
	setInfo (string $a_info)
	getInfo ()
	setAlert (string $a_alert)
	getAlert ()
	setRequired (bool $a_required)
	getRequired ()
	setDisabled (bool $a_disabled)
	getDisabled ()
	checkInput ()
	Check input, strip slashes etc. More...
	setParentForm (ilPropertyFormGUI $a_parentform)
	getParentForm ()
	setParent (ilFormPropertyGUI $a_val)
	getParent ()
	getSubForm ()
	hideSubForm ()
	setHiddenTitle (string $a_val)
	getHiddenTitle ()
	getItemByPostVar (string $a_post_var)
	Get item by post var. More...
	serializeData ()
	unserializeData (string $a_data)
	setParentTable ($a_val)
	Set parent table. More...
	getParentTable ()
	Get parent table. More...
	writeToSession ()
	clearFromSession ()
	readFromSession ()
	getHiddenTag (string $a_post_var, string $a_value)
	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)
	getMulti ()
	setMultiValues (array $a_values)
	getMultiValues ()
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...
	stripSlashesAddSpaceFallback (string $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...
	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Protected Attributes
array	$images
ilObjUser	$user
string	$value
Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []
ilTable2GUI	$parent_table = null
ilFormPropertyGUI	$parent_gui = null
ilCtrl	$ctrl
ilLanguage	$lng
string	$type = ""
string	$title = ""
string	$postvar = ""
string	$info = ""
string	$alert = ""
bool	$required = false
ilPropertyFormGUI	$parentform = null
string	$hidden_title = ""
bool	$multi = false
bool	$multi_sortable = false
bool	$multi_addremove = true
array	$multi_values = []
RequestInterface	$request
HTTP Services	$http
Refinery Factory	$refinery = null
bool	$disabled = false
ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...
Protected Member Functions inherited from ilFormPropertyGUI
	setType (string $a_type)
	checkParentFormTable ()
	getSessionKey ()
	getMultiIconsHTML ()
	int ($key)
	intArray ($key)
	str ($key)
	raw ($key)
	strArray ($key)
	arrayArray ($key)
	isRequestParamArray (string $key)
	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning This class represents a background image property in a property form.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilBackgroundImageInputGUI::__construct	(	string	$a_title = "",
		string	$a_postvar = ""
	)

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

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

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

checkInput()

ilBackgroundImageInputGUI::checkInput

(

)

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

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\$type, getInput(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), setValue(), and ilLanguage\txt().

                                : bool
    {
        $lng = $this->lng;

        $input = $this->getInput();

        $type = $input["type"] ?? "";
        $int_value = $input["int_value"] ?? "";
        $ext_value = $input["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;
    }

Here is the call graph for this function:

getImages()

ilBackgroundImageInputGUI::getImages

(

)

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

References $images.

Referenced by insert().

                               : array
    {
        return $this->images;
    }

Here is the caller graph for this function:

getInput()

ilBackgroundImageInputGUI::getInput

(

)

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

References ilFormPropertyGUI\getPostVar(), and ilFormPropertyGUI\strArray().

Referenced by checkInput().

                              : array
    {
        return $this->strArray($this->getPostVar());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValue()

ilBackgroundImageInputGUI::getValue

(

)

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

References $value.

Referenced by insert().

                              : string
    {
        return $this->value;
    }

Here is the caller graph for this function:

insert()

ilBackgroundImageInputGUI::insert

(

ilTemplate

$a_tpl

)

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

References $tpl, getImages(), ilFormPropertyGUI\getPostVar(), getValue(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                             : void
    {
        $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", ilLegacyFormElementsUtil::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();
    }

Here is the call graph for this function:

setImages()

ilBackgroundImageInputGUI::setImages

(

array

$a_images

)

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

Referenced by ilStyleCharacteristicGUI\initTagStyleForm().

                                              : void
    {
        $this->images = $a_images;
    }

Here is the caller graph for this function:

setValue()

ilBackgroundImageInputGUI::setValue

(

string

$a_value

)

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

Referenced by checkInput(), and setValueByArray().

                                             : void
    {
        $this->value = $a_value;
    }

Here is the caller graph for this function:

setValueByArray()

ilBackgroundImageInputGUI::setValueByArray

(

array

$a_values

)

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

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

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

Here is the call graph for this function:

Field Documentation

$images

array ilBackgroundImageInputGUI::$images

protected

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

Referenced by getImages().

$user

ilObjUser ilBackgroundImageInputGUI::$user

protected

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

$value

string ilBackgroundImageInputGUI::$value

protected

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

Referenced by getValue().

---

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

• Services/Style/Content/Characteristic/Inputs/class.ilBackgroundImageInputGUI.php