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

Inheritance diagram for ilWidthHeightInputGUI:

Collaboration diagram for ilWidthHeightInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setSupportConstraintsProps (bool $a_val)

	getSupportConstraintsProps ()

	setWidth (?int $a_width)

	getWidth ()

	setHeight (?int $a_height)

	getHeight ()

	setConstrainProportions (bool $a_constrainproportions)

	getConstrainProportions ()

	checkInput ()
	Check input, strip slashes etc. More...

	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
bool	$support_constraint_props = false

bool	$constrainproportions = false

int	$height = null

int	$width = null

array	$dirs = []

ilObjUser	$user

ilGlobalTemplateInterface	$main_tpl

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
	symbol ()

	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 width/height item in a property form.

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

Definition at line 24 of file class.ilWidthHeightInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilWidthHeightInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

Reimplemented from ilFormPropertyGUI.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilWidthHeightInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Reimplemented from ilFormPropertyGUI.

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

                                : bool
    {
        $i = $this->getInput();
        $this->setWidth($i["width"] ? (int) $i["width"] : null);
        $this->setHeight($i["height"] ? (int) $i["height"] : null);
        $this->setConstrainProportions((bool) $i["constr_prop"]);
 
        return true;
    }

References getInput(), setConstrainProportions(), setHeight(), and setWidth().

Here is the call graph for this function:

◆ getConstrainProportions()

ilWidthHeightInputGUI::getConstrainProportions ( )

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

                                             : bool
    {
        return $this->constrainproportions;
    }

References $constrainproportions.

Referenced by insert().

Here is the caller graph for this function:

◆ getHeight()

ilWidthHeightInputGUI::getHeight ( )

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

                               : ?int
    {
        return $this->height;
    }

References $height.

Referenced by insert().

Here is the caller graph for this function:

◆ getInput()

ilWidthHeightInputGUI::getInput ( )

Definition at line 97 of file class.ilWidthHeightInputGUI.php.

                              : array
    {
        $val = $this->strArray($this->getPostVar());
        return [
            "width" => (string) ($val["width"] ?? ""),
            "height" => (string) ($val["height"] ?? ""),
            "constr_prop" => (bool) ($val["constr_prop"] ?? false)
        ];
    }

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

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSupportConstraintsProps()

ilWidthHeightInputGUI::getSupportConstraintsProps ( )

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

                                                : bool
    {
        return $this->support_constraint_props;
    }

References $support_constraint_props.

Referenced by insert().

Here is the caller graph for this function:

◆ getWidth()

ilWidthHeightInputGUI::getWidth ( )

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

                              : ?int
    {
        return $this->width;
    }

References $width.

Referenced by insert().

Here is the caller graph for this function:

◆ insert()

ilWidthHeightInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 107 of file class.ilWidthHeightInputGUI.php.

                                             : void
    {
        $lng = $this->lng;
 
        $tpl = new ilTemplate("tpl.prop_width_height.html", true, true, "components/ILIAS/MediaObjects");
 
        $wh_ratio = 0;
        if ((int) $this->getHeight() > 0) {
            $wh_ratio = (int) $this->getWidth() / (int) $this->getHeight();
        }
        $ratio = str_replace(",", ".", round($wh_ratio, 6));
        if ($this->getSupportConstraintsProps() && $wh_ratio > 0) {
            $tpl->setCurrentBlock("cs_prop");
            $tpl->setVariable("TXT_CONSTR_PROP", $lng->txt("cont_constrain_proportions"));
            $tpl->setVariable("CS_POST_VAR", $this->getPostVar());
            if ($this->getConstrainProportions()) {
                $tpl->setVariable("CHECKED", 'checked="checked"');
            }
            $tpl->parseCurrentBlock();
            $this->main_tpl->addOnLoadCode(
                'prop_width_height["prop_' . $this->getPostVar() . '"] = ' . $ratio . ';'
            );
        }
 
        $tpl->setVariable("VAL_WIDTH", strtolower(trim((string) $this->getWidth())));
        $tpl->setVariable("VAL_HEIGHT", strtolower(trim((string) $this->getHeight())));
 
        $tpl->setVariable("POST_VAR", $this->getPostVar());
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
        $a_tpl->parseCurrentBlock();
 
        $this->main_tpl
            ->addJavaScript("assets/js/ServiceMediaObjectPropWidthHeight.js");
        $this->main_tpl->addOnLoadCode(
            'prop_width_height["prop_' . $this->getPostVar() . '"] = ' . $ratio . ';'
        );
    }

