ILIAS\components\WOPI\Embed\EmbeddedApplication Class Reference

Collaboration diagram for ILIAS\components\WOPI\Embed\EmbeddedApplication:

Public Member Functions
	getToken ()
	getTTL ()
	getBackTarget ()
	isInline ()
	getActionLauncherURL ()

Protected Member Functions
	getAppendices ()

Private Attributes
const	WOPI_SRC = 'WOPISrc'
const	SUB_THM = 'thm'
const	SUB_DCHAT = 'dchat'
const	SUB_EMBED = 'embed'
int	$ttl = 3600
string	$token
array	$substitutions

Detailed Description

Author

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

Definition at line 34 of file EmbeddedApplication.php.

Member Function Documentation

getActionLauncherURL()

ILIAS\components\WOPI\Embed\EmbeddedApplication::getActionLauncherURL

(

)

Definition at line 98 of file EmbeddedApplication.php.

References $url, ILIAS\components\WOPI\Embed\EmbeddedApplication\getAppendices(), ILIAS\components\WOPI\Handler\RequestHandler\NAMESPACE_FILES, null, and ILIAS\components\WOPI\Handler\RequestHandler\WOPI_BASE_URL.

                                          : ?URI
    {
        if ($this->action === null) {
            return null;
        }

        $appendices = $this->getAppendices();

        $url = rtrim((string) $this->action->getLauncherUrl(), '/?#')
            . '?'
            . self::WOPI_SRC
            . '='
            . urlencode(
                rtrim((string) $this->ilias_base_url, '/')
                . RequestHandler::WOPI_BASE_URL
                . RequestHandler::NAMESPACE_FILES
                . '/'
                . $this->identification->serialize()
            );

        if ($appendices !== []) {
            $url .= '&' . implode('&', $appendices);
        }

        return new URI($url);
    }

Here is the call graph for this function:

getAppendices()

ILIAS\components\WOPI\Embed\EmbeddedApplication::getAppendices ( )

protected

Returns

array|string[]

Definition at line 128 of file EmbeddedApplication.php.

References null.

Referenced by ILIAS\components\WOPI\Embed\EmbeddedApplication\getActionLauncherURL().

                                      : array
    {
        // appendix sanitizer
        $appendix = $this->action->getUrlAppendix();
        $appendices = [];
        try {
            if ($appendix !== null) {
                preg_match_all('/([^<]*)=([^>&]*)/m', $appendix, $appendices, PREG_SET_ORDER, 0);

                $appendices = array_filter($appendices, static fn($appendix): bool => isset($appendix[1], $appendix[2]));

                // we set the wopisrc ourselves
                $appendices = array_filter($appendices, static fn($appendix): bool => strtolower((string) $appendix[1]) !== 'wopisrc');

                // try substitutions
                $appendices = array_map(function ($appendix): array {
                    $key = strtolower((string) $appendix[1]);
                    if (isset($this->substitutions[$key])) {
                        $appendix[2] = (string) $this->substitutions[$key];
                    }
                    return $appendix;
                }, $appendices);

                // we remove all those placeholders
                $appendices = array_filter($appendices, static fn($appendix): bool => $appendix[0] !== $appendix[1] . '=' . $appendix[2]);

                $here = 1;

                $appendices = array_map(static fn($appendix): string => $appendix[1] . '=' . $appendix[2], $appendices);
            }
        } catch (\Throwable $t) {
            return [];
        }

        return $appendices;
    }

Here is the caller graph for this function:

getBackTarget()

ILIAS\components\WOPI\Embed\EmbeddedApplication::getBackTarget

(

)

Definition at line 88 of file EmbeddedApplication.php.

Referenced by ILIAS\components\WOPI\Embed\EmbeddedApplicationGSProvider\buildCloseButton().

                                   : URI
    {
        return $this->back_target;
    }

Here is the caller graph for this function:

getToken()

ILIAS\components\WOPI\Embed\EmbeddedApplication::getToken

(

)

Definition at line 78 of file EmbeddedApplication.php.

References ILIAS\components\WOPI\Embed\EmbeddedApplication\$token.

                              : string
    {
        return $this->token;
    }

getTTL()

ILIAS\components\WOPI\Embed\EmbeddedApplication::getTTL

(

)

Definition at line 83 of file EmbeddedApplication.php.

References ILIAS\components\WOPI\Embed\EmbeddedApplication\$ttl.

                            : int
    {
        return $this->ttl;
    }

isInline()

ILIAS\components\WOPI\Embed\EmbeddedApplication::isInline

(

)

Definition at line 93 of file EmbeddedApplication.php.

                              : bool
    {
        return $this->inline;
    }

Field Documentation

$substitutions

array ILIAS\components\WOPI\Embed\EmbeddedApplication::$substitutions

private

Initial value:

= [
        self::SUB_THM => 1

Definition at line 45 of file EmbeddedApplication.php.

$token

string ILIAS\components\WOPI\Embed\EmbeddedApplication::$token

private

Definition at line 44 of file EmbeddedApplication.php.

Referenced by ILIAS\components\WOPI\Embed\EmbeddedApplication\getToken().

$ttl

int ILIAS\components\WOPI\Embed\EmbeddedApplication::$ttl = 3600

private

Definition at line 43 of file EmbeddedApplication.php.

Referenced by ILIAS\components\WOPI\Embed\EmbeddedApplication\getTTL().

SUB_DCHAT

const ILIAS\components\WOPI\Embed\EmbeddedApplication::SUB_DCHAT = 'dchat'

private

Definition at line 41 of file EmbeddedApplication.php.

SUB_EMBED

const ILIAS\components\WOPI\Embed\EmbeddedApplication::SUB_EMBED = 'embed'

private

Definition at line 42 of file EmbeddedApplication.php.

SUB_THM

const ILIAS\components\WOPI\Embed\EmbeddedApplication::SUB_THM = 'thm'

private

Definition at line 40 of file EmbeddedApplication.php.

WOPI_SRC

const ILIAS\components\WOPI\Embed\EmbeddedApplication::WOPI_SRC = 'WOPISrc'

private

Definition at line 39 of file EmbeddedApplication.php.

---

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

• components/ILIAS/WOPI/classes/Embed/EmbeddedApplication.php