ILIAS\WebDAV\Mount\DocumentFormGUI Class Reference

Inheritance diagram for ILIAS\WebDAV\Mount\DocumentFormGUI:

Collaboration diagram for ILIAS\WebDAV\Mount\DocumentFormGUI:

Public Member Functions
	__construct (protected Document $document, protected Repository $mount_instructions_repository, protected ilHtmlPurifierInterface $document_purifier, protected ilObjUser $actor, protected Filesystem $tmp_filesystem, protected FileUpload $file_upload, protected string $form_action, protected string $save_command, protected string $cancel_command, protected bool $is_editable)
	saveObject ()
	updateObject ()
	hasTranslatedInfo ()
	hasTranslatedError ()
	getTranslatedInfo ()
	getTranslatedError ()
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 ()

Protected Member Functions
	initForm ()
	createFilledObject (Document $document)
	getRawMountInstructionsFromFileUpload (UploadResult $upload_result)
	getFileUploadResult ()
Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()
	getFileHash ()
	hideRequired (string $a_type)
	appendOnloadCode (string $html)
	rebuildUploadedFiles ()
	checkForRequiredField ()

Protected Attributes
string	$translated_error = ''
string	$translated_info = ''
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 37 of file DocumentFormGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WebDAV\Mount\DocumentFormGUI::__construct	(	protected Document	$document,
		protected Repository	$mount_instructions_repository,
		protected ilHtmlPurifierInterface	$document_purifier,
		protected ilObjUser	$actor,
		protected Filesystem	$tmp_filesystem,
		protected FileUpload	$file_upload,
		protected string	$form_action,
		protected string	$save_command,
		protected string	$cancel_command,
		protected bool	$is_editable
	)

Definition at line 42 of file DocumentFormGUI.php.

      {
        parent::__construct();
 
        $this->initForm();
    }

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\WebDAV\Mount\DocumentFormGUI\initForm().

Here is the call graph for this function:

Member Function Documentation

createFilledObject()

ILIAS\WebDAV\Mount\DocumentFormGUI::createFilledObject ( Document  $document )

protected

Definition at line 165 of file DocumentFormGUI.php.

                                                             : Document
    {
        if (!$this->checkInput()) {
            throw new InvalidArgumentException($this->lng->txt('form_input_not_valid'));
        }
 
        $document_already_exists = $document->getId() > 0;
 
        if (!$document_already_exists) {
            $upload_result = $this->getFileUploadResult();
        }
 
        if (!$document_already_exists && !$upload_result->isOK()) {
            throw new InvalidArgumentException($this->lng->txt('form_input_not_valid'));
        }
 
        $title = $this->getInput('title');
        $language = $this->getInput('lng');
        $creation_ts = $document_already_exists ? $document->getCreationTs() : ilUtil::now();
        $modification_ts = $document_already_exists ? ilUtil::now() : $creation_ts;
        $owner_id = $document_already_exists ? $document->getOwnerUsrId() : $this->actor->getId();
        $last_modified_usr_id = $this->actor->getId();
        $sorting = $document_already_exists ? $document->getSorting()
            : $this->mount_instructions_repository->getHighestSortingNumber() + 1;
 
        $mount_instruction_for_language_exists = $this->mount_instructions_repository->doMountInstructionsExistByLanguage(
            $language
        );
 
        if (!$document_already_exists && $mount_instruction_for_language_exists) {
            throw new InvalidArgumentException($this->lng->txt('webdav_choosen_language_already_used'));
        }
 
        if ($document_already_exists && $document->getLanguage() !== $language &&
            $mount_instruction_for_language_exists > 0 &&
            $mount_instruction_for_language_exists !== $document->getId()) {
            throw new InvalidArgumentException($this->lng->txt('webdav_chosen_language_already_used'));
        }
 
        if ($document_already_exists) {
            $raw_mount_instructions = '';
            $processed_mount_instructions = '';
        } else {
            $raw_mount_instructions = $this->getRawMountInstructionsFromFileUpload($upload_result);
            $document_processor = $upload_result->getMimeType() === 'text/html'
                ? new HtmlDocumentProcessor($this->document_purifier)
                : new TextDocumentProcessor();
            $processed_mount_instructions = $document_processor->processMountInstructions($raw_mount_instructions);
        }
 
        $id = $document_already_exists ? $document->getId()
            : $this->mount_instructions_repository->getNextMountInstructionsDocumentId();
 
        return new Document(
            $id,
            $title,
            $raw_mount_instructions,
            json_encode($processed_mount_instructions),
            $language,
            $creation_ts,
            $modification_ts,
            $owner_id,
            $last_modified_usr_id,
            $sorting
        );
    }

