ILIAS\WebDAV\Mount\InstructionsGUI Class Reference

Collaboration diagram for ILIAS\WebDAV\Mount\InstructionsGUI:

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

Private Member Functions
	determineOSfromUserAgent ()

Detailed Description

Definition at line 28 of file InstructionsGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WebDAV\Mount\InstructionsGUI::__construct	(	protected BaseInstructions	$mount_instruction,
		protected ilLanguage	$lang,
		protected UIServices	$ui,
		protected Services	$http
	)

Definition at line 30 of file InstructionsGUI.php.

      {
    }

Member Function Documentation

buildGUIFromGivenMountInstructions()

ILIAS\WebDAV\Mount\InstructionsGUI::buildGUIFromGivenMountInstructions	(	array	$mount_instructions,
		bool	$render_async = false
	)

Parameters

mixed[]

$mount_instructions

Definition at line 41 of file InstructionsGUI.php.

                                                                                                             : string
    {
        $os = $this->determineOSfromUserAgent();
 
        $f = $this->ui->factory();
        $r = $this->ui->renderer();
 
        $components = [];
 
        $js_function_legacy = $f->legacy()->content(
            '<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()->content("<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 (stripos((string) $title, (string) $os_string) !== false) {
                    $selected = $title;
                    break 2;
                }
            }
        }
 
        foreach ($mount_instructions as $title => $text) {
            $hidden = $title === $selected ? '' : 'style="display: none;"';
 
            $legacy = $f->legacy()->content("<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
        );
 
        $header_components = [
            $f->legacy()->content("<div class='webdav-view-control'>"),
            $view_control,
            $f->legacy()->content('</div>'),
            $js_function_legacy,
        ];
 
        $components = array_merge($header_components, $components);
 
        return $render_async ? $r->renderAsync($components) : $r->render($components);
    }

References $components, Vendor\Package\$f, $text, ILIAS\WebDAV\Mount\InstructionsGUI\determineOSfromUserAgent(), and ILIAS\Repository\ui().

Referenced by ILIAS\WebDAV\Mount\InstructionsGUI\renderMountInstructionsContent().

Here is the call graph for this function:

Here is the caller graph for this function:

determineOSfromUserAgent()

ILIAS\WebDAV\Mount\InstructionsGUI::determineOSfromUserAgent ( )

private

Definition at line 131 of file InstructionsGUI.php.

                                               : array
    {
        $ua = $this->http->request()->getHeader('User-Agent')[0] ?? '';
 
        if (stripos($ua, 'windows') !== false || str_contains($ua, 'microsoft')) {
            return ['win'];
        }
 
        if (stripos($ua, 'darwin') !== false || stripos($ua, 'macintosh') !== false) {
            return ['mac', 'osx'];
        }
 
        if (stripos($ua, 'linux') !== false
            || stripos($ua, 'solaris') !== false
            || stripos($ua, 'aix') !== false
            || stripos($ua, 'unix') !== false
            || stripos($ua, 'gvfs') !== false // nautilus browser uses this ID
        ) {
            return ['linux'];
        }
 
        return ['unknown'];
    }

References ILIAS\FileDelivery\http().

Referenced by ILIAS\WebDAV\Mount\InstructionsGUI\buildGUIFromGivenMountInstructions().

Here is the call graph for this function:

Here is the caller graph for this function:

renderMountInstructionsContent()

ILIAS\WebDAV\Mount\InstructionsGUI::renderMountInstructionsContent

(

)

Definition at line 107 of file InstructionsGUI.php.

                                                    : void
    {
        try {
            $instructions = $this->mount_instruction->getMountInstructionsAsArray();
        } catch (InvalidArgumentException) {
            $document_processor = new HtmlDocumentProcessor(
                new DocumentPurifier()
            );
            $instructions = $document_processor->processMountInstructions(
                $this->lang->txt('webfolder_instructions_text')
            );
            $instructions = $this->mount_instruction->getMountInstructionsAsArray($instructions);
            if ($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;
    }

References ILIAS\WebDAV\Mount\InstructionsGUI\buildGUIFromGivenMountInstructions(), and exit.

Here is the call graph for this function:

---

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

• components/ILIAS/WebDAV/src/Mount/InstructionsGUI.php