ilWebDAVMountInstructionsUploadGUI Class Reference

Collaboration diagram for ilWebDAVMountInstructionsUploadGUI:

Public Member Functions
	__construct (private ilGlobalTemplateInterface $tpl, private ilObjUser $user, private ilCtrlInterface $ctrl, private ilLanguage $lng, private ilRbacSystem $rbacsystem, private ilErrorHandling $error, private ilLogger $log, private ilToolbarGUI $toolbar, private Services $http, private RefineryFactory $refinery, UIServices $ui, private Filesystems $file_systems, private FileUpload $file_upload, private ilWebDAVMountInstructionsRepository $mount_instructions_repository)
	executeCommand ()
	setRefId (int $ref_id)
	saveDocumentSorting ()

Data Fields
const	ACTION_SAVE_ADD_DOCUMENT_FORM = 'saveAddDocumentForm'
const	ACTION_SAVE_EDIT_DOCUMENT_FORM = 'saveEditDocumentForm'

Protected Member Functions
	showDocuments ()
	getDocumentForm (ilWebDAVMountInstructionsDocument $a_document)
	showAddDocumentForm ()
	showEditDocumentForm ()
	saveAddDocumentForm ()
	saveEditDocumentForm ()
	deleteDocument ()

Private Attributes
UIFactory	$ui_factory
Renderer	$ui_renderer
int	$webdav_object_ref_id

Detailed Description

Author

ilWebDAVMountInstructionsUploadGUI: ilObjWebDAVGUI

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

Constructor & Destructor Documentation

__construct()

ilWebDAVMountInstructionsUploadGUI::__construct	(	private ilGlobalTemplateInterface	$tpl,
		private ilObjUser	$user,
		private ilCtrlInterface	$ctrl,
		private ilLanguage	$lng,
		private ilRbacSystem	$rbacsystem,
		private ilErrorHandling	$error,
		private ilLogger	$log,
		private ilToolbarGUI	$toolbar,
		private Services	$http,
		private RefineryFactory	$refinery,
		UIServices	$ui,
		private Filesystems	$file_systems,
		private FileUpload	$file_upload,
		private ilWebDAVMountInstructionsRepository	$mount_instructions_repository
	)

Definition at line 41 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References ILIAS\DI\UIServices\factory(), ILIAS\Repository\lng(), and ILIAS\DI\UIServices\renderer().

      {
        $this->ui_factory = $ui->factory();
        $this->ui_renderer = $ui->renderer();

        $this->lng->loadLanguageModule('meta');
    }

Here is the call graph for this function:

Member Function Documentation

deleteDocument()

ilWebDAVMountInstructionsUploadGUI::deleteDocument ( )

protected

Definition at line 222 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                       : void
    {
        if (!$this->rbacsystem->checkAccess('delete', $this->webdav_object_ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $document_id = $this->http->wrapper()->query()->retrieve('document_id', $this->refinery->kindlyTo()->int());

        $this->mount_instructions_repository->deleteMountInstructionsById($document_id);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('deleted_successfully'), true);
        $this->ctrl->redirect($this, 'showDocuments');
    }

Here is the call graph for this function:

executeCommand()

ilWebDAVMountInstructionsUploadGUI::executeCommand

(

)

Definition at line 66 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();

        if (!$this->rbacsystem->checkAccess('read', $this->webdav_object_ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        if ($cmd == 'delete') {
            $cmd .= 'Document';
        }
        if ($cmd == '' || !method_exists($this, $cmd)) {
            $cmd = 'showDocuments';
        }
        $this->$cmd();
    }

Here is the call graph for this function:

getDocumentForm()

ilWebDAVMountInstructionsUploadGUI::getDocumentForm ( ilWebDAVMountInstructionsDocument  $a_document )

protected

Definition at line 120 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References ILIAS\Repository\ctrl(), ilWebDAVMountInstructionsDocument\getId(), and ILIAS\Repository\user().

Referenced by saveAddDocumentForm(), saveEditDocumentForm(), showAddDocumentForm(), and showEditDocumentForm().

     : ilWebDAVMountInstructionsDocumentFormGUI {
        if ($a_document->getId() > 0) {
            $this->ctrl->setParameter($this, 'doc_id', $a_document->getId());

            $form_action = $this->ctrl->getFormAction($this, self::ACTION_SAVE_EDIT_DOCUMENT_FORM);
            $save_command = self::ACTION_SAVE_EDIT_DOCUMENT_FORM;
        } else {
            $form_action = $this->ctrl->getFormAction($this, self::ACTION_SAVE_ADD_DOCUMENT_FORM);
            $save_command = self::ACTION_SAVE_ADD_DOCUMENT_FORM;
        }

        $form = new ilWebDAVMountInstructionsDocumentFormGUI(
            $a_document,
            $this->mount_instructions_repository,
            new ilWebDAVMountInstructionsDocumentPurifier(),
            $this->user,
            $this->file_systems->temp(),
            $this->file_upload,
            $form_action,
            $save_command,
            'showDocuments',
            $this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)
        );

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAddDocumentForm()

ilWebDAVMountInstructionsUploadGUI::saveAddDocumentForm ( )

protected

Definition at line 174 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References ILIAS\Repository\ctrl(), getDocumentForm(), and ILIAS\Repository\lng().

                                            : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $form = $this->getDocumentForm(new ilWebDAVMountInstructionsDocument());
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            if ($form->hasTranslatedInfo()) {
                $this->tpl->setOnScreenMessage('info', $form->getTranslatedInfo(), true);
            }
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            $this->tpl->setOnScreenMessage('failure', $form->getTranslatedError(), true);
        }

        $html = $form->getHTML();
        $this->tpl->setContent($html);
    }