References ilFormGUI\$id, ilPropertyFormGUI\$title, ilPropertyFormGUI\checkInput(), ILIAS\WebDAV\Mount\Document\getCreationTs(), ILIAS\WebDAV\Mount\DocumentFormGUI\getFileUploadResult(), ILIAS\WebDAV\Mount\Document\getId(), ilPropertyFormGUI\getInput(), ILIAS\WebDAV\Mount\Document\getLanguage(), ILIAS\WebDAV\Mount\Document\getOwnerUsrId(), ILIAS\WebDAV\Mount\DocumentFormGUI\getRawMountInstructionsFromFileUpload(), ILIAS\WebDAV\Mount\Document\getSorting(), ILIAS\Repository\lng(), and ilUtil\now().

Referenced by ILIAS\WebDAV\Mount\DocumentFormGUI\saveObject(), and ILIAS\WebDAV\Mount\DocumentFormGUI\updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

getFileUploadResult()

ILIAS\WebDAV\Mount\DocumentFormGUI::getFileUploadResult ( )

protected

Definition at line 264 of file DocumentFormGUI.php.

                                            : UploadResult
    {
        if (!$this->file_upload->hasUploads()) {
            throw new InvalidArgumentException('webdav_error_no_upload');
        }
        if (!$this->file_upload->hasBeenProcessed()) {
            $this->file_upload->process();
        }
 
        $upload_result = array_values($this->file_upload->getResults())[0];
 
        if (!$upload_result) {
            $this->getItemByPostVar('document')->setAlert($this->lng->txt('form_msg_file_no_upload'));
            throw new InvalidArgumentException($this->lng->txt('form_input_not_valid'));
        }
 
        return $upload_result;
    }

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

Referenced by ILIAS\WebDAV\Mount\DocumentFormGUI\createFilledObject().

Here is the call graph for this function:

Here is the caller graph for this function:

getRawMountInstructionsFromFileUpload()

ILIAS\WebDAV\Mount\DocumentFormGUI::getRawMountInstructionsFromFileUpload ( UploadResult  $upload_result )

protected

Definition at line 232 of file DocumentFormGUI.php.

                                                                                         : string
    {
        if ($upload_result->getName() === '') {
            throw new InvalidArgumentException('uploaded file has no name');
        }
 
        if (!$upload_result->isOK()) {
            $this->getItemByPostVar('document')->setAlert($upload_result->getStatus()->getMessage());
            throw new InvalidArgumentException($this->lng->txt('form_input_not_valid'));
        }
 
        $this->file_upload->moveOneFileTo(
            $upload_result,
            '/mount_instructions',
            Location::TEMPORARY,
            '',
            true
        );
 
        $path_to_file = '/mount_instructions/' . $upload_result->getName();
        if (!$this->tmp_filesystem->has($path_to_file)) {
            $this->getItemByPostVar('document')->setAlert($this->lng->txt('form_msg_file_no_upload'));
            throw new InvalidArgumentException($this->lng->txt('form_input_not_valid'));
        }
 
        $raw_content = $this->tmp_filesystem->read($path_to_file);
 
        $this->tmp_filesystem->delete($path_to_file);
 
        return $raw_content;
    }

