Inheritance diagram for ilWebDAVMountInstructionsDocumentFormGUI:

Collaboration diagram for ilWebDAVMountInstructionsDocumentFormGUI:

Public Member Functions
	__construct (ilWebDAVMountInstructionsDocument $a_document, ilWebDAVMountInstructionsRepository $mount_instructions_repository, ?ilHtmlPurifierInterface $a_document_purifier, ilObjUser $a_actor, FileSystem $a_tmp_filesystem, FileUpload $a_fileupload, string $a_form_action, string $a_save_command, string $a_cancel_command, bool $a_is_editable)
	ilWebDAVMountInstructionsDocumentFormGUI constructor. More...

	saveObject ()
	Save uploaded mount instructions document. More...

	updateObject ()
	Update the document with id from form. More...

	hasTranslatedInfo ()

	hasTranslatedError ()

	getTranslatedInfo ()

	getTranslatedError ()

Public Member Functions inherited from ilPropertyFormGUI
	__construct ()
	Constructor. More...

	executeCommand ()
	Execute command. More...

	setTableWidth ($a_width)
	Set table width. More...

	getTableWidth ()
	get table width More...

	setMode ($a_mode)
	Set Mode ('std', 'subform'). More...

	getMode ()
	Get Mode ('std', 'subform'). More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setTitleIcon ($a_titleicon)
	Set TitleIcon. More...

	getTitleIcon ()
	Get TitleIcon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setShowTopButtons ($a_val)
	Get show top buttons. More...

	getShowTopButtons ()
	Set show top buttons. More...

	setForceTopButtons ($a_val)
	Set force top buttons. More...

	getForceTopButtons ()
	Get force top buttons. More...

	addItem ($a_item)
	Add Item (Property, SectionHeader). More...

	removeItemByPostVar ($a_post_var, $a_remove_unused_headers=false)
	Remove Item. More...

	getItemByPostVar ($a_post_var)
	Get Item by POST variable. More...

	setItems ($a_items)
	Set Items. More...

	getItems ()
	Get Items. More...

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

	setDisableStandardMessage ($a_val)
	Set disable standard message. More...

	getDisableStandardMessage ()
	Get disable standard message. More...

	getHideLabels ()
	Get a value indicating whether the labels should be hidden or not. More...

	setHideLabels ($a_value=true)
	Set a value indicating whether the labels should be hidden or not. More...

	setValuesByArray ($a_values, $a_restrict_to_value_keys=false)
	Set form values from an array. More...

	setValuesByPost ()
	Set form values from POST values. More...

	checkInput ()
	Check Post Input. More...

	getInput ($a_post_var, $ensureValidation=true)
	Returns the value of a HTTP-POST variable, identified by the passed id. More...

	addCustomProperty ( $a_title, $a_html, $a_info="", $a_alert="", $a_required=false)
	Add a custom property. More...

	addCommandButton ($a_cmd, $a_text, $a_id="")
	Add Command button. More...

	getCommandButtons ()
	Return all Command buttons. More...

	clearCommandButtons ()
	Remove all command buttons. More...

	getContent ()
	Get Content. More...

	insertItem ($item, $a_sub_item=false)

	getHTML ()

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

	hasFileUpload ($a_field, $a_index=null, $a_sub_index=null)
	Was any file uploaded? More...

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

Public Member Functions inherited from ilFormGUI
	setFormAction ($a_formaction)
	Set FormAction. More...

	getFormAction ()
	Get FormAction. More...

	setTarget ($a_target)
	Set Target. More...

	getTarget ()
	Get Target. More...

	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false. More...

	getMultipart ()
	Get Enctype Multipart/Formdata true/false. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setName ($a_name)
	Set Name. More...

	getName ()
	Get Name. More...

	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open. More...

	getKeepOpen ()
	Get Keep Form Tag Open. More...

	setOpenTag ($a_open)
	Enable/Disable Open Form Tag. More...

	getOpenTag ()
	Get Open Form Tag Enabled. More...

	setCloseTag ($a_val)
	Set close tag. More...

	getCloseTag ()
	Get close tag. More...

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

	getHTML ()
	Get HTML. More...

	getContent ()
	Get Content. More...

Protected Member Functions
	initForm ()
	Initializes the property form. More...

	getRawMountInstructionsFromFileUpload (UploadResult $upload_result)
	Gets the content of the uploaded file. More...

Protected Member Functions inherited from ilPropertyFormGUI
	hideRequired ($a_type)

	rebuildUploadedFiles ()
	try to rebuild files More...

Protected Attributes
	$document

	$mount_instructions_repository

	$document_purifier

	$actor

	$file_upload

	$tmp_filesystem

	$form_action

	$save_command

	$cancel_command

	$is_editable = false

	$translated_error

	$translated_info

Protected Attributes inherited from ilPropertyFormGUI
	$lng

	$ctrl

	$tpl

	$user

	$settings

	$mode = "std"

	$check_input_called = false

	$disable_standard_message = false

	$top_anchor = "il_form_top"

	$titleicon = false

	$description = ""

	$tbl_width = false

	$show_top_buttons = true

	$hide_labels = false

	$force_top_buttons = false

Protected Attributes inherited from ilFormGUI
	$formaction

	$multipart = false

	$keepopen = false

	$opentag = true

	$id

	$name

	$prevent_double_submission = false

Detailed Description

Definition at line 9 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebDAVMountInstructionsDocumentFormGUI::__construct	(	ilWebDAVMountInstructionsDocument	$a_document,
		ilWebDAVMountInstructionsRepository	$mount_instructions_repository,
		?ilHtmlPurifierInterface	$a_document_purifier,
		ilObjUser	$a_actor,
		FileSystem	$a_tmp_filesystem,
		FileUpload	$a_fileupload,
		string	$a_form_action,
		string	$a_save_command,
		string	$a_cancel_command,
		bool	$a_is_editable
	)

