IconAbstractRepository.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\File\Icon;

use ILIAS\Refinery\Factory;

abstract class IconAbstractRepository implements IconRepositoryInterface
{
    private Factory $refinery;

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

    final public function turnSuffixesArrayIntoString(array $a_suffixes): string
    {
        return implode(", ", $a_suffixes);
    }

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

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

    final public function hasSuffixInputNoDuplicatesToItsOwnEntries(array $a_suffixes): bool
    {
        return count($a_suffixes) === count(array_unique($a_suffixes));
    }

    final public function causesNoActiveSuffixesConflict(
        array $a_future_suffixes,
        bool $a_future_activation_state,
        Icon $a_current_icon
    ): 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 === [];
    }
}