This class represents a width/height item in a property form. More...

Inheritance diagram for ilWidthHeightInputGUI:

Collaboration diagram for ilWidthHeightInputGUI:

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

	setWidth ($a_width)
	Set Width. More...

	getWidth ()
	Get Width. More...

	setHeight ($a_height)
	Set Height. More...

	getHeight ()
	Get Height. More...

	setConstrainProportions ($a_constrainproportions)
	Set Constrain Proportions. More...

	getConstrainProportions ()
	Get Constrain Proportions. 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 width/height item 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 12 of file class.ilWidthHeightInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

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

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

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.

Returns: boolean Input ok, true/false

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

References $_POST, ilFormPropertyGUI\$lng, $value, ilFormPropertyGUI\getPostVar(), setHeight(), setWidth(), and ilUtil\stripSlashes().

     {
         $lng = $this->lng;
         
         foreach ($this->dirs as $dir) {
             $pre_value = $_POST[$this->getPostVar()][$dir] =
                 ilUtil::stripSlashes($_POST[$this->getPostVar()][$dir]);
                 
             /*
             if ($this->getRequired() && trim($num_value) == "")
             {
                 $this->setAlert($lng->txt("msg_input_is_required"));
 
                 return false;
             }*/
                         
             $value = $pre_value;
             
             if (trim($value) != "") {
                 switch ($dir) {
                     case "width": $this->setWidth($value); break;
                     case "height": $this->setHeight($value); break;
                 }
             }
         }
         
         return true;
     }

Here is the call graph for this function:

◆ getConstrainProportions()

ilWidthHeightInputGUI::getConstrainProportions ( )

Get Constrain Proportions.

Returns: boolean Constrain Proportions

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

Referenced by insert().

     {
         return $this->constrainproportions;
     }

Here is the caller graph for this function:

◆ getHeight()

ilWidthHeightInputGUI::getHeight ( )

Get Height.

Returns: integer Height

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

Referenced by insert().

     {
         return $this->height;
     }

Here is the caller graph for this function:

◆ getWidth()

ilWidthHeightInputGUI::getWidth ( )

Get Width.

Returns: integer Width

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

Referenced by insert().

     {
         return $this->width;
     }

Here is the caller graph for this function:

◆ insert()

ilWidthHeightInputGUI::insert ( $a_tpl )

Insert property html.

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

References $GLOBALS, ilFormPropertyGUI\$lng, $tpl, $value, getConstrainProportions(), getHeight(), ilFormPropertyGUI\getPostVar(), and getWidth().

     {
         $lng = $this->lng;
         
         $tpl = new ilTemplate("tpl.prop_width_height.html", true, true, "Services/MediaObjects");
 
         foreach ($this->dirs as $dir) {
             switch ($dir) {
                 case "width": $value = strtolower(trim($this->getWidth())); break;
                 case "height": $value = strtolower(trim($this->getHeight())); break;
             }
             $tpl->setVariable("VAL_" . strtoupper($dir), $value);
         }
         if ($this->getConstrainProportions()) {
             $tpl->setVariable("CHECKED", 'checked="checked"');
         }
 
         $tpl->setVariable("POST_VAR", $this->getPostVar());
         $tpl->setVariable("TXT_CONSTR_PROP", $lng->txt("cont_constrain_proportions"));
         $wh_ratio = 0;
         if ((int) $this->getHeight() > 0) {
             $wh_ratio = (int) $this->getWidth() / (int) $this->getHeight();
         }
         $tpl->setVariable("WH_RATIO", str_replace(",", ".", round($wh_ratio, 6)));
         
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
         $a_tpl->parseCurrentBlock();
         
         $GLOBALS["tpl"]->addJavascript("./Services/MediaObjects/js/ServiceMediaObjectPropWidthHeight.js");
     }

Here is the call graph for this function:

◆ setConstrainProportions()

ilWidthHeightInputGUI::setConstrainProportions ( $a_constrainproportions )

Set Constrain Proportions.

Parameters

boolean $a_constrainproportions Constrain Proportions

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

Referenced by ilPCMediaObjectGUI\initAliasForm(), ilObjMediaObjectGUI\initForm(), and setValueByArray().

     {
         $this->constrainproportions = $a_constrainproportions;
     }

Here is the caller graph for this function:

◆ setHeight()

ilWidthHeightInputGUI::setHeight ( $a_height )

Set Height.

Parameters

integer $a_height Height

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

Referenced by checkInput(), and setValueByArray().

     {
         $this->height = $a_height;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilWidthHeightInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

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

     {
         $ilUser = $this->user;
         //var_dump($a_values[$this->getPostVar()]);
         $this->setWidth($a_values[$this->getPostVar()]["width"]);
         $this->setHeight($a_values[$this->getPostVar()]["height"]);
         $this->setConstrainProportions($a_values[$this->getPostVar()]["constr_prop"]);
     }

Here is the call graph for this function:

◆ setWidth()

ilWidthHeightInputGUI::setWidth ( $a_width )

Set Width.

Parameters

integer $a_width Width

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

Referenced by checkInput(), and setValueByArray().

     {
         $this->width = $a_width;
     }

Here is the caller graph for this function:

Field Documentation

◆ $user

ilWidthHeightInputGUI::$user

protected

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

Referenced by setValueByArray().

◆ $value

ilWidthHeightInputGUI::$value

protected

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

Referenced by checkInput(), and insert().

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

Services/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()

◆ getWidth()

◆ insert()

◆ setConstrainProportions()

◆ setHeight()

◆ setValueByArray()

◆ setWidth()

Field Documentation

◆ $user

◆ $value