ILIAS\File\Icon\IconAbstractRepository Class Reference

Inheritance diagram for ILIAS\File\Icon\IconAbstractRepository:

Collaboration diagram for ILIAS\File\Icon\IconAbstractRepository:

Public Member Functions
	__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)
Public Member Functions inherited from ILIAS\File\Icon\IconRepositoryInterface
	createIcon (string $a_rid, bool $a_active, bool $a_is_default_icon, array $a_suffixes)
	getIcons ()
	getIconsForFilter (array $filter)
	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)

Private Attributes
ILIAS Refinery Factory	$refinery

Detailed Description

Author

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

Definition at line 26 of file IconAbstractRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\File\Icon\IconAbstractRepository::__construct

(

)

Definition at line 30 of file IconAbstractRepository.php.

References $DIC, and ILIAS\Repository\refinery().

    {
        global $DIC;
        $this->refinery = $DIC->refinery();
    }

Here is the call graph for this function:

Member Function Documentation

causesNoActiveSuffixesConflict()

ILIAS\File\Icon\IconAbstractRepository::causesNoActiveSuffixesConflict ( array  $a_future_suffixes, bool  $a_future_activation_state, Icon  $a_current_icon  )

final

Definition at line 62 of file IconAbstractRepository.php.

References ILIAS\File\Icon\IconRepositoryInterface\getIcons(), and ILIAS\File\Icon\Icon\getRid().

     : bool {
        //if the icon is not going to be activated there can be no suffix conflict with other icons
        if (!$a_future_activation_state) {
            return true;
        }

        $existing_icons = $this->getIcons();
        //remove current icon from existing icon array to prevent validation errors when updating an existing icon
        if (!$a_current_icon instanceof NullIcon) {
            unset($existing_icons[$a_current_icon->getRid()]);
        }

        $duplicate_suffixes = [];
        foreach ($existing_icons as $existing_icon) {
            //skip deactivated icons as having multiple icon entries for the same suffix is allowed, the restriction is that only one can be activated
            if (!$existing_icon->isActive()) {
                continue;
            }
            $duplicate_suffixes = array_merge(
                $duplicate_suffixes,
                array_intersect($a_future_suffixes, $existing_icon->getSuffixes())
            );
        }

        return $duplicate_suffixes === [];
    }

Here is the call graph for this function:

hasSuffixInputNoDuplicatesToItsOwnEntries()

ILIAS\File\Icon\IconAbstractRepository::hasSuffixInputNoDuplicatesToItsOwnEntries ( array  $a_suffixes )

final

Definition at line 57 of file IconAbstractRepository.php.

                                                                                      : bool
    {
        return count($a_suffixes) === count(array_unique($a_suffixes));
    }

hasSuffixInputOnlyAllowedCharacters()

ILIAS\File\Icon\IconAbstractRepository::hasSuffixInputOnlyAllowedCharacters ( array  $a_suffixes )

final

Definition at line 50 of file IconAbstractRepository.php.

References ILIAS\Repository\refinery(), and ILIAS\File\Icon\IconAbstractRepository\turnSuffixesArrayIntoString().

                                                                                : bool
    {
        $suffixes_string = $this->turnSuffixesArrayIntoString($a_suffixes);
        $matches = preg_match("/^[a-zA-Z0-9\,\s]+$/", $suffixes_string);
        return $this->refinery->kindlyTo()->bool()->transform($matches);
    }

Here is the call graph for this function:

turnSuffixesArrayIntoString()

ILIAS\File\Icon\IconAbstractRepository::turnSuffixesArrayIntoString ( array  $a_suffixes )

final

Definition at line 36 of file IconAbstractRepository.php.

Referenced by ILIAS\File\Icon\IconAbstractRepository\hasSuffixInputOnlyAllowedCharacters().

                                                                        : string
    {
        return implode(", ", $a_suffixes);
    }

Here is the caller graph for this function:

turnSuffixesStringIntoArray()

ILIAS\File\Icon\IconAbstractRepository::turnSuffixesStringIntoArray ( string  $a_suffixes )

final

Returns

string[]

Definition at line 44 of file IconAbstractRepository.php.

Referenced by ILIAS\File\Icon\IconDatabaseRepository\getIconByRid(), ILIAS\File\Icon\IconDatabaseRepository\getIcons(), and ILIAS\File\Icon\IconDatabaseRepository\getIconsForFilter().

                                                                         : array
    {
        $a_suffixes = preg_replace('/\s+/', '', $a_suffixes);
        return explode(",", $a_suffixes);
    }

Here is the caller graph for this function:

Field Documentation

$refinery

ILIAS Refinery Factory ILIAS\File\Icon\IconAbstractRepository::$refinery

private

Definition at line 28 of file IconAbstractRepository.php.

---

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

• components/ILIAS/File/classes/Icons/IconAbstractRepository.php