Class ilManualPlaceholderInputGUI. More...

Inheritance diagram for ilManualPlaceholderInputGUI:

Collaboration diagram for ilManualPlaceholderInputGUI:

Public Member Functions
	__construct ($dependencyElementId)
	ilManualPlaceholderInputGUI constructor. More...

	getRerenderUrl ()

	getRerenderTriggerElementName ()

	supportsRerenderSignal ($elementId, $url)

	getAdviseText ()

	setAdviseText ($adviseText)

	getInstructionText ()

	setInstructionText ($instructionText)

	addPlaceholder ($placeholder, $title)

	insert ($a_tpl)

	render ($ajax=false)

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

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

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

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. 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...

Protected Attributes
	$placeholders = array()

	$rerenderUrl

	$rerenderTriggerElementName

	$dependencyElementId

	$instructionText = ''

	$adviseText = ''

	$tpl

	$lng

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

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

Class ilManualPlaceholderInputGUI.

Author: Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de

Definition at line 10 of file class.ilManualPlaceholderInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilManualPlaceholderInputGUI::__construct ( $dependencyElementId )

ilManualPlaceholderInputGUI constructor.

Parameters

string $dependencyElementId

Definition at line 56 of file class.ilManualPlaceholderInputGUI.php.

    {
        global $DIC;
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
 
        parent::__construct('');
 
        $this->dependencyElementId = $dependencyElementId;
 
        $this->tpl->addJavaScript('Services/Mail/js/ilMailComposeFunctions.js');
    }

References $dependencyElementId, $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ addPlaceholder()

ilManualPlaceholderInputGUI::addPlaceholder	(	$placeholder,
		$title
	)

Parameters

string	$placeholder
string	$title

Definition at line 132 of file class.ilManualPlaceholderInputGUI.php.

    {
        $this->placeholders[$placeholder]['placeholder'] = $placeholder;
        $this->placeholders[$placeholder]['title'] = $title;
    }

References ilFormPropertyGUI\$title.

◆ checkInput()

ilManualPlaceholderInputGUI::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 213 of file class.ilManualPlaceholderInputGUI.php.

    {
        return true;
    }

◆ getAdviseText()

ilManualPlaceholderInputGUI::getAdviseText ( )

Returns: string

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

    {
        return $this->adviseText;
    }

References $adviseText.

Referenced by render().

Here is the caller graph for this function:

◆ getInstructionText()

ilManualPlaceholderInputGUI::getInstructionText ( )

Returns: string

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

    {
        return $this->instructionText;
    }

References $instructionText.

◆ getRerenderTriggerElementName()

ilManualPlaceholderInputGUI::getRerenderTriggerElementName ( )

Returns: string

Definition at line 81 of file class.ilManualPlaceholderInputGUI.php.

    {
        return $this->rerenderTriggerElementName;
    }

References $rerenderTriggerElementName.

Referenced by render().

Here is the caller graph for this function:

◆ getRerenderUrl()

ilManualPlaceholderInputGUI::getRerenderUrl ( )

Returns: string

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

    {
        return $this->rerenderUrl;
    }

References $rerenderUrl.

Referenced by render().

Here is the caller graph for this function:

◆ insert()

ilManualPlaceholderInputGUI::insert ( $a_tpl )

Parameters

$a_tpl

Definition at line 141 of file class.ilManualPlaceholderInputGUI.php.

    {
        $html = $this->render();
 
        $a_tpl->setCurrentBlock("prop_generic");
        $a_tpl->setVariable("PROP_GENERIC", $html);
        $a_tpl->parseCurrentBlock();
    }

References render().

Here is the call graph for this function:

◆ render()

ilManualPlaceholderInputGUI::render ( $ajax = false )

Parameters

bool $ajax

