This class represents a text property in a property form. More...

Inheritance diagram for ilAlphabetInputGUI:

Collaboration diagram for ilAlphabetInputGUI:

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

	setValue (string $a_value)

	getValue ()

	setValueByArray (array $a_values)

	setLetters (array $a_val)

	getLetters ()

	checkInput ()

	getInput ()

	setFixDBUmlauts (bool $a_val)

	getFixDBUmlauts ()

	fixDBUmlauts (string $l)

	setParentCommand (object $a_obj, string $a_cmd)

	setHighlighted (string $a_high_letter)

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

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 Member Functions
	render (string $a_mode="")

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)

Protected Attributes
array	$letters = []

object	$parent_object

string	$parent_cmd = ""

bool	$highlight = false

string	$highlight_letter = ""

bool	$fix_db_umlauts = false

bool	$db_supports_distinct_umlauts = null

ilDBInterface	$db

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

Private Member Functions
	dbSupportsDisctinctUmlauts ()
	Only temp fix for #8603, should go to db classes. More...

Private Attributes
string	$value = ""

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Detailed Description

This class represents a text property in a property form.

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

Deprecated:: 12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 39 of file class.ilAlphabetInputGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->db = $DIC->database();
         parent::__construct($a_title, $a_postvar);
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilAlphabetInputGUI::checkInput ( )

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

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\str(), and ilLanguage\txt().

                                 : bool
     {
         $lng = $this->lng;
 
         if ($this->getRequired() && trim($this->str($this->getPostVar())) == "") {
             $this->setAlert($lng->txt("msg_input_is_required"));
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ dbSupportsDisctinctUmlauts()

ilAlphabetInputGUI::dbSupportsDisctinctUmlauts ( )

private

Only temp fix for #8603, should go to db classes.

Deprecated:

Definition at line 55 of file class.ilAlphabetInputGUI.php.

References $db_supports_distinct_umlauts.

Referenced by fixDBUmlauts().

                                                  : ?bool
     {
         if (!isset($this->db_supports_distinct_umlauts)) {
             $set = $this->db->query(
                 "SELECT (" . $this->db->quote("A", "text") . " = " . $this->db->quote("Ä", "text") . ") t FROM DUAL "
             );
             $rec = $this->db->fetchAssoc($set);
             $this->db_supports_distinct_umlauts = !(bool) $rec["t"];
         }
 
         return $this->db_supports_distinct_umlauts;
     }

Here is the caller graph for this function:

◆ fixDBUmlauts()

ilAlphabetInputGUI::fixDBUmlauts ( string $l )

Definition at line 120 of file class.ilAlphabetInputGUI.php.

References dbSupportsDisctinctUmlauts().

Referenced by getToolbarHTML().

                                            : string
     {
         if ($this->fix_db_umlauts && !$this->dbSupportsDisctinctUmlauts()) {
             $l = str_replace(array("Ä", "Ö", "Ü", "ä", "ö", "ü"), array("A", "O", "U", "a", "o", "u"), $l);
         }
         return $l;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFixDBUmlauts()

ilAlphabetInputGUI::getFixDBUmlauts ( )

Definition at line 115 of file class.ilAlphabetInputGUI.php.

References $fix_db_umlauts.

                                      : bool
     {
         return $this->fix_db_umlauts;
     }

◆ getInput()

ilAlphabetInputGUI::getInput ( )

Definition at line 105 of file class.ilAlphabetInputGUI.php.

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

                               : string
     {
         return $this->str($this->getPostVar());
     }

Here is the call graph for this function:

◆ getLetters()

ilAlphabetInputGUI::getLetters ( )

Definition at line 88 of file class.ilAlphabetInputGUI.php.

References $letters.

Referenced by getToolbarHTML().

                                 : array
     {
         return $this->letters;
     }

Here is the caller graph for this function:

◆ getToolbarHTML()

ilAlphabetInputGUI::getToolbarHTML ( )

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

Definition at line 149 of file class.ilAlphabetInputGUI.php.

References ilFormPropertyGUI\$ctrl, ilFormPropertyGUI\$lng, fixDBUmlauts(), getLetters(), ilLanguage\loadLanguageModule(), null, and ilLanguage\txt().

                                     : string
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $lng->loadLanguageModule("form");
 
         $tpl = new ilTemplate("tpl.prop_alphabet.html", true, true, "components/ILIAS/Form");
         foreach ($this->getLetters() as $l) {
             if (is_null($l)) {
                 continue;
             }
             $l = $this->fixDBUmlauts($l);
             $tpl->setCurrentBlock("letter");
             $tpl->setVariable("TXT_LET", $l);
             $ilCtrl->setParameter($this->parent_object, "letter", rawurlencode($l));
             $tpl->setVariable("TXT_LET", $l);
             $tpl->setVariable("HREF_LET", $ilCtrl->getLinkTarget($this->parent_object, $this->parent_cmd));
             if ($this->highlight && $this->highlight_letter !== null && $this->highlight_letter == $l) {
                 $tpl->setVariable("CLASS", ' class="ilHighlighted" ');
             }
             $tpl->parseCurrentBlock();
         }
         $ilCtrl->setParameter($this->parent_object, "letter", "");
         $tpl->setVariable("TXT_ALL", $lng->txt("form_alphabet_all"));
         $tpl->setVariable("HREF_ALL", $ilCtrl->getLinkTarget($this->parent_object, $this->parent_cmd));
         if ($this->highlight && $this->highlight_letter === null) {
             $tpl->setVariable("CLASSA", ' class="ilHighlighted" ');
         }
         return $tpl->get();
     }

Here is the call graph for this function:

◆ getValue()

ilAlphabetInputGUI::getValue ( )

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

References $value.

                               : string
     {
         return $this->value;
     }

◆ render()

ilAlphabetInputGUI::render ( string $a_mode = "" )

protected

Definition at line 129 of file class.ilAlphabetInputGUI.php.

◆ setFixDBUmlauts()

ilAlphabetInputGUI::setFixDBUmlauts ( bool $a_val )

Definition at line 110 of file class.ilAlphabetInputGUI.php.

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

◆ setHighlighted()

ilAlphabetInputGUI::setHighlighted ( string $a_high_letter )

Definition at line 142 of file class.ilAlphabetInputGUI.php.

      : void {
         $this->highlight = ($a_high_letter != "");
         $this->highlight_letter = $a_high_letter;
     }

◆ setLetters()

ilAlphabetInputGUI::setLetters ( array $a_val )

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

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

◆ setParentCommand()

ilAlphabetInputGUI::setParentCommand	(	object	$a_obj,
		string	$a_cmd
	)

Definition at line 134 of file class.ilAlphabetInputGUI.php.

      : void {
         $this->parent_object = $a_obj;
         $this->parent_cmd = $a_cmd;
     }

◆ setValue()

ilAlphabetInputGUI::setValue ( string $a_value )

Definition at line 68 of file class.ilAlphabetInputGUI.php.

Referenced by setValueByArray().

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

Here is the caller graph for this function:

◆ setValueByArray()

ilAlphabetInputGUI::setValueByArray ( array $a_values )

Definition at line 78 of file class.ilAlphabetInputGUI.php.

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

                                                     : void
     {
         $this->setValue($a_values[$this->getPostVar()]);
     }

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilAlphabetInputGUI::$db

protected

Definition at line 37 of file class.ilAlphabetInputGUI.php.

◆ $db_supports_distinct_umlauts

bool ilAlphabetInputGUI::$db_supports_distinct_umlauts = null

protected

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

Referenced by dbSupportsDisctinctUmlauts().

◆ $fix_db_umlauts

bool ilAlphabetInputGUI::$fix_db_umlauts = false

protected

Definition at line 35 of file class.ilAlphabetInputGUI.php.

Referenced by getFixDBUmlauts().

◆ $highlight

bool ilAlphabetInputGUI::$highlight = false

protected

Definition at line 33 of file class.ilAlphabetInputGUI.php.

◆ $highlight_letter

string ilAlphabetInputGUI::$highlight_letter = ""

protected

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

◆ $letters

array ilAlphabetInputGUI::$letters = []

protected

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

Referenced by getLetters().

◆ $parent_cmd

string ilAlphabetInputGUI::$parent_cmd = ""

protected

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

◆ $parent_object

object ilAlphabetInputGUI::$parent_object

protected

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

◆ $value

string ilAlphabetInputGUI::$value = ""

private

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

Referenced by getValue().

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

components/ILIAS/Form/classes/class.ilAlphabetInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ dbSupportsDisctinctUmlauts()

◆ fixDBUmlauts()

◆ getFixDBUmlauts()

◆ getInput()

◆ getLetters()

◆ getToolbarHTML()

◆ getValue()

◆ render()

◆ setFixDBUmlauts()

◆ setHighlighted()

◆ setLetters()

◆ setParentCommand()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $db

◆ $db_supports_distinct_umlauts

◆ $fix_db_umlauts

◆ $highlight

◆ $highlight_letter

◆ $letters

◆ $parent_cmd

◆ $parent_object

◆ $value