References ilPropertyFormGUI\getItemByPostVar(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getStatus(), ILIAS\FileUpload\DTO\UploadResult\isOK(), ILIAS\Repository\lng(), and ILIAS\FileUpload\Location\TEMPORARY.

Referenced by ILIAS\WebDAV\Mount\DocumentFormGUI\createFilledObject().

Here is the call graph for this function:

Here is the caller graph for this function:

getTranslatedError()

ILIAS\WebDAV\Mount\DocumentFormGUI::getTranslatedError

(

)

Definition at line 160 of file DocumentFormGUI.php.

                                        : string
    {
        return $this->translated_error;
    }

References ILIAS\WebDAV\Mount\DocumentFormGUI\$translated_error.

getTranslatedInfo()

ILIAS\WebDAV\Mount\DocumentFormGUI::getTranslatedInfo

(

)

Definition at line 155 of file DocumentFormGUI.php.

                                       : string
    {
        return $this->translated_info;
    }

References ILIAS\WebDAV\Mount\DocumentFormGUI\$translated_info.

hasTranslatedError()

ILIAS\WebDAV\Mount\DocumentFormGUI::hasTranslatedError

(

)

Definition at line 150 of file DocumentFormGUI.php.

                                        : bool
    {
        return $this->translated_error !== '';
    }

hasTranslatedInfo()

ILIAS\WebDAV\Mount\DocumentFormGUI::hasTranslatedInfo

(

)

Definition at line 145 of file DocumentFormGUI.php.

                                       : bool
    {
        return $this->translated_info !== '';
    }

initForm()

ILIAS\WebDAV\Mount\DocumentFormGUI::initForm ( )

protected

Definition at line 59 of file DocumentFormGUI.php.

                                 : void
    {
        $document_already_exists = $this->document->getId() > 0;
        if ($document_already_exists) {
            $this->setTitle($this->lng->txt('webdav_form_edit_doc_head'));
        } else {
            $this->setTitle($this->lng->txt('webdav_form_new_doc_head'));
        }
 
        $this->setFormAction($this->form_action);
 
        $title = new ilTextInputGUI($this->lng->txt('webdav_form_document_title'), 'title');
        $title->setInfo($this->lng->txt('webdav_form_document_title_info'));
        $title->setRequired(true);
        $title->setDisabled(!$this->is_editable);
        $title->setValue($this->document->getTitle());
        $title->setMaxLength(255);
        $this->addItem($title);
 
        $document_label = $this->lng->txt('webdav_form_document');
        $document_by_line = $this->lng->txt('webdav_form_document_info');
 
        $language_selection = new ilSelectInputGUI(
            $this->lng->txt('language'),
            'lng'
        );
        $language_selection->setRequired(true);
 
        $options = [];
        foreach ($this->lng->getInstalledLanguages() as $lng) {
            $options[$lng] = $this->lng->txt('meta_l_' . $lng, 'meta');
        }
 
        asort($options);
 
        $language_selection->setOptions(['' => $this->lng->txt('please_choose')] + $options);
        $language_selection->setValue($this->document->getLanguage());
 
        $this->addItem($language_selection);
 
        if ($document_already_exists) {
            $document_id = new ilHiddenInputGUI('document_id');
            $document_id->setValue((string) $this->document->getId());
            $this->addItem($document_id);
        } else {
            $document_upload = new ilFileInputGUI($document_label, 'document');
            $document_upload->setInfo($document_by_line);
            $document_upload->setRequired(true);
            $document_upload->setDisabled(!$this->is_editable);
            $document_upload->setSuffixes(['html', 'htm', 'txt']);
            $this->addItem($document_upload);
        }
 
        if ($this->is_editable) {
            $this->addCommandButton($this->save_command, $this->lng->txt('save'));
        }
    }

References ilPropertyFormGUI\$lng, ILIAS\UI\Implementation\Component\Input\Field\$options, ilPropertyFormGUI\$title, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by ILIAS\WebDAV\Mount\DocumentFormGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

saveObject()

ILIAS\WebDAV\Mount\DocumentFormGUI::saveObject

(

)

Definition at line 117 of file DocumentFormGUI.php.

                                : bool
    {
        try {
            $this->document = $this->createFilledObject($this->document);
            $this->mount_instructions_repository->createMountInstructionsDocumentEntry($this->document);
        } catch (InvalidArgumentException $e) {
            $this->setValuesByPost();
            $this->translated_error .= $e->getMessage();
            return false;
        }
 
        return true;
    }

References Vendor\Package\$e, ILIAS\WebDAV\Mount\DocumentFormGUI\createFilledObject(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

updateObject()

ILIAS\WebDAV\Mount\DocumentFormGUI::updateObject

(

)

Definition at line 131 of file DocumentFormGUI.php.

                                  : bool
    {
        try {
            $this->document = $this->createFilledObject($this->document);
            $this->mount_instructions_repository->updateMountInstructions($this->document);
        } catch (InvalidArgumentException $e) {
            $this->setValuesByPost();
            $this->translated_error .= $e->getMessage();
            return false;
        }
 
        return true;
    }

References Vendor\Package\$e, ILIAS\WebDAV\Mount\DocumentFormGUI\createFilledObject(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

Field Documentation

$translated_error

string ILIAS\WebDAV\Mount\DocumentFormGUI::$translated_error = ''

protected

Definition at line 39 of file DocumentFormGUI.php.

Referenced by ILIAS\WebDAV\Mount\DocumentFormGUI\getTranslatedError().

$translated_info

string ILIAS\WebDAV\Mount\DocumentFormGUI::$translated_info = ''

protected

Definition at line 40 of file DocumentFormGUI.php.

Referenced by ILIAS\WebDAV\Mount\DocumentFormGUI\getTranslatedInfo().

---

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

• components/ILIAS/WebDAV/src/Mount/DocumentFormGUI.php