ilManualPlaceholderInputGUI Class Reference

Inheritance diagram for ilManualPlaceholderInputGUI:

Collaboration diagram for ilManualPlaceholderInputGUI:

Public Member Functions
	__construct (string $label, string $http_post_param_name, protected string $dependency_element_id)
	getRerenderUrl ()
	getRerenderTriggerElementName ()
	supportsRerenderSignal (string $element_id, string $url)
	getAdviseText ()
	setAdviseText (string $advise_text)
	getInstructionText ()
	setInstructionText (string $instruction_text)
	addPlaceholder (string $placeholder, string $title)
	insert (ilTemplate $a_tpl)
	render (bool $ajax=false)
	setValueByArray (array $a_values)
	setValue ($a_value)
	checkInput ()
	Check input, strip slashes etc. More...
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)
	getSubItems ()
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...
	checkSubItemsInput ()
	Check SubItems. More...
	getSubForm ()
	getItemByPostVar (string $a_post_var)
	Get item by post var. 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 Attributes
GlobalHttpState	$http_state
array	$placeholders = []
string	$rerender_url = ''
string	$rerender_trigger_element_name = ''
string	$instruction_text = ''
string	$advise_text = ''
ilGlobalTemplateInterface	$tpl
	$value
Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()
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

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...
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)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilManualPlaceholderInputGUI::__construct	(	string	$label,
		string	$http_post_param_name,
		protected string	$dependency_element_id
	)

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

    {
        global $DIC;
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->http_state = $DIC->http();
 
        parent::__construct($label, $http_post_param_name);
 
        $this->tpl->addJavaScript('assets/js/ilMailComposeFunctions.js');
    }

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

Here is the call graph for this function:

Member Function Documentation

addPlaceholder()

ilManualPlaceholderInputGUI::addPlaceholder	(	string	$placeholder,
		string	$title
	)

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

                                                                      : void
    {
        $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.

Reimplemented from ilFormPropertyGUI.

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

                                : bool
    {
        return true;
    }

getAdviseText()

ilManualPlaceholderInputGUI::getAdviseText

(

)

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

                                   : string
    {
        return $this->advise_text;
    }

References $advise_text.

Referenced by render().

Here is the caller graph for this function:

getInstructionText()

ilManualPlaceholderInputGUI::getInstructionText

(

)

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

                                        : string
    {
        return $this->instruction_text;
    }

References $instruction_text.

getRerenderTriggerElementName()

ilManualPlaceholderInputGUI::getRerenderTriggerElementName

(

)

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

                                                   : string
    {
        return $this->rerender_trigger_element_name;
    }

References $rerender_trigger_element_name.

Referenced by render().

Here is the caller graph for this function:

getRerenderUrl()

ilManualPlaceholderInputGUI::getRerenderUrl

(

)

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

                                    : ?string
    {
        return $this->rerender_url;
    }

References $rerender_url.

Referenced by render().

Here is the caller graph for this function:

insert()

ilManualPlaceholderInputGUI::insert

(

ilTemplate

$a_tpl

)

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

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

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

render()

ilManualPlaceholderInputGUI::render

(

bool

$ajax = false

)

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

                                              : string
    {
        $subtpl = new ilTemplate(
            'tpl.mail_manual_placeholders.html',
            true,
            true,
            'components/ILIAS/Mail'
        );
        $subtpl->setVariable('TXT_USE_PLACEHOLDERS', $this->lng->txt('mail_nacc_use_placeholder'));
        $subtpl->setVariable('DEPENDENCY_ELM_ID_OUTER', $this->dependency_element_id);
        if ($this->getAdviseText() !== '') {
            $subtpl->setVariable('TXT_PLACEHOLDERS_ADVISE', $this->getAdviseText());
        }
 
        foreach ($this->placeholders as $placeholder) {
            $subtpl->setCurrentBlock('man_placeholder');
            $subtpl->setVariable('DEPENDENCY_ELM_ID', $this->dependency_element_id);
            $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 (!$ajax && $this->getRerenderTriggerElementName() && $this->getRerenderUrl()) {
            $subtpl->setVariable('RERENDER_URL', $this->getRerenderUrl());
            $subtpl->setVariable('RERENDER_DEPENDENCY_ELM_ID_OUTER', $this->dependency_element_id);
            $subtpl->setVariable('RERENDER_TRIGGER_ELM_NAME', $this->getRerenderTriggerElementName());
        }
 
        if ($ajax) {
            $this->http_state->saveResponse(
                $this->http_state
                    ->response()
                    ->withBody(Streams::ofString($subtpl->get()))
            );
            $this->http_state->sendResponse();
            $this->http_state->close();
        }
 
        return $subtpl->get();
    }

References getAdviseText(), getRerenderTriggerElementName(), getRerenderUrl(), and ILIAS\Repository\lng().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

setAdviseText()

ilManualPlaceholderInputGUI::setAdviseText

(

string

$advise_text

)

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

                                                      : void
    {
        $this->advise_text = $advise_text;
    }

References $advise_text.

setInstructionText()

ilManualPlaceholderInputGUI::setInstructionText

(

string

$instruction_text

)

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

                                                                : void
    {
        $this->instruction_text = $instruction_text;
    }

References $instruction_text.

setValue()

ilManualPlaceholderInputGUI::setValue

(

$a_value

)

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

                                      : void
    {
        if (is_array($a_value) && $this->getMulti()) {
            $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

(

array

$a_values

)

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

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

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

Here is the call graph for this function:

supportsRerenderSignal()

ilManualPlaceholderInputGUI::supportsRerenderSignal	(	string	$element_id,
		string	$url
	)

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

                                                                           : void
    {
        $this->rerender_trigger_element_name = $element_id;
        $this->rerender_url = $url;
    }

References $url.

Field Documentation

$advise_text

string ilManualPlaceholderInputGUI::$advise_text = ''

protected

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

Referenced by getAdviseText(), and setAdviseText().

$http_state

GlobalHttpState ilManualPlaceholderInputGUI::$http_state

protected

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

$instruction_text

string ilManualPlaceholderInputGUI::$instruction_text = ''

protected

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

Referenced by getInstructionText(), and setInstructionText().

$placeholders

array ilManualPlaceholderInputGUI::$placeholders = []

protected

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

$rerender_trigger_element_name

string ilManualPlaceholderInputGUI::$rerender_trigger_element_name = ''

protected

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

Referenced by getRerenderTriggerElementName().

$rerender_url

string ilManualPlaceholderInputGUI::$rerender_url = ''

protected

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

Referenced by getRerenderUrl().

$tpl

ilGlobalTemplateInterface ilManualPlaceholderInputGUI::$tpl

protected

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

$value

ilManualPlaceholderInputGUI::$value

protected

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

---

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

• components/ILIAS/Mail/classes/Form/class.ilManualPlaceholderInputGUI.php