Inheritance diagram for ILIAS\File\Icon\IconDatabaseRepository:

Collaboration diagram for ILIAS\File\Icon\IconDatabaseRepository:

Public Member Functions
	__construct (private ?\ilDBInterface $db=null, private ?Services $irss=null)

	createIcon (string $a_rid, bool $a_active, bool $a_is_default_icon, array $a_suffixes)

	getIconsForFilter (array $filter)

	getIcons ()

	getIconByRid (string $a_rid)

	getActiveIconForSuffix (string $a_suffix)

	getIconFilePathBySuffix (string $suffix)

	updateIcon (string $a_rid, bool $a_active, bool $a_is_default_icon, array $a_suffixes)

	deleteIconByRid (string $a_rid)

Public Member Functions inherited from ILIAS\File\Icon\IconAbstractRepository
	__construct ()

	turnSuffixesArrayIntoString (array $a_suffixes)

	turnSuffixesStringIntoArray (string $a_suffixes)

	hasSuffixInputOnlyAllowedCharacters (array $a_suffixes)

	hasSuffixInputNoDuplicatesToItsOwnEntries (array $a_suffixes)

	causesNoActiveSuffixesConflict (array $a_future_suffixes, bool $a_future_activation_state, Icon $a_current_icon)

Data Fields
const	ICON_TABLE_NAME = 'il_file_icon'

const	ICON_RESOURCE_IDENTIFICATION = 'rid'

const	ICON_ACTIVE = 'active'

const	IS_DEFAULT_ICON = 'is_default_icon'

const	SUFFIX_TABLE_NAME = 'il_file_icon_suffixes'

const	SUFFIX = 'suffix'

const	SUFFIXES = 'suffixes'

Detailed Description

Author: Lukas Zehnder lukas.nosp@m.@sr..nosp@m.solut.nosp@m.ions

Definition at line 30 of file IconDatabaseRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\File\Icon\IconDatabaseRepository::__construct	(	private ?\ilDBInterface	$db = `null`,
		private ?Services	$irss = `null`
	)

Definition at line 40 of file IconDatabaseRepository.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

       {
         global $DIC;
         parent::__construct();
         $this->db ??= $DIC->database();
         $this->irss ??= $DIC->resourceStorage();
     }

Here is the call graph for this function:

Member Function Documentation

◆ createIcon()

ILIAS\File\Icon\IconDatabaseRepository::createIcon	(	string	$a_rid,
		bool	$a_active,
		bool	$a_is_default_icon,
		array	$a_suffixes
	)

Implements ILIAS\File\Icon\IconRepositoryInterface.

Definition at line 50 of file IconDatabaseRepository.php.

                                                                                                          : Icon
     {
         $icon = new CustomIcon($a_rid, $a_active, $a_is_default_icon, $a_suffixes);
         foreach ($icon->getSuffixes() as $suffix) {
             $this->db->insert(
                 self::SUFFIX_TABLE_NAME,
                 [
                     self::ICON_RESOURCE_IDENTIFICATION => ['text', $icon->getRid()],
                     self::SUFFIX => ['text', $suffix],
                 ]
             );
         }
         $this->db->insert(
             self::ICON_TABLE_NAME,
             [
                 self::ICON_RESOURCE_IDENTIFICATION => ['text', $icon->getRid()],
                 self::ICON_ACTIVE => ['integer', $icon->isActive()],
                 self::IS_DEFAULT_ICON => ['integer', $icon->isDefaultIcon()]
             ]
         );
         return $icon;
     }

◆ deleteIconByRid()

ILIAS\File\Icon\IconDatabaseRepository::deleteIconByRid ( string $a_rid )

Implements ILIAS\File\Icon\IconRepositoryInterface.

Definition at line 269 of file IconDatabaseRepository.php.

