ilWebDAVMountInstructionsUploadGUI Class Reference

Collaboration diagram for ilWebDAVMountInstructionsUploadGUI:

Public Member Functions
	__construct (ilObjFileAccessSettings $file_access_settings, ilGlobalPageTemplate $tpl, ilObjUser $user, ilCtrl $ctrl, ilLanguage $lng, ilRbacSystem $rbacsystem, ilErrorHandling $error, ilLogger $log, ilToolbarGUI $toolbar, GlobalHttpState $http_state, Factory $ui_factory, Renderer $ui_renderer, Filesystems $file_systems, FileUpload $file_upload, ilWebDAVMountInstructionsRepository $mount_instructions_repository)
	executeCommand ()
	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 ()
	getDocumentByServerRequest ()
	deleteDocument ()

Detailed Description

Author

ilWebDAVMountInstructionsUploadGUI: ilObjFileAccessSettingsGui

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

Constructor & Destructor Documentation

__construct()

ilWebDAVMountInstructionsUploadGUI::__construct	(	ilObjFileAccessSettings	$file_access_settings,
		ilGlobalPageTemplate	$tpl,
		ilObjUser	$user,
		ilCtrl	$ctrl,
		ilLanguage	$lng,
		ilRbacSystem	$rbacsystem,
		ilErrorHandling	$error,
		ilLogger	$log,
		ilToolbarGUI	$toolbar,
		GlobalHttpState	$http_state,
		Factory	$ui_factory,
		Renderer	$ui_renderer,
		Filesystems	$file_systems,
		FileUpload	$file_upload,
		ilWebDAVMountInstructionsRepository	$mount_instructions_repository
	)

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

References $lng, $log, $tpl, and user().

      {
        $this->file_access_settings = $file_access_settings;
        $this->tpl = $tpl;
        $this->ctrl = $ctrl;
        $this->lng = $lng;
        $this->rbacsystem = $rbacsystem;
        $this->error = $error;
        $this->user = $user;
        $this->log = $log;
        $this->toolbar = $toolbar;
        $this->http_state = $http_state;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->file_systems = $file_systems;
        $this->file_upload = $file_upload;
        $this->mount_instructions_repository = $mount_instructions_repository;
    }

Here is the call graph for this function:

Member Function Documentation

deleteDocument()

ilWebDAVMountInstructionsUploadGUI::deleteDocument ( )

protected

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

    {
        if (!$this->rbacsystem->checkAccess('delete', $this->file_access_settings->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        } else {
            $webdav_id = $_REQUEST['webdav_id'];
            $this->mount_instructions_repository->deleteMountInstructionsById($webdav_id);
            ilUtil::sendSuccess($this->lng->txt('deleted_successfully'), true);
            $this->ctrl->redirect($this, 'showDocuments');
        }
    }

executeCommand()

ilWebDAVMountInstructionsUploadGUI::executeCommand

(

)

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

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

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

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

getDocumentByServerRequest()

ilWebDAVMountInstructionsUploadGUI::getDocumentByServerRequest ( )

protected

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

    {
        return $this->httpState->request() - getParsedBody()['instructions_id'] ?? [];
    }

getDocumentForm()

ilWebDAVMountInstructionsUploadGUI::getDocumentForm ( ilWebDAVMountInstructionsDocument  $a_document )

protected

Parameters

ilWebDAVMountInstructionsDocument

$a_document

Returns

ilWebDAVMountInstructionsDocumentFormGUI

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

References ilWebDAVMountInstructionsDocument\getId(), and user().

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

    {
        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->file_access_settings->getRefId())
        );

        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 155 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References getDocumentForm(), ilUtil\sendFailure(), and ilUtil\sendInfo().

    {
        if (!$this->rbacsystem->checkAccess('write', $this->file_access_settings->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
        
        $form = $this->getDocumentForm(new ilWebDAVMountInstructionsDocument());
        if ($form->saveObject()) {
            ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
            if ($form->hasTranslatedInfo()) {
                ilUtil::sendInfo($form->getTranslatedInfo(), true);
            }
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            ilUtil::sendFailure($form->getTranslatedError(), true);
        }

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

Here is the call graph for this function:

saveDocumentSorting()

ilWebDAVMountInstructionsUploadGUI::saveDocumentSorting

(

)

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

References showDocuments().

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

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

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

        $position = 0;
        foreach ($sorting as $document_id => $ignored_sort_value) {

            // Only accept numbers
            if (!is_numeric($document_id)) {
                continue;
            }

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

        ilUtil::sendSuccess($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 179 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References getDocumentForm(), ilUtil\sendFailure(), and ilUtil\sendInfo().

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

        $form = $this->getDocumentForm(new ilWebDAVMountInstructionsDocument((int) $_REQUEST['webdav_id']));
        if ($form->updateObject()) {
            ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
            if ($form->hasTranslatedInfo()) {
                ilUtil::sendInfo($form->getTranslatedInfo(), true);
            }
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            ilUtil::sendFailure($form->getTranslatedError(), true);
        }
            
        $html = $form->getHTML();
        $this->tpl->setContent($html);
    }

Here is the call graph for this function:

showAddDocumentForm()

ilWebDAVMountInstructionsUploadGUI::showAddDocumentForm ( )

protected

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

References getDocumentForm().

    {
        if (!$this->rbacsystem->checkAccess('write', $this->file_access_settings->getRefId())) {
            $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 72 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References ilLinkButton\getInstance().

Referenced by saveDocumentSorting().

                                       : void
    {
        if ($this->rbacsystem->checkAccess('write', $this->file_access_settings->getRefId())) {
            $addDocumentBtn = ilLinkButton::getInstance();
            $addDocumentBtn->setPrimary(true);
            $addDocumentBtn->setUrl($this->ctrl->getLinkTarget($this, 'showAddDocumentForm'));
            $addDocumentBtn->setCaption('webdav_add_instructions_btn_label');
            $this->toolbar->addStickyItem($addDocumentBtn);
        }

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

        $document_tbl_gui = new ilWebDAVMountInstructionsDocumentTableGUI(
            $this,
            $uri_builder,
            'showDocuments',
            $this->ui_factory,
            $this->ui_renderer,
            $this->rbacsystem->checkAccess('write', $this->file_access_settings->getRefId())
        );
        $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 140 of file class.ilWebDAVMountInstructionsUploadGUI.php.

References getDocumentForm().

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

        $document_id = $_REQUEST['webdav_id'];
        $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

ACTION_SAVE_ADD_DOCUMENT_FORM

const ilWebDAVMountInstructionsUploadGUI::ACTION_SAVE_ADD_DOCUMENT_FORM = 'saveAddDocumentForm'

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

ACTION_SAVE_EDIT_DOCUMENT_FORM

const ilWebDAVMountInstructionsUploadGUI::ACTION_SAVE_EDIT_DOCUMENT_FORM = 'saveEditDocumentForm'

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

---

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

• Services/WebDAV/classes/mount_instructions/class.ilWebDAVMountInstructionsUploadGUI.php