ilWOPISettingsForm Class Reference

Collaboration diagram for ilWOPISettingsForm:

Public Member Functions
	__construct (private Setting $settings,)
	proceed (RequestInterface $request)
	getHTML ()

Private Member Functions
	initForm ()
	getSection ()
	renderLink (string $translation, string $url, bool $new_tab=true)

Private Attributes
Standard	$form
Factory	$ui_factory
Renderer	$ui_renderer
ilCtrlInterface	$ctrl
ilLanguage	$lng
ILIAS Refinery Factory	$refinery

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

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

Constructor & Destructor Documentation

__construct()

ilWOPISettingsForm::__construct

(

private Setting

$settings

)

Definition at line 42 of file class.ilWOPISettingsForm.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), initForm(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

      {
        global $DIC;
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->refinery = $DIC->refinery();

        $this->form = $this->initForm();
    }

Here is the call graph for this function:

Member Function Documentation

getHTML()

ilWOPISettingsForm::getHTML

(

)

Definition at line 168 of file class.ilWOPISettingsForm.php.

References ILIAS\Repository\form().

                             : string
    {
        return $this->ui_renderer->render($this->form);
    }

Here is the call graph for this function:

getSection()

ilWOPISettingsForm::getSection ( )

private

Definition at line 63 of file class.ilWOPISettingsForm.php.

References ILIAS\Repository\int(), ILIAS\Repository\lng(), null, ILIAS\Repository\refinery(), ILIAS\Repository\settings(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by initForm().

                                 : Section
    {
        $wopi_activated = (bool) $this->settings->get("wopi_activated", '0');
        $wopi_discovery_url = $this->settings->get("wopi_discovery_url");
        $saving_interval_value = (int) $this->settings->get("saving_interval", '0');
        $saving_interval_value = $saving_interval_value === 0 ? null : $saving_interval_value;

        $wopi_url = $this->ui_factory->input()->field()->text(
            $this->lng->txt("wopi_url"),
            $this->lng->txt("wopi_url_byline")
            /*. $this->renderLink(
                " ➜︎ Wikipedia",
                "https://en.wikipedia.org/wiki/Web_Application_Open_Platform_Interface",
                true
            )*/
        )->withAdditionalTransformation(
            $this->refinery->custom()->transformation(fn($v) => $v === '' ? null : $v)
        )->withAdditionalTransformation(
            $this->refinery->custom()->constraint(function ($v): bool {
                if ($v === null) {
                    return false;
                }
                return (new Crawler())->validate(new URI($v));
            }, $this->lng->txt('msg_error_wopi_invalid_discorvery_url'))
        )->withAdditionalTransformation(
            $this->refinery->custom()->transformation(function ($v): true {
                $this->settings->set("wopi_discovery_url", $v);

                return true;
            })
        )->withValue(
            $wopi_discovery_url ?? ''
        );

        $saving_interval = $this->ui_factory->input()->field()->optionalGroup(
            [
                $this->ui_factory
                    ->input()
                    ->field()
                    ->numeric(
                        $this->lng->txt("saving_interval"),
                        $this->lng->txt("saving_interval_byline")
                    )
                    ->withAdditionalTransformation(
                        $this->refinery->custom()->transformation(fn($v) => $v === '' ? null : $v)
                    )->withAdditionalTransformation(
                        $this->refinery->custom()->transformation(function ($v): true {
                            if ($v === null || $v === 0) {
                                $this->settings->delete("saving_interval");
                                return true;
                            }

                            $this->settings->set("saving_interval", (string) $v);

                            return true;
                        })
                    )->withValue(
                        $saving_interval_value
                    )
            ],
            $this->lng->txt("activate_saving_interval")
        )->withValue(
            $saving_interval_value === null ? null : [$saving_interval_value]
        )->withAdditionalTransformation(
            $this->refinery->custom()->transformation(function ($v) {
                if ($v === null || $v === [null]) {
                    $this->settings->delete("saving_interval");
                }
                return $v;
            })
        );

        return $this->ui_factory->input()->field()->section(
            [
                $this->ui_factory->input()->field()->optionalGroup(
                    [$wopi_url, $saving_interval],
                    $this->lng->txt("activate_wopi")
                )->withValue(
                    $wopi_discovery_url === null ? null : [
                        $wopi_discovery_url,
                        $saving_interval_value === null ? null : [$saving_interval_value]
                    ]
                )->withAdditionalTransformation(
                    $this->refinery->custom()->transformation(function ($v) {
                        if ($v === null || $v === [null]) {
                            $this->settings->set("wopi_activated", '0');
                            $this->settings->delete("wopi_discovery_url");
                        } else {
                            $this->settings->set("wopi_activated", "1");
                        }
                        return $v;
                    })
                )
            ],
            $this->lng->txt("wopi_settings"),
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilWOPISettingsForm::initForm ( )

private

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

References ilWOPIAdministrationGUI\CMD_STORE, ILIAS\Repository\ctrl(), and getSection().

Referenced by __construct().

                               : Standard
    {
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormActionByClass(ilWOPIAdministrationGUI::class, ilWOPIAdministrationGUI::CMD_STORE),
            $this->getSection()->getInputs()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

proceed()

ilWOPISettingsForm::proceed

(

RequestInterface

$request

)

Definition at line 161 of file class.ilWOPISettingsForm.php.

References ILIAS\Repository\form(), and null.

                                                      : bool
    {
        $this->form = $this->form->withRequest($request);

        return $this->form->getData() !== null;
    }

Here is the call graph for this function:

renderLink()

ilWOPISettingsForm::renderLink ( string  $translation, string  $url, bool  $new_tab = true  )

private

Definition at line 173 of file class.ilWOPISettingsForm.php.

                                                                                       : string
    {
        $link = $this->ui_factory->link()->standard(
            $translation,
            $url
        )->withOpenInNewViewport($new_tab);
        return $this->ui_renderer->render($link);
    }

Field Documentation

$ctrl

ilCtrlInterface ilWOPISettingsForm::$ctrl

private

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

$form

Standard ilWOPISettingsForm::$form

private

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

$lng

ilLanguage ilWOPISettingsForm::$lng

private

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

$refinery

ILIAS Refinery Factory ilWOPISettingsForm::$refinery

private

Definition at line 40 of file class.ilWOPISettingsForm.php.

$ui_factory

Factory ilWOPISettingsForm::$ui_factory

private

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

$ui_renderer

Renderer ilWOPISettingsForm::$ui_renderer

private

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

---

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

• components/ILIAS/WOPI/classes/Administration/class.ilWOPISettingsForm.php