class.ilSystemStyleIconFolder.php

Go to the documentation of this file.

<?php
require_once("./Services/Style/System/classes/Icons/class.ilSystemStyleIcon.php");
require_once("./Services/Style/System/classes/Exceptions/class.ilSystemStyleIconException.php");

class ilSystemStyleIconFolder
{
    protected $icons = [];

    protected $path = "";

    protected $color_set = null;

    public function __construct($path)
    {
        $this->setPath($path);
        $this->read();
    }

    public function read()
    {
        $this->xRead($this->getPath(), "");
        $this->sortIcons();
    }

    protected function sortIcons()
    {
        usort($this->icons, function (ilSystemStyleIcon $a, ilSystemStyleIcon $b) {
            if ($a->getType() == $b->getType()) {
                return strcmp($a->getName(), $b->getName());
            } else {
                if ($a->getType() == "svg") {
                    return false;
                } elseif ($b->getType() == "svg") {
                    return true;
                } 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 xRead($src = "", $rel_path = "")
    {
        if (!is_dir($src)) {
            throw new ilSystemStyleIconException(ilSystemStyleIconException::IMAGES_FOLDER_DOES_NOT_EXIST, $src);
        }
        foreach (scandir($src) as $file) {
            $src_file = rtrim($src, '/') . '/' . $file;
            if (!is_readable($src_file)) {
                throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $src_file);
            }
            if (substr($file, 0, 1) != ".") {
                if (is_dir($src_file)) {
                    self::xRead($src_file, $rel_path . "/" . $file);
                } else {
                    $info = new SplFileInfo($src_file);
                    $extension = $info->getExtension();
                    if ($extension == "gif" || $extension == "svg" || $extension == "png") {
                        $this->addIcon(new ilSystemStyleIcon($file, $this->getPath() . $rel_path . "/" . $file, $extension));
                    }
                }
            }
        }
    }


    public function changeIconColors(array $color_changes)
    {
        foreach ($this->getIcons() as $icon) {
            $icon->changeColors($color_changes);
        }
    }

    public function addIcon(ilSystemStyleIcon $icon)
    {
        $this->icons[] = $icon;
    }

    public function getIcons()
    {
        return $this->icons;
    }

    public function getIconByName($name)
    {
        foreach ($this->icons as $icon) {
            if ($icon->getName() == $name) {
                return $icon;
            }
        }
        throw new ilSystemStyleIconException(ilSystemStyleIconException::ICON_DOES_NOT_EXIST, $name);
    }

    public function getIconByPath($path)
    {
        foreach ($this->icons as $icon) {
            if ($icon->getPath() == $path) {
                return $icon;
            }
        }
        throw new ilSystemStyleIconException(ilSystemStyleIconException::ICON_DOES_NOT_EXIST, $path);
    }

    public function getIconsSortedByFolder()
    {
        $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($icons)
    {
        $this->icons = $icons;
    }

    public function getPath()
    {
        return $this->path;
    }

    public function setPath($path)
    {
        $this->path = $path;
    }

    public function getColorSet()
    {
        if (!$this->color_set) {
            $this->extractColorSet();
        }
        return $this->color_set;
    }

    protected function extractColorSet()
    {
        $this->color_set = new ilSystemStyleIconColorSet();
        foreach ($this->getIcons() as $icon) {
            $this->color_set->mergeColorSet($icon->getColorSet());
        }
    }

    public function getUsagesOfColor($color_id)
    {
        $icons = [];
        foreach ($this->getIcons() as $icon) {
            if ($icon->usesColor($color_id)) {
                $icons[] = $icon;
            }
        }
        return $icons;
    }

    public function getUsagesOfColorAsString($color_id)
    {
        $usage_string = "";
        foreach ($this->getUsagesOfColor($color_id) as $icon) {
            $usage_string .= rtrim($icon->getName(), ".svg") . "; ";
        }
        return $usage_string;
    }

    public function setColorSet($color_set)
    {
        $this->color_set = $color_set;
    }
}