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

Inheritance diagram for ilAlphabetInputGUI:

Collaboration diagram for ilAlphabetInputGUI:

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

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

	getValue ()
	Get Value. More...

	setValueByArray ($a_values)
	Set value by array. More...

	setLetters ($a_val)
	Set letters available. More...

	getLetters ()
	Get letters available. More...

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

	setParentCommand ($a_obj, $a_cmd)
	Insert property html. More...

	setHighlighted ($a_high_letter)
	Set highlighted. More...

	getToolbarHTML ()
	Get HTML for toolbar. 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 Member Functions
	render ($a_mode="")
	Render item. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Protected Attributes
	$letters

	$parent_object

	$parent_cmd

	$highlight

	$highlight_letter

Protected Attributes inherited from ilFormPropertyGUI
	$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...

Detailed Description

This class represents a text 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 15 of file class.ilAlphabetInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

         {
                 parent::__construct($a_title, $a_postvar);
         }

Member Function Documentation

◆ checkInput()

ilAlphabetInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

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

         {
                 global $lng;
                 
                 $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                 if ($this->getRequired() && trim($_POST[$this->getPostVar()]) == "")
                 {
                         $this->setAlert($lng->txt("msg_input_is_required"));
 
                         return false;
                 }
                 
                 return true;
         }

Here is the call graph for this function:

◆ getLetters()

ilAlphabetInputGUI::getLetters ( )

Get letters available.

Returns: array letters

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

References $letters.

Referenced by getToolbarHTML().

         {
                 return $this->letters;
         }

Here is the caller graph for this function:

◆ getToolbarHTML()

ilAlphabetInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

Implements ilToolbarItem.

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

References $ilCtrl, $l, $lng, $tpl, array, and getLetters().

         {
                 global $ilCtrl, $lng;
                 
                 $lng->loadLanguageModule("form");
 
                 $tpl = new ilTemplate("tpl.prop_alphabet.html", true, true, "Services/Form");
                 foreach ((array)$this->getLetters() as $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 ( )

Get Value.

Returns: string Value

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

         {
                 return $this->value;
         }

◆ render()

ilAlphabetInputGUI::render ( $a_mode = "" )

protected

Render item.

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

         {
                 die("only implemented for toolbar usage");
         }

◆ setHighlighted()

ilAlphabetInputGUI::setHighlighted ( $a_high_letter )

Set highlighted.

Parameters

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

         {
                 $this->highlight = true;
                 $this->highlight_letter = $a_high_letter;
         }

◆ setLetters()

ilAlphabetInputGUI::setLetters ( $a_val )

Set letters available.

Parameters

array letters

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

         {
                 $this->letters = $a_val;
         }

◆ setParentCommand()

ilAlphabetInputGUI::setParentCommand	(	$a_obj,
		$a_cmd
	)

Insert property html.

Returns: int Size Set parent cmd

Parameters

object	parent object
string	parent command

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

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

◆ setValue()

ilAlphabetInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by setValueByArray().

         {
                 $this->value = $a_value;
         }

Here is the caller graph for this function:

◆ setValueByArray()

ilAlphabetInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $highlight

ilAlphabetInputGUI::$highlight

protected

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

◆ $highlight_letter

ilAlphabetInputGUI::$highlight_letter

protected

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

◆ $letters

ilAlphabetInputGUI::$letters

protected

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

Referenced by getLetters().

◆ $parent_cmd

ilAlphabetInputGUI::$parent_cmd

protected

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

◆ $parent_object

ilAlphabetInputGUI::$parent_object

protected

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

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

Services/Form/classes/class.ilAlphabetInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getLetters()

◆ getToolbarHTML()

◆ getValue()

◆ render()

◆ setHighlighted()

◆ setLetters()

◆ setParentCommand()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $highlight

◆ $highlight_letter

◆ $letters

◆ $parent_cmd

◆ $parent_object