Inheritance diagram for ILIAS\WOPI\Discovery\ActionDBRepository:

Collaboration diagram for ILIAS\WOPI\Discovery\ActionDBRepository:

Public Member Functions
	__construct (private \ilDBInterface $db)

	hasActionForSuffix (string $suffix, ActionTarget ... $action_target)

	hasEditActionForSuffix (string $suffix)

	hasViewActionForSuffix (string $suffix)

	getActionForSuffix (string $suffix, ActionTarget $action_target)

	getEditActionForSuffix (string $suffix)

	getViewActionForSuffix (string $suffix)

	getActions ()

	getActionsForTarget (ActionTarget $action_target)

	getActionsForTargets (ActionTarget ... $action_target)

	getSupportedSuffixes (ActionTarget ... $action_target)

	getCreatableSuffixes (bool $with_templates=false)
	Templates such as dotx are left out unless asked for: the editnew action of a template creates a file with another extension (newext). More...

	getCreatableFormats (bool $with_templates=false)

	getTemplateSuffixes ()

	getActionsForApp (App $app)

	clear ()

	clearSuperfluous (Action ... $actions)

	store (Action $action, App $for_app)

	hasEditActionForSuffix (string $suffix)

	hasViewActionForSuffix (string $suffix)

	hasActionForSuffix (string $suffix, ActionTarget ... $action_target)

	getActionForSuffix (string $suffix, ActionTarget $action_target)

	getEditActionForSuffix (string $suffix)

	getViewActionForSuffix (string $suffix)

	getActions ()

	getActionsForTarget (ActionTarget $action_target)

	getActionsForTargets (ActionTarget ... $action_target)

	getSupportedSuffixes (ActionTarget ... $action_target)

	getCreatableSuffixes (bool $with_templates=false)

	getCreatableFormats (bool $with_templates=false)

	getTemplateSuffixes ()

	clearSuperfluous (Action ... $actions)

	store (Action $action, App $for_app)

	clear ()

Private Member Functions
	implodeTargets (ActionTarget ... $targets)

	getEditNewFormats ()

	fromDBRow (array $row)

Private Attributes
const	TABLE_NAME = 'wopi_action'

array	$edit_actions = [ActionTarget::EDIT, ActionTarget::EMBED_EDIT]

array	$view_actions = [ActionTarget::EMBED_VIEW, ActionTarget::VIEW]
	The order is the preference order of getViewActionForSuffix(). More...

Detailed Description

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

Definition at line 28 of file ActionDBRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\WOPI\Discovery\ActionDBRepository::__construct ( private \ilDBInterface $db )

Definition at line 45 of file ActionDBRepository.php.

47 {

48 }

Member Function Documentation

◆ clear()

ILIAS\WOPI\Discovery\ActionDBRepository::clear ( )

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 270 of file ActionDBRepository.php.

                           : void
    {
        $query = 'DELETE FROM ' . self::TABLE_NAME;
        $this->db->manipulate($query);
    }

◆ clearSuperfluous()

ILIAS\WOPI\Discovery\ActionDBRepository::clearSuperfluous ( Action ... $actions )

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 276 of file ActionDBRepository.php.

                                                        : void
    {
        $collected_ids = array_map(
            static fn(Action $act): int => $act->getId(),
            $actions
        );
        $query = 'DELETE FROM ' . self::TABLE_NAME . ' WHERE ' . $this->db->in('id', $collected_ids, true, 'integer');
        $this->db->manipulate($query);
    }

References ILIAS\WOPI\Discovery\Action\getId().

Here is the call graph for this function:

◆ fromDBRow()

ILIAS\WOPI\Discovery\ActionDBRepository::fromDBRow ( array $row )

private

Definition at line 258 of file ActionDBRepository.php.

                                          : Action
    {
        return new Action(
            (int) $row['id'],
            (string) $row['name'],
            (string) $row['ext'],
            new URI((string) $row['urlsrc']),
            empty($row['url_appendix']) ? null : (string) $row['url_appendix'],
            empty($row['target_ext']) ? null : (string) $row['target_ext']
        );
    }

◆ getActionForSuffix()

ILIAS\WOPI\Discovery\ActionDBRepository::getActionForSuffix	(	string	$suffix,
		ActionTarget	$action_target
	)

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 95 of file ActionDBRepository.php.

     : ?Action {
        if (!$this->hasActionForSuffix($suffix, $action_target)) {
            return null;
        }
 
        $query = 'SELECT * FROM '
            . self::TABLE_NAME
            . ' WHERE ext = %s AND name = %s';
 
        $result = $this->db->queryF($query, ['text', 'text'], [strtolower($suffix), $action_target->value]);
        $row = $this->db->fetchAssoc($result);
        return $this->fromDBRow($row);
    }

