Class ilManualPlaceholderInputGUI. More...

Inheritance diagram for ilManualPlaceholderInputGUI:

Collaboration diagram for ilManualPlaceholderInputGUI:

Public Member Functions
	__construct (string $label, string $dependencyElementId)

	getRerenderUrl ()

	getRerenderTriggerElementName ()

	supportsRerenderSignal (string $elementId, string $url)

	getAdviseText ()

	setAdviseText (string $adviseText)

	getInstructionText ()

	setInstructionText (string $instructionText)

	addPlaceholder (string $placeholder, string $title)

	insert (ilTemplate $a_tpl)

	render (bool $ajax=false)

	setValueByArray (array $a_values)

	setValue ($a_value)

	checkInput ()

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)

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	$httpState

array	$placeholders = []

string	$rerenderUrl = ''

string	$rerenderTriggerElementName = ''

string	$dependencyElementId

string	$instructionText = ''

string	$adviseText = ''

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

Class ilManualPlaceholderInputGUI.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilManualPlaceholderInputGUI::__construct	(	string	$label,
		string	$dependencyElementId
	)

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addPlaceholder()

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

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

References ilFormPropertyGUI\$title.

Referenced by ilObjMailGUI\getExternalSettingsForm().

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

Here is the caller graph for this function:

◆ checkInput()

ilManualPlaceholderInputGUI::checkInput ( )

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

                                 : bool
     {
         return true;
     }

◆ getAdviseText()

ilManualPlaceholderInputGUI::getAdviseText ( )

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

References $adviseText.

Referenced by render().

                                    : string
     {
         return $this->adviseText;
     }

Here is the caller graph for this function:

◆ getInstructionText()

ilManualPlaceholderInputGUI::getInstructionText ( )

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

References $instructionText.

                                         : string
     {
         return $this->instructionText;
     }

◆ getRerenderTriggerElementName()

ilManualPlaceholderInputGUI::getRerenderTriggerElementName ( )

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

References $rerenderTriggerElementName.

Referenced by render().

                                                    : string
     {
         return $this->rerenderTriggerElementName;
     }

Here is the caller graph for this function:

◆ getRerenderUrl()

ilManualPlaceholderInputGUI::getRerenderUrl ( )

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

References $rerenderUrl.

Referenced by render().

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

Here is the caller graph for this function:

◆ insert()

ilManualPlaceholderInputGUI::insert ( ilTemplate $a_tpl )

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

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

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

Here is the call graph for this function:

◆ render()

ilManualPlaceholderInputGUI::render ( bool $ajax = false )

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

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

Referenced by insert().

                                               : string
     {
         $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) {
             $this->httpState->saveResponse(
                 $this->httpState
                     ->response()
                     ->withBody(Streams::ofString($subtpl->get()))
             );
             $this->httpState->sendResponse();
             $this->httpState->close();
         }
 
         return $subtpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdviseText()

ilManualPlaceholderInputGUI::setAdviseText ( string $adviseText )

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

References $adviseText.

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

◆ setInstructionText()

ilManualPlaceholderInputGUI::setInstructionText ( string $instructionText )

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

References $instructionText.

Referenced by ilMailTemplateGUI\getAjaxPlaceholdersById(), and ilMailFormGUI\showForm().

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

Here is the caller graph for this function:

◆ setValue()

ilManualPlaceholderInputGUI::setValue ( $a_value )

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

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

Referenced by setValueByArray().

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

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

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

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

Here is the call graph for this function:

◆ supportsRerenderSignal()

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

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

References $url.

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