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...

	setFixDBUmlauts ($a_val)
	Set fix db umlauts. More...

	getFixDBUmlauts ()
	Get fix db umlauts. More...

	fixDBUmlauts ($l)
	Fix db umlauts. 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...

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. 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
	$lng

	$ctrl

	$letters

	$parent_object

	$parent_cmd

	$highlight

	$highlight_letter

	$fix_db_umlauts = false

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...

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

Reimplemented from ilFormPropertyGUI.

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

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

References $DIC.

Member Function Documentation

◆ checkInput()

ilAlphabetInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

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

    {
        $lng = $this->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;
    }

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

Here is the call graph for this function:

◆ fixDBUmlauts()

ilAlphabetInputGUI::fixDBUmlauts ( $l )

Fix db umlauts.

Parameters

return

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

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

References $l, and ilUtil\dbSupportsDisctinctUmlauts().

Referenced by getToolbarHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFixDBUmlauts()

ilAlphabetInputGUI::getFixDBUmlauts ( )

Get fix db umlauts.

Returns: bool fix db umlauts

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

    {
        return $this->fix_db_umlauts;
    }

References $fix_db_umlauts.

◆ getLetters()

ilAlphabetInputGUI::getLetters ( )

Get letters available.

Returns: array letters

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

    {
        return $this->letters;
    }

References $letters.

Referenced by getToolbarHTML().

Here is the caller graph for this function:

◆ getToolbarHTML()

ilAlphabetInputGUI::getToolbarHTML ( )

Get HTML for toolbar.

Implements ilToolbarItem.

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

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

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

Here is the call graph for this function:

◆ getValue()

ilAlphabetInputGUI::getValue ( )

Get Value.

Returns: string Value

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

    {
        return $this->value;
    }

◆ render()

ilAlphabetInputGUI::render ( $a_mode = "" )

protected

Render item.

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

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

◆ setFixDBUmlauts()

ilAlphabetInputGUI::setFixDBUmlauts ( $a_val )

Set fix db umlauts.

Parameters

bool $a_val fix db umlauts

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

    {
        $this->fix_db_umlauts = $a_val;
    }

◆ setHighlighted()

ilAlphabetInputGUI::setHighlighted ( $a_high_letter )

Set highlighted.

Parameters

return

Definition at line 196 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 89 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 184 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 58 of file class.ilAlphabetInputGUI.php.

    {
        $this->value = $a_value;
    }

Referenced by setValueByArray().

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 79 of file class.ilAlphabetInputGUI.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilAlphabetInputGUI::$ctrl

protected

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

Referenced by getToolbarHTML().

◆ $fix_db_umlauts

ilAlphabetInputGUI::$fix_db_umlauts = false

protected

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

Referenced by getFixDBUmlauts().

◆ $highlight

ilAlphabetInputGUI::$highlight

protected

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

◆ $highlight_letter

ilAlphabetInputGUI::$highlight_letter

protected

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

◆ $letters

ilAlphabetInputGUI::$letters

protected

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

Referenced by getLetters().

◆ $lng

ilAlphabetInputGUI::$lng

protected

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

Referenced by checkInput(), and getToolbarHTML().

◆ $parent_cmd

ilAlphabetInputGUI::$parent_cmd

protected

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

◆ $parent_object

ilAlphabetInputGUI::$parent_object

protected

Definition at line 28 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()

◆ fixDBUmlauts()

◆ getFixDBUmlauts()

◆ getLetters()

◆ getToolbarHTML()

◆ getValue()

◆ render()

◆ setFixDBUmlauts()

◆ setHighlighted()

◆ setLetters()

◆ setParentCommand()

◆ setValue()

◆ setValueByArray()

Field Documentation

◆ $ctrl

◆ $fix_db_umlauts

◆ $highlight

◆ $highlight_letter

◆ $letters

◆ $lng

◆ $parent_cmd

◆ $parent_object