◆ getActions()

ILIAS\WOPI\Discovery\ActionDBRepository::getActions ( )

Returns: Action[]

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 134 of file ActionDBRepository.php.

                                : array
    {
        $actions = [];
        $query = 'SELECT * FROM ' . self::TABLE_NAME;
        $result = $this->db->query($query);
        while ($row = $this->db->fetchAssoc($result)) {
            $actions[] = $this->fromDBRow($row);
        }
        return $actions;
    }

◆ getActionsForApp()

ILIAS\WOPI\Discovery\ActionDBRepository::getActionsForApp ( App $app )

Definition at line 247 of file ActionDBRepository.php.

                                              : array
    {
        $actions = [];
        $query = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE app_id = %s';
        $result = $this->db->queryF($query, ['integer'], [$app->getId()]);
        while ($row = $this->db->fetchAssoc($result)) {
            $actions[] = $this->fromDBRow($row);
        }
        return $actions;
    }

References ILIAS\WOPI\Discovery\App\getId().

Here is the call graph for this function:

◆ getActionsForTarget()

ILIAS\WOPI\Discovery\ActionDBRepository::getActionsForTarget ( ActionTarget $action_target )

Returns: Action[]

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 145 of file ActionDBRepository.php.

                                                                    : array
    {
        $query = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE name = %s';
        $result = $this->db->queryF($query, ['text'], [$action_target->value]);
        $actions = [];
        while ($row = $this->db->fetchAssoc($result)) {
            $actions[] = $this->fromDBRow($row);
        }
        return $actions;
    }

◆ getActionsForTargets()

ILIAS\WOPI\Discovery\ActionDBRepository::getActionsForTargets ( ActionTarget ... $action_target )

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 156 of file ActionDBRepository.php.

                                                                        : array
    {
        $actions = [];
        foreach ($action_target as $target) {
            $actions[] = $this->getActionsForTarget($target);
        }
        return array_merge(...$actions);
    }

References ILIAS\Scripts\PHPStan\$target.

◆ getCreatableFormats()

ILIAS\WOPI\Discovery\ActionDBRepository::getCreatableFormats ( bool $with_templates = false )

Returns: array<string, string> suffix => name of the app creating it, sorted by the name

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 190 of file ActionDBRepository.php.

                                                                     : array
    {
        $formats = [];
        foreach ($this->getEditNewFormats() as $suffix => $format) {
            if ($with_templates || !$format['template']) {
                $formats[$suffix] = $format['app'];
            }
        }
        uksort(
            $formats,
            static fn(string $a, string $b): int => strnatcasecmp($formats[$a] . ' ' . $a, $formats[$b] . ' ' . $b)
        );
 
        return $formats;
    }

References Vendor\Package\$a, and Vendor\Package\$b.

◆ getCreatableSuffixes()

ILIAS\WOPI\Discovery\ActionDBRepository::getCreatableSuffixes ( bool $with_templates = false )

