Inheritance diagram for ilForumThreadFormGUI:

Collaboration diagram for ilForumThreadFormGUI:

Public Member Functions
	__construct (private readonly ilObjForumGUI $delegatingGui, private readonly ilForumProperties $properties, private readonly bool $allowPseudonyms, private readonly bool $allowNotification, private readonly bool $isDraftContext, private readonly int $draftId)

	addInputItem (string $input_item)

	generateDefaultForm ()

	generateMinimalForm ()

Public Member Functions inherited from ilPropertyFormGUI
	__construct ()

	executeCommand ()

	setTableWidth (string $a_width)

	getTableWidth ()

	setMode (string $a_mode)

	getMode ()

	setTitle (string $a_title)

	getTitle ()

	setTitleIcon (string $a_titleicon)

	getTitleIcon ()

	setDescription (string $a_val)

	getDescription ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setShowTopButtons (bool $a_val)

	getShowTopButtons ()

	setForceTopButtons (bool $a_val)

	getForceTopButtons ()

	addItem ($a_item)

	removeItemByPostVar (string $a_post_var, bool $a_remove_unused_headers=false)

	getItemByPostVar (string $a_post_var)

	setItems (array $a_items)

	getItems ()

	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...

	setDisableStandardMessage (bool $a_val)

	getDisableStandardMessage ()

	getHideLabels ()

	setHideLabels (bool $a_value=true)

	setValuesByArray (array $a_values, bool $a_restrict_to_value_keys=false)

	setValuesByPost ()

	checkInput ()

	getInput (string $a_post_var, bool $ensureValidation=true)
	Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar. More...

	addCommandButton (string $a_cmd, string $a_text, string $a_id="")

	getCommandButtons ()

	clearCommandButtons ()

	getContent ()

	insertItem ( $item, bool $a_sub_item=false)

	addAsyncOnloadCode (string $code)

	getHTML ()

	getHTMLAsync ()

	getFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	Get file upload data. More...

	hasFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)

	moveFileUpload (string $a_target_directory, string $a_field, ?string $a_target_name=null, ?string $a_index=null, ?string $a_sub_index=null)
	Move upload to target directory. More...

Public Member Functions inherited from ilFormGUI
	setFormAction (string $a_formaction)

	getFormAction ()

	setTarget (string $a_target)

	getTarget ()

	setMultipart (bool $a_multipart)

	getMultipart ()

	setId (string $a_id)

	getId ()

	setName (string $a_name)

	getName ()

	setKeepOpen (bool $a_keepopen)

	getKeepOpen ()

	setOpenTag (bool $a_open)

	getOpenTag ()

	setCloseTag (bool $a_val)

	getCloseTag ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	getHTML ()

	getContent ()

Data Fields
const	ALIAS_INPUT = 'alias'

const	SUBJECT_INPUT = 'subject'

const	MESSAGE_INPUT = 'message'

const	FILE_UPLOAD_INPUT = 'file_upload'

const	ALLOW_NOTIFICATION_INPUT = 'allow_notification'

const	AUTOSAVE_INFO = 'autosave_info'

Private Member Functions
	addAliasInput ()

	addSubjectInput ()

	addMessageInput ()

	addAutosaveInfo ()

	addFileUploadInput ()

	addAllowNotificationInput ()

	generateInputItems ()

Private Attributes
array	$input_items = []

Additional Inherited Members
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

	checkForRequiredField ()

Protected Attributes inherited from ilPropertyFormGUI
bool	$required_text = false

ilLanguage	$lng

ilCtrl	$ctrl

ilTemplate	$tpl

ilObjUser	$user = null

ilSetting	$settings = null

string	$mode = "std"

bool	$check_input_called = false

bool	$disable_standard_message = false

string	$top_anchor = "il_form_top"

string	$title = ''

string	$titleicon = ""

string	$description = ""

string	$tbl_width = ""

bool	$show_top_buttons = true

bool	$hide_labels = false

bool	$force_top_buttons = false

HTTP Services	$http

Refinery Factory	$refinery = null

ilGlobalTemplateInterface	$global_tpl = null

	$onload_code = []

Protected Attributes inherited from ilFormGUI
string	$formaction = ""

bool	$multipart = false

bool	$keepopen = false

bool	$opentag = true

string	$id = ''

string	$name = ''

string	$target = ''

bool	$prevent_double_submission = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilForumThreadFormGUI::__construct	(	private readonly ilObjForumGUI	$delegatingGui,
		private readonly ilForumProperties	$properties,
		private readonly bool	$allowPseudonyms,
		private readonly bool	$allowNotification,
		private readonly bool	$isDraftContext,
		private readonly int	$draftId
	)

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