References ILIAS\File\Icon\IconDatabaseRepository\getIconByRid().

                                                   : bool
     {
         $icon = $this->getIconByRid($a_rid);
         if (!$icon instanceof NullIcon) {
             $this->db->manipulateF(
                 "DELETE FROM " . self::SUFFIX_TABLE_NAME . " WHERE " . self::ICON_RESOURCE_IDENTIFICATION . " = %s",
                 ['text'],
                 [$a_rid]
             );
             $this->db->manipulateF(
                 "DELETE FROM " . self::ICON_TABLE_NAME . " WHERE " . self::ICON_RESOURCE_IDENTIFICATION . " = %s",
                 ['text'],
                 [$a_rid]
             );
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ getActiveIconForSuffix()

ILIAS\File\Icon\IconDatabaseRepository::getActiveIconForSuffix ( string $a_suffix )

Implements ILIAS\File\Icon\IconRepositoryInterface.

Definition at line 192 of file IconDatabaseRepository.php.

References $data, ILIAS\File\Icon\IconDatabaseRepository\getIconByRid(), and null.

Referenced by ILIAS\File\Icon\IconDatabaseRepository\getIconFilePathBySuffix().

                                                             : Icon
     {
         $rid = null;
         $icon = new NullIcon();
 
         // Determine the icon's rid first and then determine the icon by its rid.
         // This is done because a query like the one in getIconByRid with a where-clause
         // for the suffix would not return all suffixes of the matching icon.
         $query = "SELECT s." . self::ICON_RESOURCE_IDENTIFICATION . " FROM " . self::SUFFIX_TABLE_NAME . " AS s"
             . " INNER JOIN " . self::ICON_TABLE_NAME . " AS i"
             . " ON s." . self::ICON_RESOURCE_IDENTIFICATION . " = i." . self::ICON_RESOURCE_IDENTIFICATION
             . " WHERE s." . self::SUFFIX . " = %s AND i." . self::ICON_ACTIVE . " = %s";
         $result = $this->db->queryF(
             $query,
             ["text", "integer"],
             [$a_suffix, 1]
         );
         while ($data = $this->db->fetchAssoc($result)) {
             $rid = $data[self::ICON_RESOURCE_IDENTIFICATION];
         }
 
         if ($rid !== null) {
             return $this->getIconByRid($rid);
         }
 
         return $icon;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIconByRid()

ILIAS\File\Icon\IconDatabaseRepository::getIconByRid ( string $a_rid )

Implements ILIAS\File\Icon\IconRepositoryInterface.

Definition at line 160 of file IconDatabaseRepository.php.

References $data, and ILIAS\File\Icon\IconAbstractRepository\turnSuffixesStringIntoArray().

Referenced by ILIAS\File\Icon\IconDatabaseRepository\deleteIconByRid(), and ILIAS\File\Icon\IconDatabaseRepository\getActiveIconForSuffix().

                                                : Icon
     {
         $icon = new NullIcon();
 
         $query = "SELECT i." . self::ICON_RESOURCE_IDENTIFICATION
             . ", i." . self::ICON_ACTIVE
             . ", i." . self::IS_DEFAULT_ICON
             . ", GROUP_CONCAT(s." . self::SUFFIX . ") AS " . self::SUFFIXES
             . " FROM " . self::ICON_TABLE_NAME . " AS i"
             . " INNER JOIN " . self::SUFFIX_TABLE_NAME . " AS s"
             . " ON " . "i." . self::ICON_RESOURCE_IDENTIFICATION . " = " . "s." . self::ICON_RESOURCE_IDENTIFICATION
             . " WHERE i." . self::ICON_RESOURCE_IDENTIFICATION . " = %s"
             . " GROUP BY i." . self::ICON_RESOURCE_IDENTIFICATION;
 
         $result = $this->db->queryF(
             $query,
             ["text"],
             [$a_rid]
         );
 
         while ($data = $this->db->fetchAssoc($result)) {
             $icon = new CustomIcon(
                 $rid = $data[self::ICON_RESOURCE_IDENTIFICATION],
                 (bool) $data[self::ICON_ACTIVE],
                 (bool) $data[self::IS_DEFAULT_ICON],
                 $this->turnSuffixesStringIntoArray($data[self::SUFFIXES])
             );
         }
 
         return $icon;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIconFilePathBySuffix()

ILIAS\File\Icon\IconDatabaseRepository::getIconFilePathBySuffix ( string $suffix )

Implements ILIAS\File\Icon\IconRepositoryInterface.

Definition at line 220 of file IconDatabaseRepository.php.

References ILIAS\File\Icon\IconDatabaseRepository\getActiveIconForSuffix(), and ilUtil\getImagePath().

                                                            : string
     {
         if ($suffix !== "") {
             $icon = $this->getActiveIconForSuffix($suffix);
             if (!$icon instanceof NullIcon) {
                 $resource_identification = $this->irss->manage()->find($icon->getRid());
                 if ($resource_identification instanceof ResourceIdentification) {
                     try {
                         return $this->irss->consume()->src($resource_identification)->getSrc(
                             false
                         );
                     } catch (\Throwable) {
                         // error reading the resource, continue
                     }
                 }
             }
         }
         return ilUtil::getImagePath("standard/icon_file.svg");
     }

Here is the call graph for this function:

◆ getIcons()

ILIAS\File\Icon\IconDatabaseRepository::getIcons ( )

Returns: array<int|string, CustomIcon>

Implements ILIAS\File\Icon\IconRepositoryInterface.

Definition at line 132 of file IconDatabaseRepository.php.

References $data, and ILIAS\File\Icon\IconAbstractRepository\turnSuffixesStringIntoArray().

                               : array
     {
         $icons = [];
 
         $query = "SELECT i." . self::ICON_RESOURCE_IDENTIFICATION
             . ", i." . self::ICON_ACTIVE
             . ", i." . self::IS_DEFAULT_ICON
             . ", GROUP_CONCAT(s." . self::SUFFIX . ") AS " . self::SUFFIXES
             . " FROM " . self::ICON_TABLE_NAME . " AS i"
             . " INNER JOIN " . self::SUFFIX_TABLE_NAME . " AS s"
             . " ON " . "i." . self::ICON_RESOURCE_IDENTIFICATION . " = " . "s." . self::ICON_RESOURCE_IDENTIFICATION
             . " GROUP BY i." . self::ICON_RESOURCE_IDENTIFICATION;
 
         $result = $this->db->query($query);
 
         while ($data = $this->db->fetchAssoc($result)) {
             $icon = new CustomIcon(
                 $rid = $data[self::ICON_RESOURCE_IDENTIFICATION],
                 (bool) $data[self::ICON_ACTIVE],
                 (bool) $data[self::IS_DEFAULT_ICON],
                 $this->turnSuffixesStringIntoArray($data[self::SUFFIXES])
             );
             $icons[$rid] = $icon;
         }
 
         return $icons;
     }

Here is the call graph for this function:

◆ getIconsForFilter()

ILIAS\File\Icon\IconDatabaseRepository::getIconsForFilter ( array $filter )

Implements ILIAS\File\Icon\IconRepositoryInterface.

Definition at line 74 of file IconDatabaseRepository.php.

References $data, $q, null, and ILIAS\File\Icon\IconAbstractRepository\turnSuffixesStringIntoArray().

                                                     : array
     {
         $icons = [];
 
         $rid_filter = null;
         // due to the database schema, the suffixes filter has to be handled separately
         if ($filter !== [] && ($filter['suffixes'] ?? null) !== null && $filter['suffixes'] !== '') {
             $suffixes = explode(',', (string) $filter['suffixes']);
             $suffixes = array_map(fn($suffix): string => $this->db->quote(trim((string) $suffix), 'text'), $suffixes);
             $q = "SELECT rid FROM " . self::SUFFIX_TABLE_NAME . " WHERE suffix IN (" . implode(',', $suffixes) . ")";
             $rid_filter = $this->db->fetchAll($this->db->query($q));
             $rid_filter = array_map(fn($row) => $row['rid'], $rid_filter);
         }
 
         $query = "SELECT i." . self::ICON_RESOURCE_IDENTIFICATION
             . ", i." . self::ICON_ACTIVE
             . ", i." . self::IS_DEFAULT_ICON
             . ", GROUP_CONCAT(s." . self::SUFFIX . ") AS " . self::SUFFIXES
             . " FROM " . self::ICON_TABLE_NAME . " AS i"
             . " JOIN " . self::SUFFIX_TABLE_NAME . " AS s"
             . " ON " . "i." . self::ICON_RESOURCE_IDENTIFICATION . " = " . "s." . self::ICON_RESOURCE_IDENTIFICATION;
 
         if ($filter !== []) {
             $query .= " WHERE true ";
             if (($filter['active'] ?? null) !== null && $filter['active'] !== '') {
                 $query .= " AND i.active = " . $this->db->quote($filter['active'], 'integer');
             }
 
             if ($rid_filter) {
                 $rid_filter = array_map(fn($rid): string => $this->db->quote(trim((string) $rid), 'text'), $rid_filter);
                 $query .= " AND i.rid IN (" . implode(',', $rid_filter) . ")";
             }
 
             if (($filter['is_default_icon'] ?? null) !== null && $filter['is_default_icon'] !== '') {
                 $query .= " AND i.is_default_icon = " . $this->db->quote($filter['is_default_icon'], 'integer');
             }
         }
 
         $query .= " GROUP BY i." . self::ICON_RESOURCE_IDENTIFICATION;
 
         $result = $this->db->query($query);
 
         while ($data = $this->db->fetchAssoc($result)) {
             $icon = new CustomIcon(
                 $rid = $data[self::ICON_RESOURCE_IDENTIFICATION],
                 (bool) $data[self::ICON_ACTIVE],
                 (bool) $data[self::IS_DEFAULT_ICON],
                 $this->turnSuffixesStringIntoArray($data[self::SUFFIXES])
             );
             $icons[$rid] = $icon;
         }
 
         return $icons;
     }

Here is the call graph for this function:

◆ updateIcon()

ILIAS\File\Icon\IconDatabaseRepository::updateIcon	(	string	$a_rid,
		bool	$a_active,
		bool	$a_is_default_icon,
		array	$a_suffixes
	)

Implements ILIAS\File\Icon\IconRepositoryInterface.

Definition at line 240 of file IconDatabaseRepository.php.

                                                                                                          : Icon
     {
         $icon = new CustomIcon($a_rid, $a_active, $a_is_default_icon, $a_suffixes);
         // Delete the old suffix entries of the given icon first as they can not be identified by form input and therefore cannot be overwritten - only deleted and created anew
         $this->db->manipulateF(
             "DELETE FROM " . self::SUFFIX_TABLE_NAME . " WHERE " . self::ICON_RESOURCE_IDENTIFICATION . " = %s",
             ['text'],
             [$icon->getRid()]
         );
         foreach ($icon->getSuffixes() as $suffix) {
             $this->db->insert(
                 self::SUFFIX_TABLE_NAME,
                 [
                     self::ICON_RESOURCE_IDENTIFICATION => ['text', $icon->getRid()],
                     self::SUFFIX => ['text', $suffix],
                 ]
             );
         }
         $this->db->update(
             self::ICON_TABLE_NAME,
             [
                 self::ICON_ACTIVE => ['integer', $icon->isActive()],
                 self::IS_DEFAULT_ICON => ['integer', $icon->isDefaultIcon()]
             ],
             [self::ICON_RESOURCE_IDENTIFICATION => ['text', $icon->getRid()]]
         );
         return $icon;
     }

Field Documentation

◆ ICON_ACTIVE

const ILIAS\File\Icon\IconDatabaseRepository::ICON_ACTIVE = 'active'

Definition at line 34 of file IconDatabaseRepository.php.

Referenced by ILIAS\File\Icon\ilObjFileDefaultIconsObjective\getPreconditions().

◆ ICON_RESOURCE_IDENTIFICATION

const ILIAS\File\Icon\IconDatabaseRepository::ICON_RESOURCE_IDENTIFICATION = 'rid'

Definition at line 33 of file IconDatabaseRepository.php.

Referenced by ILIAS\File\Icon\ilObjFileDefaultIconsObjective\getPreconditions().

◆ ICON_TABLE_NAME

const ILIAS\File\Icon\IconDatabaseRepository::ICON_TABLE_NAME = 'il_file_icon'

Definition at line 32 of file IconDatabaseRepository.php.

Referenced by ILIAS\File\Icon\ilObjFileDefaultIconsObjective\getPreconditions().

◆ IS_DEFAULT_ICON

const ILIAS\File\Icon\IconDatabaseRepository::IS_DEFAULT_ICON = 'is_default_icon'

Definition at line 35 of file IconDatabaseRepository.php.

Referenced by ILIAS\File\Icon\ilObjFileDefaultIconsObjective\getPreconditions().

◆ SUFFIX

const ILIAS\File\Icon\IconDatabaseRepository::SUFFIX = 'suffix'

Definition at line 37 of file IconDatabaseRepository.php.

Referenced by ILIAS\File\Icon\ilObjFileDefaultIconsObjective\getPreconditions().

◆ SUFFIX_TABLE_NAME

const ILIAS\File\Icon\IconDatabaseRepository::SUFFIX_TABLE_NAME = 'il_file_icon_suffixes'

Definition at line 36 of file IconDatabaseRepository.php.

Referenced by ILIAS\File\Icon\ilObjFileDefaultIconsObjective\getPreconditions().

◆ SUFFIXES

const ILIAS\File\Icon\IconDatabaseRepository::SUFFIXES = 'suffixes'

Definition at line 38 of file IconDatabaseRepository.php.

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

components/ILIAS/File/classes/Icons/IconDatabaseRepository.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createIcon()

◆ deleteIconByRid()

◆ getActiveIconForSuffix()

◆ getIconByRid()

◆ getIconFilePathBySuffix()

◆ getIcons()

◆ getIconsForFilter()

◆ updateIcon()

Field Documentation

◆ ICON_ACTIVE

◆ ICON_RESOURCE_IDENTIFICATION

◆ ICON_TABLE_NAME

◆ IS_DEFAULT_ICON

◆ SUFFIX

◆ SUFFIX_TABLE_NAME

◆ SUFFIXES