class.ilSystemStyleIconFolder.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
class ilSystemStyleIconFolder
{
    protected array $icons = [];
 
    protected string $path = '';
 
    protected ilSystemStyleIconColorSet $color_set;
 
    public function __construct(string $path)
    {
        $this->setPath($path);
        $this->read();
    }
 
    public function read(): void
    {
        $this->readIconsFromFolder($this->getPath());
        $this->sortIcons();
    }
 
    protected function sortIcons(): void
    {
        usort($this->icons, [$this, 'compareIconsByName']);
    }
 
    protected function compareIconsByName(ilSystemStyleIcon $a, ilSystemStyleIcon $b): int
    {
        if ($a->getType() == $b->getType()) {
            return strcmp($a->getName(), $b->getName());
        } elseif ($a->getType() == 'svg') {
            return -1;
        } elseif ($b->getType() == 'svg') {
            return 1;
        } else {
            return strcmp($a->getType(), $b->getType());
        }
    }
 
    public function sortIconsByPath(): void
    {
        usort($this->icons, static function (ilSystemStyleIcon $a, ilSystemStyleIcon $b): int {
            return strcmp($a->getPath(), $b->getPath());
        });
    }
 
    protected function readIconsFromFolder(string $src = ''): void
    {
        try {
            $dir_iterator = new RecursiveDirectoryIterator($src);
        } catch (UnexpectedValueException $e) {
            throw new ilSystemStyleIconException(ilSystemStyleIconException::IMAGES_FOLDER_DOES_NOT_EXIST, $src);
        }
 
        $rec_it = new RecursiveIteratorIterator($dir_iterator);
 
        foreach ($rec_it as $file) {
            if (!$file->isReadable()) {
                throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $file->getPathname());
            }
            if ($file->isFile()) {
                $extension = $file->getExtension();
                if ($extension == 'gif' || $extension == 'svg' || $extension == 'png') {
                    $this->addIcon(new ilSystemStyleIcon($file->getFilename(), $file->getPathname(), $extension));
                }
            }
        }
    }
 
    public function changeIconColors(array $color_changes): void
    {
        foreach ($this->getIcons() as $icon) {
            $icon->changeColors($color_changes);
        }
    }
 
    public function addIcon(ilSystemStyleIcon $icon): void
    {
        $this->icons[] = $icon;
    }
 
    public function getIcons(): array
    {
        return $this->icons;
    }
 
    public function getIconByName(string $name): ilSystemStyleIcon
    {
        foreach ($this->icons as $icon) {
            if ($icon->getName() == $name) {
                return $icon;
            }
        }
        throw new ilSystemStyleIconException(ilSystemStyleIconException::ICON_DOES_NOT_EXIST, $name);
    }
 
    public function getIconByPath(string $path): ilSystemStyleIcon
    {
        foreach ($this->icons as $icon) {
            if ($icon->getPath() == $path) {
                return $icon;
            }
        }
        throw new ilSystemStyleIconException(ilSystemStyleIconException::ICON_DOES_NOT_EXIST, $path);
    }
 
    public function getIconsSortedByFolder(): array
    {
        $folders = [];
 
        foreach ($this->getIcons() as $icon) {
            $folders[dirname($icon->getPath())][] = $icon;
        }
 
        ksort($folders);
 
        foreach ($folders as $id => $folder) {
            ksort($folders[$id]);
        }
 
        return $folders;
    }
 
    public function setIcons(array $icons): void
    {
        $this->icons = $icons;
    }
 
    public function getPath(): string
    {
        return $this->path;
    }
 
    public function setPath(string $path): void
    {
        $this->path = $path;
    }
 
    public function getColorSet(): ilSystemStyleIconColorSet
    {
        if (!isset($this->color_set)) {
            $this->extractColorSet();
        }
        return $this->color_set;
    }
 
    protected function extractColorSet(): void
    {
        $this->color_set = new ilSystemStyleIconColorSet();
        foreach ($this->getIcons() as $icon) {
            $this->color_set->mergeColorSet($icon->getColorSet());
        }
    }
 
    public function getUsagesOfColor(string $color_id): array
    {
        $icons = [];
        foreach ($this->getIcons() as $icon) {
            if ($icon->usesColor($color_id)) {
                $icons[] = $icon;
            }
        }
        return $icons;
    }
 
    public function getUsagesOfColorAsString(string $color_id): string
    {
        $usage_string = '';
        foreach ($this->getUsagesOfColor($color_id) as $icon) {
            $usage_string .= rtrim($icon->getName(), '.svg') . '; ';
        }
        return $usage_string;
    }
 
    public function setColorSet(ilSystemStyleIconColorSet $color_set): void
    {
        $this->color_set = $color_set;
    }
}