References ILIAS\GlobalScreen\Provider\__construct().

       {
         parent::__construct();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAliasInput()

ilForumThreadFormGUI::addAliasInput ( )

private

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

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by generateInputItems().

                                     : void
     {
         if ($this->allowPseudonyms) {
             $alias = new ilTextInputGUI($this->lng->txt('forums_your_name'), 'alias');
             $alias->setInfo($this->lng->txt('forums_use_alias'));
             $alias->setMaxLength(255);
             $alias->setSize(50);
         } else {
             $alias = new ilNonEditableValueGUI($this->lng->txt('forums_your_name'), 'alias');
             $alias->setValue($this->user->getLogin());
         }
         $this->addItem($alias);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAllowNotificationInput()

ilForumThreadFormGUI::addAllowNotificationInput ( )

private

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

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Referenced by generateInputItems().

                                                 : void
     {
         if ($this->allowNotification) {
             $notifyOnAnswer = new ilCheckboxInputGUI($this->lng->txt('forum_direct_notification'), 'notify');
             $notifyOnAnswer->setInfo($this->lng->txt('forum_notify_me'));
             $notifyOnAnswer->setValue('1');
             $this->addItem($notifyOnAnswer);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAutosaveInfo()

ilForumThreadFormGUI::addAutosaveInfo ( )

private

Definition at line 97 of file class.ilForumThreadFormGUI.php.

References ilPropertyFormGUI\addItem(), ilForumPostDraft\isAutoSavePostDraftAllowed(), ILIAS\Repository\lng(), and ilForumPostDraft\lookupAutosaveInterval().

Referenced by generateInputItems().

                                       : void
     {
         if (ilForumPostDraft::isAutoSavePostDraftAllowed()) {
             $draftInfoGUI = new ilNonEditableValueGUI('', 'autosave_info', true);
             $draftInfoGUI->setValue(
                 sprintf(
                     $this->lng->txt('autosave_draft_info'),
                     ilForumPostDraft::lookupAutosaveInterval()
                 )
             );
             $this->addItem($draftInfoGUI);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addFileUploadInput()

ilForumThreadFormGUI::addFileUploadInput ( )

private

Definition at line 111 of file class.ilForumThreadFormGUI.php.

References ilPropertyFormGUI\addItem(), ilCheckboxGroupInputGUI\addOption(), ILIAS\Repository\lng(), ilForumPostDraft\newInstanceByDraftId(), and ilFileWizardInputGUI\setFilenames().

Referenced by generateInputItems().

                                          : void
     {
         if ($this->properties->isFileUploadAllowed()) {
             $files = new ilFileWizardInputGUI($this->lng->txt('forums_attachments_add'), 'userfile');
             $files->setFilenames([0 => '']);
             $this->addItem($files);
 
             if ($this->isDraftContext && $this->draftId > 0) {
                 $threadDraft = ilForumPostDraft::newInstanceByDraftId($this->draftId);
                 if ($threadDraft->getDraftId() > 0) {
                     //
                     $draftFileData = new ilFileDataForumDrafts(0, $threadDraft->getDraftId());
                     if ($draftFileData->getFilesOfPost() !== []) {
                         $existingFileSelection = new ilCheckboxGroupInputGUI(
                             $this->lng->txt('forums_delete_file'),
                             'del_file'
                         );
                         foreach ($draftFileData->getFilesOfPost() as $file) {
                             $existingFileSelection->addOption(new ilCheckboxOption($file['name'], $file['md5']));
                         }
                         $this->addItem($existingFileSelection);
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addInputItem()

ilForumThreadFormGUI::addInputItem ( string $input_item )

Definition at line 186 of file class.ilForumThreadFormGUI.php.

                                                     : void
     {
         $this->input_items[] = $input_item;
     }

◆ addMessageInput()

ilForumThreadFormGUI::addMessageInput ( )

private

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

References $message, ilPropertyFormGUI\addItem(), ilHtmlPurifierFactory\getInstanceByType(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by generateInputItems().

                                       : void
     {
         $message = new ilTextAreaInputGUI($this->lng->txt('forums_the_post'), 'message');
         $message->setCols(50);
         $message->setRows(15);
         $message->setRequired(true);
         $message->setUseRte(true);
         $message->usePurifier(true);
         $message->setRTERootBlockElement('');
         $message->setRTESupport($this->user->getId(), 'frm~', 'frm_post', 'tpl.tinymce_frm_post.js', false, '5.6.0');
         $message->disableButtons([
             'charmap',
             'undo',
             'redo',
             'alignleft',
             'aligncenter',
             'alignright',
             'alignjustify',
             'anchor',
             'fullscreen',
             'cut',
             'copy',
             'paste',
             'pastetext',
             'formatselect'
         ]);
         $message->setPurifier(ilHtmlPurifierFactory::getInstanceByType('frm_post'));
         $this->addItem($message);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSubjectInput()

ilForumThreadFormGUI::addSubjectInput ( )

private

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

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Referenced by generateInputItems().

                                       : void
     {
         $subject = new ilTextInputGUI($this->lng->txt('forums_thread'), 'subject');
         $subject->setMaxLength(255);
         $subject->setSize(50);
         $subject->setRequired(true);
         $this->addItem($subject);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateDefaultForm()

ilForumThreadFormGUI::generateDefaultForm ( )

Definition at line 191 of file class.ilForumThreadFormGUI.php.

References ilPropertyFormGUI\addCommandButton(), ILIAS\Repository\ctrl(), generateInputItems(), ilForumPostDraft\isSavePostDraftAllowed(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ILIAS\Repository\user().

                                          : void
     {
         $this->generateInputItems();
 
         if (ilForumPostDraft::isSavePostDraftAllowed() && !$this->user->isAnonymous()) {
             $this->ctrl->setParameter($this->delegatingGui, 'draft_id', $this->draftId);
             if (in_array($this->ctrl->getCmd(), ['publishThreadDraft', 'editThreadDraft', 'updateThreadDraft'])) {
                 $this->addCommandButton('publishThreadDraft', $this->lng->txt('publish'));
                 $this->addCommandButton('updateThreadDraft', $this->lng->txt('save_message'));
                 $this->setFormAction($this->ctrl->getFormAction($this->delegatingGui, 'updateThreadDraft'));
             } else {
                 $this->addCommandButton('addThread', $this->lng->txt('create'));
                 $this->addCommandButton('saveThreadAsDraft', $this->lng->txt('save_message'));
                 $this->setFormAction($this->ctrl->getFormAction($this->delegatingGui, 'saveThreadAsDraft'));
             }
             $this->addCommandButton('cancelDraft', $this->lng->txt('cancel'));
         } else {
             $this->addCommandButton('addThread', $this->lng->txt('create'));
             $this->addCommandButton('showThreads', $this->lng->txt('cancel'));
             $this->setFormAction($this->ctrl->getFormAction($this->delegatingGui, 'addThread'));
         }
     }

Here is the call graph for this function:

◆ generateInputItems()

ilForumThreadFormGUI::generateInputItems ( )

private

Definition at line 148 of file class.ilForumThreadFormGUI.php.

References addAliasInput(), addAllowNotificationInput(), addAutosaveInfo(), addFileUploadInput(), addMessageInput(), addSubjectInput(), ilUtil\getImagePath(), ILIAS\Repository\lng(), ilPropertyFormGUI\setTableWidth(), ilPropertyFormGUI\setTitle(), and ilPropertyFormGUI\setTitleIcon().

Referenced by generateDefaultForm(), and generateMinimalForm().

                                          : void
     {
         $this->setTitleIcon(ilUtil::getImagePath('standard/icon_frm.svg'));
         $this->setTableWidth('100%');
         $this->setTitle($this->lng->txt('forums_new_thread'));
         if ($this->isDraftContext) {
             $this->setTitle($this->lng->txt('edit_thread_draft'));
         }
 
         foreach ($this->input_items as $input_item) {
             switch ($input_item) {
                 case self::ALIAS_INPUT:
                     $this->addAliasInput();
                     break;
 
                 case self::SUBJECT_INPUT:
                     $this->addSubjectInput();
                     break;
 
                 case self::MESSAGE_INPUT:
                     $this->addMessageInput();
                     break;
 
                 case self::FILE_UPLOAD_INPUT:
                     $this->addFileUploadInput();
                     break;
 
                 case self::ALLOW_NOTIFICATION_INPUT:
                     $this->addAllowNotificationInput();
                     break;
 
                 case self::AUTOSAVE_INFO:
                     $this->addAutosaveInfo();
                     break;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateMinimalForm()

ilForumThreadFormGUI::generateMinimalForm ( )

Definition at line 214 of file class.ilForumThreadFormGUI.php.

References ilPropertyFormGUI\addCommandButton(), ILIAS\Repository\ctrl(), generateInputItems(), ILIAS\Repository\lng(), and ilFormGUI\setFormAction().

                                          : void
     {
         $this->generateInputItems();
 
         $this->addCommandButton('addEmptyThread', $this->lng->txt('create'));
         $this->addCommandButton('showThreads', $this->lng->txt('cancel'));
         $this->setFormAction($this->ctrl->getFormAction($this->delegatingGui, 'addThread'));
     }