Templates such as dotx are left out unless asked for: the editnew action of a template creates a file with another extension (newext).

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 182 of file ActionDBRepository.php.

                                                                      : array
    {
        $suffixes = array_keys($this->getCreatableFormats($with_templates));
        sort($suffixes);
 
        return $suffixes;
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ getEditActionForSuffix()

ILIAS\WOPI\Discovery\ActionDBRepository::getEditActionForSuffix ( string $suffix )

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 112 of file ActionDBRepository.php.

                                                          : ?Action
    {
        foreach ($this->edit_actions as $action_target) {
            $action = $this->getActionForSuffix($suffix, $action_target);
            if ($action !== null) {
                return $action;
            }
        }
        return null;
    }

◆ getEditNewFormats()

ILIAS\WOPI\Discovery\ActionDBRepository::getEditNewFormats ( )

private

Returns: array<string, array{app: string, template: bool}> by lowercased extension; an extension which is offered as a regular format as well is not a template

Definition at line 223 of file ActionDBRepository.php.

                                        : array
    {
        $query = 'SELECT a.ext, a.target_ext, p.name app_name FROM ' . self::TABLE_NAME . ' a'
            . ' LEFT JOIN wopi_app p ON p.id = a.app_id'
            . ' WHERE a.name = %s';
        $result = $this->db->queryF($query, ['text'], [ActionTarget::EDIT_NEW->value]);
 
        $formats = [];
        while ($row = $this->db->fetchAssoc($result)) {
            $suffix = strtolower((string) $row['ext']);
            $target = empty($row['target_ext']) ? null : strtolower((string) $row['target_ext']);
            $template = $target !== null && $target !== $suffix;
            if (isset($formats[$suffix]) && ($template || !$formats[$suffix]['template'])) {
                continue;
            }
            $formats[$suffix] = [
                'app' => (string) ($row['app_name'] ?? ''),
                'template' => $template,
            ];
        }
 
        return $formats;
    }

References ILIAS\Scripts\PHPStan\$target.

◆ getSupportedSuffixes()

ILIAS\WOPI\Discovery\ActionDBRepository::getSupportedSuffixes ( ActionTarget ... $action_target )

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 165 of file ActionDBRepository.php.

                                                                        : array
    {
        $query = 'SELECT ext FROM '
            . self::TABLE_NAME
            . ' WHERE name IN (' . $this->implodeTargets(...$action_target) . ')';
        $result = $this->db->query($query);
        $suffixes = [];
        while ($row = $this->db->fetchAssoc($result)) {
            $suffixes[] = $row['ext'];
        }
        return $suffixes;
    }

◆ getTemplateSuffixes()

ILIAS\WOPI\Discovery\ActionDBRepository::getTemplateSuffixes ( )

Returns: string[] suffixes of templates such as dotx a new document can be created for, sorted

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 206 of file ActionDBRepository.php.

                                         : array
    {
        $suffixes = array_keys(
            array_filter(
                $this->getEditNewFormats(),
                static fn(array $format): bool => $format['template']
            )
        );
        sort($suffixes);
 
        return $suffixes;
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ getViewActionForSuffix()

ILIAS\WOPI\Discovery\ActionDBRepository::getViewActionForSuffix ( string $suffix )

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 123 of file ActionDBRepository.php.

                                                          : ?Action
    {
        foreach ($this->view_actions as $action_target) {
            $action = $this->getActionForSuffix($suffix, $action_target);
            if ($action !== null) {
                return $action;
            }
        }
        return null;
    }

◆ hasActionForSuffix()

ILIAS\WOPI\Discovery\ActionDBRepository::hasActionForSuffix	(	string	$suffix,
		ActionTarget ...	$action_target
	)

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 61 of file ActionDBRepository.php.

     : bool {
        static $cache = [];
 
        $implode_targets = $this->implodeTargets(...$action_target);
 
        if (isset($cache[$suffix][$implode_targets])) {
            return $cache[$suffix][$implode_targets];
        }
 
        $query = 'SELECT * FROM '
            . self::TABLE_NAME
            . ' WHERE ext = %s AND name IN(' . $implode_targets . ')';
 
        $result = $this->db->queryF(
            $query,
            ['text'],
            [strtolower($suffix)]
        );
        return $cache[$suffix][$implode_targets] = $result->numRows() > 0;
    }

◆ hasEditActionForSuffix()

ILIAS\WOPI\Discovery\ActionDBRepository::hasEditActionForSuffix ( string $suffix )

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 85 of file ActionDBRepository.php.

                                                          : bool
    {
        return $this->hasActionForSuffix($suffix, ...$this->edit_actions);
    }

◆ hasViewActionForSuffix()

ILIAS\WOPI\Discovery\ActionDBRepository::hasViewActionForSuffix ( string $suffix )

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 90 of file ActionDBRepository.php.

                                                          : bool
    {
        return $this->hasActionForSuffix($suffix, ...$this->view_actions);
    }

◆ implodeTargets()

ILIAS\WOPI\Discovery\ActionDBRepository::implodeTargets ( ActionTarget ... $targets )

private

Definition at line 50 of file ActionDBRepository.php.

                                                             : string
    {
        return implode(
            ', ',
            array_map(
                fn(ActionTarget $target): string => $this->db->quote($target->value, 'text'),
                $targets
            )
        );
    }

References ILIAS\Scripts\PHPStan\$target.

◆ store()

ILIAS\WOPI\Discovery\ActionDBRepository::store	(	Action	$action,
		App	$for_app
	)

Implements ILIAS\WOPI\Discovery\ActionRepository.

Definition at line 286 of file ActionDBRepository.php.

                                                       : void
    {
        // store only actions with extensions
        if (empty($action->getExtension())) {
            return;
        }
 
        // check for existing action to update them
        // most actions have no target extension, "target_ext = NULL" would never match them
        $query = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE name = %s AND ext = %s';
        $types = ['text', 'text'];
        $values = [$action->getName(), strtolower($action->getExtension())];
        if ($action->getTargetExtension() === null) {
            $query .= ' AND target_ext IS NULL';
        } else {
            $query .= ' AND target_ext = %s';
            $types[] = 'text';
            $values[] = $action->getTargetExtension();
        }
        $result = $this->db->queryF($query, $types, $values);
 
        if ($this->db->numRows($result) > 0) {
            $row = $this->db->fetchAssoc($result);
            $action = $action->withId((int) $row['id']);
        }
 
        if ($this->db->queryF(
            'SELECT * FROM ' . self::TABLE_NAME . ' WHERE id = %s',
            ['integer'],
            [$action->getId()]
        )->numRows() === 0) {
            $next_id = $this->db->nextId(self::TABLE_NAME);
            $this->db->insert(self::TABLE_NAME, [
                'id' => ['integer', $next_id],
                'name' => ['text', $action->getName()],
                'ext' => ['text', strtolower($action->getExtension())],
                'urlsrc' => ['text', $action->getLauncherUrl()],
                'app_id' => ['integer', $for_app->getId()],
                'url_appendix' => ['text', $action->getUrlAppendix()],
                'target_ext' => ['text', $action->getTargetExtension()],
            ]);
            $action = $action->withId($next_id);
        } else {
            $this->db->update(self::TABLE_NAME, [
                'name' => ['text', $action->getName()],
                'ext' => ['text', strtolower($action->getExtension())],
                'urlsrc' => ['text', $action->getLauncherUrl()],
                'app_id' => ['integer', $for_app->getId()],
                'url_appendix' => ['text', $action->getUrlAppendix()],
                'target_ext' => ['text', $action->getTargetExtension()],
            ], [
                'id' => ['integer', $action->getId()],
            ]);
        }
    }

References ILIAS\WOPI\Discovery\Action\getExtension(), ILIAS\WOPI\Discovery\Action\getId(), ILIAS\WOPI\Discovery\App\getId(), ILIAS\WOPI\Discovery\Action\getLauncherUrl(), ILIAS\WOPI\Discovery\Action\getName(), ILIAS\WOPI\Discovery\Action\getTargetExtension(), ILIAS\WOPI\Discovery\Action\getUrlAppendix(), and ILIAS\WOPI\Discovery\Action\withId().

Here is the call graph for this function:

Field Documentation

◆ $edit_actions

array ILIAS\WOPI\Discovery\ActionDBRepository::$edit_actions = [ActionTarget::EDIT, ActionTarget::EMBED_EDIT]

private

Definition at line 34 of file ActionDBRepository.php.

◆ $view_actions

array ILIAS\WOPI\Discovery\ActionDBRepository::$view_actions = [ActionTarget::EMBED_VIEW, ActionTarget::VIEW]

private

The order is the preference order of getViewActionForSuffix().

The embedded viewer comes first on purpose: the content tab of a file object is a viewer and offers no way into edit mode, so the full viewer of the WOPI client - which advertises editing and then has to explain why it is not available - is the wrong experience here. Falls back to the regular view action where the discovery offers no embedded one.

Definition at line 43 of file ActionDBRepository.php.

◆ TABLE_NAME

const ILIAS\WOPI\Discovery\ActionDBRepository::TABLE_NAME = 'wopi_action'

private

Definition at line 33 of file ActionDBRepository.php.

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

components/ILIAS/WOPI/classes/Discovery/ActionDBRepository.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clear()

◆ clearSuperfluous()

◆ fromDBRow()

◆ getActionForSuffix()

◆ getActions()

◆ getActionsForApp()

◆ getActionsForTarget()

◆ getActionsForTargets()

◆ getCreatableFormats()

◆ getCreatableSuffixes()

◆ getEditActionForSuffix()

◆ getEditNewFormats()

◆ getSupportedSuffixes()

◆ getTemplateSuffixes()

◆ getViewActionForSuffix()

◆ hasActionForSuffix()

◆ hasEditActionForSuffix()

◆ hasViewActionForSuffix()

◆ implodeTargets()

◆ store()

Field Documentation

◆ $edit_actions

◆ $view_actions

◆ TABLE_NAME