ilWebDAVMountInstructionsGUI Class Reference

Collaboration diagram for ilWebDAVMountInstructionsGUI:

Public Member Functions
	__construct (protected ilWebDAVBaseMountInstructions $mount_instruction, protected ilLanguage $lang, protected UIServices $ui, Services $http)
	buildGUIFromGivenMountInstructions (array $mount_instructions, bool $render_async=false)
	renderMountInstructionsContent ()

Protected Attributes
ilWebDAVUriBuilder	$uri_builder
Services	$http

Private Member Functions
	determineOSfromUserAgent ()

Detailed Description

Author

Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch $Id$

Definition at line 28 of file class.ilWebDAVMountInstructionsGUI.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVMountInstructionsGUI::__construct	(	protected ilWebDAVBaseMountInstructions	$mount_instruction,
		protected ilLanguage	$lang,
		protected UIServices	$ui,
		Services	$http
	)

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

References $http, ILIAS\FileDelivery\http(), and ILIAS\HTTP\Services\request().

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

Here is the call graph for this function:

Member Function Documentation

buildGUIFromGivenMountInstructions()

ilWebDAVMountInstructionsGUI::buildGUIFromGivenMountInstructions	(	array	$mount_instructions,
		bool	$render_async = false
	)

Parameters

mixed[]

$mount_instructions

Definition at line 46 of file class.ilWebDAVMountInstructionsGUI.php.

References Vendor\Package\$f, $r, determineOSfromUserAgent(), and ILIAS\Repository\ui().

Referenced by renderMountInstructionsContent().

                                                                                                             : string
    {
        $os = $this->determineOSfromUserAgent();

        $f = $this->ui->factory();
        $r = $this->ui->renderer();

        $components = [];

        $js_function_legacy = $f->legacy(
            '<script>'
            . 'il.UI.showMountInstructions = function (e, id){'
            . "obj = $(e['target']);"
            . "obj.siblings().removeClass('engaged disabled ilSubmitInactive').attr('aria-pressed', 'false');"
            . "obj.siblings().removeAttr('disabled');"
            . "obj.addClass('engaged ilSubmitInactive').attr('aria-pressed', 'true');"
            . '$(".instructions").hide();'
            . '$("#"+id).show();}</script>'
        );

        if (count($mount_instructions) === 1) {
            $content = $f->legacy("<div class='instructions'>" . array_shift($mount_instructions) . "</div>");

            return $render_async ? $r->renderAsync($content) : $r->render($content);
        }

        $view_control_actions = [];

        $selected = array_key_first($mount_instructions);

        foreach ($mount_instructions as $title => $text) {
            foreach ($os as $os_string) {
                if (stristr($title, (string) $os_string) !== false) {
                    $selected = $title;
                    break 2;
                }
            }
        }

        foreach ($mount_instructions as $title => $text) {
            $hidden = $title == $selected ? '' : 'style="display: none;"';

            $legacy = $f->legacy("<div id='$title' class='instructions' $hidden>$text</div>")
                        ->withCustomSignal($title, "il.UI.showMountInstructions(event, '$title');");

            $view_control_actions[$title] = $legacy->getCustomSignal($title);

            $components[] = $legacy;
        }

        $view_control = $f->viewControl()->mode($view_control_actions, "mount-instruction-buttons")->withActive(
            $selected
        );

        // Add view control and legacy add the beginning of the array (so they will be rendered first)
        $header_components = [
            $f->legacy("<div class='webdav-view-control'>"),
            $view_control,
            $f->legacy("</div>"),
            $js_function_legacy
        ];

        $components = array_merge($header_components, $components);

        return $render_async ? $r->renderAsync($components) : $r->render($components);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

determineOSfromUserAgent()

ilWebDAVMountInstructionsGUI::determineOSfromUserAgent ( )

private

Definition at line 138 of file class.ilWebDAVMountInstructionsGUI.php.

References ILIAS\FileDelivery\http().

Referenced by buildGUIFromGivenMountInstructions().

                                               : array
    {
        $ua = $this->http->request()->getHeader('User-Agent')[0];

        if (stristr($ua, 'windows') !== false
            || str_contains($ua, 'microsoft')) {
            return ['win'];
        }

        if (stristr($ua, 'darwin') !== false
            || stristr($ua, 'macintosh') !== false) {
            return ['mac', 'osx'];
        }

        if (stristr($ua, 'linux') !== false
            || stristr($ua, 'solaris') !== false
            || stristr($ua, 'aix') !== false
            || stristr($ua, 'unix') !== false
            || stristr($ua, 'gvfs') !== false // nautilus browser uses this ID
        ) {
            return ['linux'];
        }

        return ['unknown'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderMountInstructionsContent()

ilWebDAVMountInstructionsGUI::renderMountInstructionsContent

(

)

Definition at line 113 of file class.ilWebDAVMountInstructionsGUI.php.

References buildGUIFromGivenMountInstructions(), and exit.

                                                    : void
    {
        try {
            $instructions = $this->mount_instruction->getMountInstructionsAsArray();
        } catch (InvalidArgumentException) {
            $document_processor = new ilWebDAVMountInstructionsHtmlDocumentProcessor(
                new ilWebDAVMountInstructionsDocumentPurifier()
            );
            $instructions = $document_processor->processMountInstructions(
                $this->lang->txt('webfolder_instructions_text')
            );
            $instructions = $this->mount_instruction->getMountInstructionsAsArray($instructions);
            if ($instructions == '' || $instructions == '-webfolder_instructions_text-') {
                $instructions = [
                    "<div class='alert alert-danger'>" . $this->lang->txt(
                        'error'
                    ) . ": " . $this->lang->txt('webdav_missing_lang') . "</div>"
                ];
            }
        }

        echo $this->buildGUIFromGivenMountInstructions($instructions, true);
        exit;
    }

Here is the call graph for this function:

Field Documentation

$http

Services ilWebDAVMountInstructionsGUI::$http

protected

Definition at line 31 of file class.ilWebDAVMountInstructionsGUI.php.

Referenced by __construct().

$uri_builder

ilWebDAVUriBuilder ilWebDAVMountInstructionsGUI::$uri_builder

protected

Definition at line 30 of file class.ilWebDAVMountInstructionsGUI.php.

---

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

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