@ilCtrl_isCalledBy ILIAS\WebDAV\Mount\UploadGUI: ilObjWebDAVGUI More...

Collaboration diagram for ILIAS\WebDAV\Mount\UploadGUI:

Public Member Functions
	__construct (private ilGlobalTemplateInterface $tpl, private ilObjUser $user, private ilCtrlInterface $ctrl, private ilLanguage $lng, private ilRbacSystem $rbacsystem, private ilErrorHandling $error, private ilToolbarGUI $toolbar, private Services $http, private RefineryFactory $refinery, UIServices $ui, private Filesystems $file_systems, private FileUpload $file_upload, private Repository $mount_instructions_repository)

	executeCommand ()

	setRefId (int $ref_id)

	saveDocumentSorting ()

Data Fields
const string	ACTION_SAVE_ADD_DOCUMENT_FORM = 'saveAddDocumentForm'

const string	ACTION_SAVE_EDIT_DOCUMENT_FORM = 'saveEditDocumentForm'

Protected Member Functions
	showDocuments ()

	getDocumentForm (Document $a_document)

	showAddDocumentForm ()

	showEditDocumentForm ()

	saveAddDocumentForm ()

	saveEditDocumentForm ()

	deleteDocument ()

Private Attributes
const string	P_DOCUMENT_ID = 'document_id'

UIFactory	$ui_factory

Renderer	$ui_renderer

int	$webdav_object_ref_id

Detailed Description

@ilCtrl_isCalledBy ILIAS\WebDAV\Mount\UploadGUI: ilObjWebDAVGUI

Definition at line 42 of file UploadGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\WebDAV\Mount\UploadGUI::__construct	(	private ilGlobalTemplateInterface	$tpl,
		private ilObjUser	$user,
		private ilCtrlInterface	$ctrl,
		private ilLanguage	$lng,
		private ilRbacSystem	$rbacsystem,
		private ilErrorHandling	$error,
		private ilToolbarGUI	$toolbar,
		private Services	$http,
		private RefineryFactory	$refinery,
		UIServices	$ui,
		private Filesystems	$file_systems,
		private FileUpload	$file_upload,
		private Repository	$mount_instructions_repository
	)

Definition at line 52 of file UploadGUI.php.

      {
        $this->ui_factory = $ui->factory();
        $this->ui_renderer = $ui->renderer();
 
        $this->lng->loadLanguageModule('meta');
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ deleteDocument()

ILIAS\WebDAV\Mount\UploadGUI::deleteDocument ( )

protected

Definition at line 217 of file UploadGUI.php.

                                       : 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(self::P_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');
    }

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

Here is the call graph for this function:

◆ executeCommand()

ILIAS\WebDAV\Mount\UploadGUI::executeCommand ( )

Definition at line 73 of file UploadGUI.php.

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

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

Here is the call graph for this function:

◆ getDocumentForm()

ILIAS\WebDAV\Mount\UploadGUI::getDocumentForm ( Document $a_document )

protected

Definition at line 124 of file UploadGUI.php.

                                                            : DocumentFormGUI
    {
        if ($a_document->getId() > 0) {
            $this->ctrl->setParameter($this, self::P_DOCUMENT_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;
        }
 
        return new DocumentFormGUI(
            $a_document,
            $this->mount_instructions_repository,
            new DocumentPurifier(),
            $this->user,
            $this->file_systems->temp(),
            $this->file_upload,
            $form_action,
            $save_command,
            'showDocuments',
            $this->rbacsystem->checkAccess('write', $this->webdav_object_ref_id)
        );
    }

References ILIAS\WebDAV\Mount\UploadGUI\ACTION_SAVE_ADD_DOCUMENT_FORM, ILIAS\WebDAV\Mount\UploadGUI\ACTION_SAVE_EDIT_DOCUMENT_FORM, ILIAS\Repository\ctrl(), ILIAS\WebDAV\Mount\Document\getId(), and ILIAS\Repository\user().

Referenced by ILIAS\WebDAV\Mount\UploadGUI\saveAddDocumentForm(), ILIAS\WebDAV\Mount\UploadGUI\saveEditDocumentForm(), ILIAS\WebDAV\Mount\UploadGUI\showAddDocumentForm(), and ILIAS\WebDAV\Mount\UploadGUI\showEditDocumentForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAddDocumentForm()

ILIAS\WebDAV\Mount\UploadGUI::saveAddDocumentForm ( )

protected

Definition at line 172 of file UploadGUI.php.

                                            : 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 Document());
        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);
    }

References ILIAS\Repository\ctrl(), error(), ILIAS\WebDAV\Mount\UploadGUI\getDocumentForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ saveDocumentSorting()