ilWebDAVMountInstructionsDocumentFormGUI constructor.

Parameters

ilWebDAVMountInstructionsDocument	$a_document
ilWebDAVMountInstructionsRepository	$mount_instructions_repository
ilHtmlPurifierInterface \| null	$a_document_purifier
ilObjUser	$a_actor
Filesystem	$a_tmp_filesystem
FileUpload	$a_fileupload
string	$a_form_action
string	$a_save_command
string	$a_cancel_command
bool	$a_is_editable

Definition at line 60 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

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

       {
         $this->document = $a_document;
         $this->mount_instructions_repository = $mount_instructions_repository;
         $this->document_purifier = $a_document_purifier;
         $this->actor = $a_actor;
         $this->tmp_filesystem = $a_tmp_filesystem;
         $this->file_upload = $a_fileupload;
         $this->form_action = $a_form_action;
         $this->save_command = $a_save_command;
         $this->cancel_command = $a_cancel_command;
         $this->is_editable = $a_is_editable;
 
         parent::__construct();
 
         $this->initForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getRawMountInstructionsFromFileUpload()

ilWebDAVMountInstructionsDocumentFormGUI::getRawMountInstructionsFromFileUpload ( UploadResult $upload_result )

protected

Gets the content of the uploaded file.

Parameters

UploadResult $upload_result

Returns: string

Exceptions

Definition at line 308 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

References ilPropertyFormGUI\getItemByPostVar(), ILIAS\FileUpload\DTO\UploadResult\getName(), and ILIAS\FileUpload\DTO\UploadResult\getStatus().

Referenced by getTranslatedError().

                                                                                           : string
     {
         //  Check uploaded name
         if ($upload_result->getName() === '') {
             throw new InvalidArgumentException('uploaded file has no name');
         }
 
         // Check status
         if ($upload_result->getStatus()->getCode() != ProcessingStatus::OK) {
             $this->getItemByPostVar('document')->setAlert($upload_result->getStatus()->getMessage());
             throw new InvalidArgumentException($this->lng->txt('form_input_not_valid'));
         }
 
         // Move uploaded file to a temporary directory to read it
         $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'));
         }
 
         // Get conetent of file
         $raw_content = $content = $this->tmp_filesystem->read($path_to_file);
 
         // Delete temporary file
         $this->tmp_filesystem->delete($path_to_file);
 
         return $raw_content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTranslatedError()

ilWebDAVMountInstructionsDocumentFormGUI::getTranslatedError ( )

Returns: string

Definition at line 216 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

References $document, ilFormGUI\$id, $translated_error, ilPropertyFormGUI\checkInput(), ilWebDAVMountInstructionsDocument\getCreationTs(), ilWebDAVMountInstructionsDocument\getId(), ilPropertyFormGUI\getInput(), ilWebDAVMountInstructionsDocument\getLanguage(), ilWebDAVMountInstructionsDocument\getOwnerUsrId(), getRawMountInstructionsFromFileUpload(), ilWebDAVMountInstructionsDocument\getSorting(), and ilUtil\now().

     {
         return $this->translated_error;
     }

Here is the call graph for this function:

◆ getTranslatedInfo()

ilWebDAVMountInstructionsDocumentFormGUI::getTranslatedInfo ( )

Returns: string

Definition at line 208 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

References $translated_info.

     {
         return $this->translated_info;
     }

◆ hasTranslatedError()

ilWebDAVMountInstructionsDocumentFormGUI::hasTranslatedError ( )

Returns: bool

Definition at line 200 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

     {
         return strlen($this->translated_error) > 0;
     }

◆ hasTranslatedInfo()

ilWebDAVMountInstructionsDocumentFormGUI::hasTranslatedInfo ( )

Returns: bool

Definition at line 192 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

     {
         return strlen($this->translated_info) > 0;
     }

◆ initForm()

ilWebDAVMountInstructionsDocumentFormGUI::initForm ( )

protected

Initializes the property form.

Definition at line 91 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

References ilPropertyFormGUI\$lng, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by __construct().

                                   : 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);
 
         if ($document_already_exists) {
             $document_label = $this->lng->txt('webdav_form_document');
             $document_by_line = $this->lng->txt('webdav_form_document_info');
         } else {
             $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((string) ($this->document->getLanguage() ?? ''));
 
         $this->addItem($language_selection);
 
         if ($document_already_exists) {
             $webdav_id = new ilHiddenInputGUI('webdav_id');
             $webdav_id->setValue($this->document->getId());
             $this->addItem($webdav_id);
         } else {
             $document_upload = new ilFileInputGUI($document_label, 'document');
             $document_upload->setInfo($document_by_line);
             $document_upload->setRequired($document_already_exists ? false : 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'));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveObject()

ilWebDAVMountInstructionsDocumentFormGUI::saveObject ( )

Save uploaded mount instructions document.

Returns: bool

Definition at line 158 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

References Vendor\Package\$e, and ilPropertyFormGUI\setValuesByPost().

     {
         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;
     }

Here is the call graph for this function:

◆ updateObject()

ilWebDAVMountInstructionsDocumentFormGUI::updateObject ( )

Update the document with id from form.

Definition at line 175 of file class.ilWebDAVMountInstructionsDocumentFormGUI.php.

References Vendor\Package\$e, and ilPropertyFormGUI\setValuesByPost().

     {
         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;
     }