References ilFormPropertyGUI\$lng, getConstrainProportions(), getHeight(), ilFormPropertyGUI\getPostVar(), getSupportConstraintsProps(), getWidth(), ilFormPropertyGUI\int(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

Here is the call graph for this function:

◆ setConstrainProportions()

ilWidthHeightInputGUI::setConstrainProportions ( bool $a_constrainproportions )

Definition at line 77 of file class.ilWidthHeightInputGUI.php.

                                                                         : void
    {
        $this->constrainproportions = $a_constrainproportions;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

◆ setHeight()

ilWidthHeightInputGUI::setHeight ( ?int $a_height )

Definition at line 67 of file class.ilWidthHeightInputGUI.php.

                                             : void
    {
        $this->height = $a_height;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

◆ setSupportConstraintsProps()

ilWidthHeightInputGUI::setSupportConstraintsProps ( bool $a_val )

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

                                                           : void
    {
        $this->support_constraint_props = $a_val;
    }

◆ setValueByArray()

ilWidthHeightInputGUI::setValueByArray ( array $a_values )

Definition at line 147 of file class.ilWidthHeightInputGUI.php.

                                                    : void
    {
        $w = $a_values[$this->getPostVar()]["width"] ?? false;
        $h = $a_values[$this->getPostVar()]["height"] ?? false;
        $this->setWidth($w ? (int) $w : null);
        $this->setHeight($h ? (int) $h : null);
        $this->setConstrainProportions($a_values[$this->getPostVar()]["constr_prop"] ?? false);
    }

References ilFormPropertyGUI\getPostVar(), setConstrainProportions(), setHeight(), and setWidth().

Here is the call graph for this function:

◆ setWidth()

ilWidthHeightInputGUI::setWidth ( ?int $a_width )

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

                                           : void
    {
        $this->width = $a_width;
    }

Referenced by checkInput(), and setValueByArray().

Here is the caller graph for this function:

Field Documentation

◆ $constrainproportions

bool ilWidthHeightInputGUI::$constrainproportions = false

protected

Definition at line 27 of file class.ilWidthHeightInputGUI.php.

Referenced by getConstrainProportions().

◆ $dirs

array ilWidthHeightInputGUI::$dirs = []

protected

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

◆ $height

int ilWidthHeightInputGUI::$height = null

protected

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

Referenced by getHeight().

◆ $main_tpl

ilGlobalTemplateInterface ilWidthHeightInputGUI::$main_tpl

protected

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

◆ $support_constraint_props

bool ilWidthHeightInputGUI::$support_constraint_props = false

protected

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

Referenced by getSupportConstraintsProps().

◆ $user

ilObjUser ilWidthHeightInputGUI::$user

protected

Definition at line 31 of file class.ilWidthHeightInputGUI.php.

◆ $width

int ilWidthHeightInputGUI::$width = null

protected

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

Referenced by getWidth().

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

components/ILIAS/MediaObjects/classes/class.ilWidthHeightInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getConstrainProportions()

◆ getHeight()

◆ getInput()

◆ getSupportConstraintsProps()

◆ getWidth()

◆ insert()

◆ setConstrainProportions()

◆ setHeight()

◆ setSupportConstraintsProps()

◆ setValueByArray()

◆ setWidth()

Field Documentation

◆ $constrainproportions

◆ $dirs

◆ $height

◆ $main_tpl

◆ $support_constraint_props

◆ $user

◆ $width