ILIAS\WebDAV\Mount\UploadGUI::saveDocumentSorting ( )

Definition at line 230 of file UploadGUI.php.

                                         : 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;
        }
 
        asort($sorting, SORT_NUMERIC);
 
        $position = 0;
        foreach (array_keys($sorting) as $document_id) {
            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);
    }

References ILIAS\Repository\ctrl(), error(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\WebDAV\Mount\UploadGUI\showDocuments().

Here is the call graph for this function:

◆ saveEditDocumentForm()

ILIAS\WebDAV\Mount\UploadGUI::saveEditDocumentForm ( )

protected

Definition at line 193 of file UploadGUI.php.

                                             : 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(self::P_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);
    }

References ILIAS\Repository\ctrl(), error(), ILIAS\WebDAV\Mount\UploadGUI\getDocumentForm(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ setRefId()

ILIAS\WebDAV\Mount\UploadGUI::setRefId ( int $ref_id )

Definition at line 90 of file UploadGUI.php.

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

References $ref_id.

◆ showAddDocumentForm()

ILIAS\WebDAV\Mount\UploadGUI::showAddDocumentForm ( )

protected

Definition at line 150 of file UploadGUI.php.

                                            : 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 Document());
        $this->tpl->setContent($form->getHTML());
    }

References error(), ILIAS\WebDAV\Mount\UploadGUI\getDocumentForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ showDocuments()

ILIAS\WebDAV\Mount\UploadGUI::showDocuments ( )

protected

Definition at line 95 of file UploadGUI.php.

                                      : 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 UriBuilder($this->http->request(), new Config());
 
        $document_tbl_gui = new DocumentTableGUI(
            $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 TableDataProvider($this->mount_instructions_repository)
        );
        $document_tbl_gui->populate();
 
        $this->tpl->setContent($document_tbl_gui->getHTML());
    }

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

Referenced by ILIAS\WebDAV\Mount\UploadGUI\saveDocumentSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showEditDocumentForm()

ILIAS\WebDAV\Mount\UploadGUI::showEditDocumentForm ( )

protected

Definition at line 160 of file UploadGUI.php.

                                             : 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(self::P_DOCUMENT_ID, $this->refinery->kindlyTo()->int());
        $document = $this->mount_instructions_repository->getMountInstructionsDocumentById($document_id);
        $form = $this->getDocumentForm($document);
        $this->tpl->setContent($form->getHTML());
    }

References error(), ILIAS\WebDAV\Mount\UploadGUI\getDocumentForm(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Field Documentation

◆ $ui_factory

UIFactory ILIAS\WebDAV\Mount\UploadGUI::$ui_factory

private

Definition at line 48 of file UploadGUI.php.

◆ $ui_renderer

Renderer ILIAS\WebDAV\Mount\UploadGUI::$ui_renderer

private

Definition at line 49 of file UploadGUI.php.

◆ $webdav_object_ref_id

int ILIAS\WebDAV\Mount\UploadGUI::$webdav_object_ref_id

private

Definition at line 50 of file UploadGUI.php.

◆ ACTION_SAVE_ADD_DOCUMENT_FORM

const string ILIAS\WebDAV\Mount\UploadGUI::ACTION_SAVE_ADD_DOCUMENT_FORM = 'saveAddDocumentForm'

Definition at line 44 of file UploadGUI.php.

Referenced by ILIAS\WebDAV\Mount\UploadGUI\getDocumentForm().

◆ ACTION_SAVE_EDIT_DOCUMENT_FORM

const string ILIAS\WebDAV\Mount\UploadGUI::ACTION_SAVE_EDIT_DOCUMENT_FORM = 'saveEditDocumentForm'

Definition at line 45 of file UploadGUI.php.

Referenced by ILIAS\WebDAV\Mount\UploadGUI\getDocumentForm().

◆ P_DOCUMENT_ID

const string ILIAS\WebDAV\Mount\UploadGUI::P_DOCUMENT_ID = 'document_id'

private

Definition at line 46 of file UploadGUI.php.

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

components/ILIAS/WebDAV/src/Mount/UploadGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteDocument()

◆ executeCommand()

◆ getDocumentForm()

◆ saveAddDocumentForm()

◆ saveDocumentSorting()

◆ saveEditDocumentForm()

◆ setRefId()

◆ showAddDocumentForm()

◆ showDocuments()

◆ showEditDocumentForm()

Field Documentation

◆ $ui_factory

◆ $ui_renderer

◆ $webdav_object_ref_id

◆ ACTION_SAVE_ADD_DOCUMENT_FORM

◆ ACTION_SAVE_EDIT_DOCUMENT_FORM

◆ P_DOCUMENT_ID