class.ilForumThreadFormGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilForumThreadFormGUI extends ilPropertyFormGUI
{
    public const ALIAS_INPUT = 'alias';
    public const SUBJECT_INPUT = 'subject';
    public const MESSAGE_INPUT = 'message';
    public const FILE_UPLOAD_INPUT = 'file_upload';
    public const ALLOW_NOTIFICATION_INPUT = 'allow_notification';
    public const AUTOSAVE_INFO = 'autosave_info';

    private array $input_items = [];

    public function __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
    ) {
        parent::__construct();
    }

    private function addAliasInput(): 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);
    }

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

    private function addMessageInput(): 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'));
        $message->setInfo($this->lng->txt('latex_edit_info'));
        $this->addItem($message);
    }

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

    private function addFileUploadInput(): 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);
                    }
                }
            }
        }
    }

    private function addAllowNotificationInput(): 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);
        }
    }

    private function generateInputItems(): 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;
            }
        }
    }

    public function addInputItem(string $input_item): void
    {
        $this->input_items[] = $input_item;
    }

    public function generateDefaultForm(): 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'));
        }
    }

    public function generateMinimalForm(): 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'));
    }
}