Here is the call graph for this function:

saveDocumentSorting()

ilWebDAVMountInstructionsUploadGUI::saveDocumentSorting

(

)

Definition at line 235 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and showDocuments().

                                         : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $sorting = $this->http->request()->getParsedBody()['sorting'] ?? [];
        if (!is_array($sorting) || [] === $sorting) {
            $this->showDocuments();
            return;
        }

        // Sort array by give sort value
        asort($sorting, SORT_NUMERIC);

        $position = 0;
        foreach (array_keys($sorting) as $document_id) {
            // Only accept numbers
            if (!is_numeric($document_id)) {
                continue;
            }

            $this->mount_instructions_repository->updateSortingValueById((int) $document_id, ++$position);
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('webdav_saved_sorting'), true);
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

saveEditDocumentForm()

ilWebDAVMountInstructionsUploadGUI::saveEditDocumentForm ( )

protected

Definition at line 198 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References ILIAS\Repository\ctrl(), getDocumentForm(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                             : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $document_id = $this->http->wrapper()->query()->retrieve('document_id', $this->refinery->kindlyTo()->int());
        $form = $this->getDocumentForm(
            $this->mount_instructions_repository->getMountInstructionsDocumentById($document_id)
        );
        if ($form->updateObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            if ($form->hasTranslatedInfo()) {
                $this->tpl->setOnScreenMessage('info', $form->getTranslatedInfo(), true);
            }
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            $this->tpl->setOnScreenMessage('failure', $form->getTranslatedError(), true);
        }

        $html = $form->getHTML();
        $this->tpl->setContent($html);
    }

Here is the call graph for this function:

setRefId()

ilWebDAVMountInstructionsUploadGUI::setRefId

(

int

$ref_id

)

Definition at line 83 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References $ref_id.

                                         : void
    {
        $this->webdav_object_ref_id = $ref_id;
    }

showAddDocumentForm()

ilWebDAVMountInstructionsUploadGUI::showAddDocumentForm ( )

protected

Definition at line 149 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References getDocumentForm(), and ILIAS\Repository\lng().

                                            : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $form = $this->getDocumentForm(new ilWebDAVMountInstructionsDocument());
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

showDocuments()

ilWebDAVMountInstructionsUploadGUI::showDocuments ( )

protected

Exceptions

ilTemplateException

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

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by saveDocumentSorting().

                                      : void
    {
        if ($this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)) {
            $document_button = $this->ui_factory->link()->standard(
                $this->lng->txt('webdav_add_instructions_btn_label'),
                $this->ctrl->getLinkTarget($this, 'showAddDocumentForm')
            );
            $this->toolbar->addStickyItem($document_button);
        }

        $uri_builder = new ilWebDAVUriBuilder($this->http->request());

        $document_tbl_gui = new ilWebDAVMountInstructionsDocumentTableGUI(
            $this,
            $uri_builder,
            'showDocuments',
            $this->ui_factory,
            $this->ui_renderer,
            $this->http->request(),
            $this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)
        );
        $document_tbl_gui->setProvider(
            new ilWebDAVMountInstructionsTableDataProvider($this->mount_instructions_repository)
        );
        $document_tbl_gui->populate();

        $this->tpl->setContent($document_tbl_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showEditDocumentForm()

ilWebDAVMountInstructionsUploadGUI::showEditDocumentForm ( )

protected

Definition at line 159 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References getDocumentForm(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                             : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $document_id = $this->http->wrapper()->query()->retrieve('document_id', $this->refinery->kindlyTo()->int());
        $document = $this->mount_instructions_repository->getMountInstructionsDocumentById($document_id);
        $form = $this->getDocumentForm($document);
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$ui_factory

UIFactory ilWebDAVMountInstructionsUploadGUI::$ui_factory

private

Definition at line 37 of file class.ilWebDAVMountInstructionsUploadGUI.php.

$ui_renderer

Renderer ilWebDAVMountInstructionsUploadGUI::$ui_renderer

private

Definition at line 38 of file class.ilWebDAVMountInstructionsUploadGUI.php.

$webdav_object_ref_id

int ilWebDAVMountInstructionsUploadGUI::$webdav_object_ref_id

private

Definition at line 39 of file class.ilWebDAVMountInstructionsUploadGUI.php.

ACTION_SAVE_ADD_DOCUMENT_FORM

const ilWebDAVMountInstructionsUploadGUI::ACTION_SAVE_ADD_DOCUMENT_FORM = 'saveAddDocumentForm'

Definition at line 35 of file class.ilWebDAVMountInstructionsUploadGUI.php.

ACTION_SAVE_EDIT_DOCUMENT_FORM

const ilWebDAVMountInstructionsUploadGUI::ACTION_SAVE_EDIT_DOCUMENT_FORM = 'saveEditDocumentForm'

Definition at line 36 of file class.ilWebDAVMountInstructionsUploadGUI.php.

---

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

• components/ILIAS/WebDAV/classes/mount_instructions/class.ilWebDAVMountInstructionsUploadGUI.php