Returns: string|void

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

    {
        $subtpl = new ilTemplate("tpl.mail_manual_placeholders.html", true, true, "Services/Mail");
        $subtpl->setVariable('TXT_USE_PLACEHOLDERS', $this->lng->txt('mail_nacc_use_placeholder'));
        $subtpl->setVariable('DEPENDENCY_ELM_ID_OUTER', $this->dependencyElementId);
        if ($this->getAdviseText()) {
            $subtpl->setVariable('TXT_PLACEHOLDERS_ADVISE', $this->getAdviseText());
        }
 
        if (count($this->placeholders) > 0) {
            foreach ($this->placeholders as $placeholder) {
                $subtpl->setCurrentBlock('man_placeholder');
                $subtpl->setVariable('DEPENDENCY_ELM_ID', $this->dependencyElementId);
                $subtpl->setVariable('PLACEHOLDER', '[' . $placeholder['placeholder'] . ']');
                $subtpl->setVariable('PLACEHOLDER_INTERACTION_INFO', sprintf(
                    $this->lng->txt('mail_hint_add_placeholder_x'),
                    '[' . $placeholder['placeholder'] . ']'
                ));
                $subtpl->setVariable('PLACEHOLDER_DESCRIPTION', $placeholder['title']);
                $subtpl->parseCurrentBlock();
            }
        }
 
        if ($this->getRerenderTriggerElementName() && $this->getRerenderUrl()) {
            $subtpl->setVariable('RERENDER_URL', $this->getRerenderUrl());
            $subtpl->setVariable('RERENDER_TRIGGER_ELM_NAME', $this->getRerenderTriggerElementName());
        }
 
        if ($ajax) {
            echo $subtpl->get();
            exit();
        }
 
        return $subtpl->get();
    }

References exit, getAdviseText(), getRerenderTriggerElementName(), and getRerenderUrl().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdviseText()

ilManualPlaceholderInputGUI::setAdviseText ( $adviseText )

Parameters

string $adviseText

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

    {
        $this->adviseText = $adviseText;
    }

References $adviseText.

◆ setInstructionText()

ilManualPlaceholderInputGUI::setInstructionText ( $instructionText )

Parameters

string $instructionText

Definition at line 123 of file class.ilManualPlaceholderInputGUI.php.

    {
        $this->instructionText = $instructionText;
    }

References $instructionText.

◆ setValue()

ilManualPlaceholderInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Definition at line 204 of file class.ilManualPlaceholderInputGUI.php.

    {
        if ($this->getMulti() && is_array($a_value)) {
            $this->setMultiValues($a_value);
            $a_value = array_shift($a_value);
        }
        $this->value = $a_value;
    }

References ilFormPropertyGUI\getMulti(), and ilFormPropertyGUI\setMultiValues().

Referenced by setValueByArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueByArray()

ilManualPlaceholderInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 195 of file class.ilManualPlaceholderInputGUI.php.

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

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

Here is the call graph for this function:

◆ supportsRerenderSignal()

ilManualPlaceholderInputGUI::supportsRerenderSignal	(	$elementId,
		$url
	)

Parameters

string	$elementId
string	$url

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

    {
        $this->rerenderTriggerElementName = $elementId;
        $this->rerenderUrl = $url;
    }

References $url.

Field Documentation

◆ $adviseText

ilManualPlaceholderInputGUI::$adviseText = ''

protected

Definition at line 40 of file class.ilManualPlaceholderInputGUI.php.

Referenced by getAdviseText(), and setAdviseText().

◆ $dependencyElementId

ilManualPlaceholderInputGUI::$dependencyElementId

protected

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

Referenced by __construct().

◆ $instructionText

ilManualPlaceholderInputGUI::$instructionText = ''

protected

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

Referenced by getInstructionText(), and setInstructionText().

◆ $lng

ilManualPlaceholderInputGUI::$lng

protected

Definition at line 50 of file class.ilManualPlaceholderInputGUI.php.

◆ $placeholders

ilManualPlaceholderInputGUI::$placeholders = array()

protected

Definition at line 15 of file class.ilManualPlaceholderInputGUI.php.

◆ $rerenderTriggerElementName

ilManualPlaceholderInputGUI::$rerenderTriggerElementName

protected

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

Referenced by getRerenderTriggerElementName().

◆ $rerenderUrl

ilManualPlaceholderInputGUI::$rerenderUrl

protected

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

Referenced by getRerenderUrl().

◆ $tpl

ilManualPlaceholderInputGUI::$tpl

protected

Definition at line 45 of file class.ilManualPlaceholderInputGUI.php.

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

Services/Mail/classes/Form/class.ilManualPlaceholderInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPlaceholder()

◆ checkInput()

◆ getAdviseText()

◆ getInstructionText()

◆ getRerenderTriggerElementName()

◆ getRerenderUrl()

◆ insert()

◆ render()

◆ setAdviseText()

◆ setInstructionText()

◆ setValue()

◆ setValueByArray()

◆ supportsRerenderSignal()

Field Documentation

◆ $adviseText

◆ $dependencyElementId

◆ $instructionText

◆ $lng

◆ $placeholders

◆ $rerenderTriggerElementName

◆ $rerenderUrl

◆ $tpl