ilSystemStyleIconFolder Class Reference

Abstracts a folder containing a set of icons. More...

Collaboration diagram for ilSystemStyleIconFolder:

Public Member Functions
	__construct ($path)
	ilSystemStyleIconFolder constructor. More...
	read ()
	Reads the folder recursively and sorts the icons by name and type. More...
	sortIconsByPath ()
	changeIconColors (array $color_changes)
	Changes a set of colors in all icons contained in the folder. More...
	addIcon (ilSystemStyleIcon $icon)
	Adds an icon to the folders abstraction. More...
	getIcons ()
	Gets an Icon from the folders abstraction. More...
	getIconByName ($name)
	getIconByPath ($path)
	getIconsSortedByFolder ()
	Sorts all icons by their occurrence in folders. More...
	setIcons ($icons)
	getPath ()
	setPath ($path)
	getColorSet ()
	getUsagesOfColor ($color_id)
	Gets the usages of a certain color. More...
	getUsagesOfColorAsString ($color_id)
	Gets the usages of a color as string. More...
	setColorSet ($color_set)

Protected Member Functions
	sortIcons ()
	Sorts the Icons by name and type. More...
	xRead ($src="", $rel_path="")
	extractColorSet ()
	Gets the color sets of all icons an merges them into one. More...

Protected Attributes
	$icons = []
	$path = ""
	$color_set = null

Detailed Description

Abstracts a folder containing a set of icons.

Author

Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version

$Id$

Class ilSystemStyleIconFolder

Definition at line 15 of file class.ilSystemStyleIconFolder.php.

Constructor & Destructor Documentation

__construct()

ilSystemStyleIconFolder::__construct

(

$path

)

ilSystemStyleIconFolder constructor.

Parameters

string

$path

Definition at line 42 of file class.ilSystemStyleIconFolder.php.

References $path, read(), and setPath().

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

Here is the call graph for this function:

Member Function Documentation

addIcon()

ilSystemStyleIconFolder::addIcon

(

ilSystemStyleIcon

$icon

)

Adds an icon to the folders abstraction.

Parameters

ilSystemStyleIcon

$icon

Definition at line 134 of file class.ilSystemStyleIconFolder.php.

Referenced by xRead().

    {
        $this->icons[] = $icon;
    }

Here is the caller graph for this function:

changeIconColors()

ilSystemStyleIconFolder::changeIconColors

(

array

$color_changes

)

Changes a set of colors in all icons contained in the folder.

Parameters

array

$color_changes

Definition at line 122 of file class.ilSystemStyleIconFolder.php.

References getIcons().

    {
        foreach ($this->getIcons() as $icon) {
            $icon->changeColors($color_changes);
        }
    }

Here is the call graph for this function:

extractColorSet()

ilSystemStyleIconFolder::extractColorSet ( )

protected

Gets the color sets of all icons an merges them into one.

Definition at line 238 of file class.ilSystemStyleIconFolder.php.

References getIcons().

Referenced by getColorSet().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getColorSet()

ilSystemStyleIconFolder::getColorSet

(

)

Returns

ilSystemStyleIconColorSet

Definition at line 227 of file class.ilSystemStyleIconFolder.php.

References $color_set, and extractColorSet().

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

Here is the call graph for this function:

getIconByName()

ilSystemStyleIconFolder::getIconByName

(

$name

)

Parameters

$name

Returns

ilSystemStyleIcon

Exceptions

ilSystemStyleIconException

Definition at line 154 of file class.ilSystemStyleIconFolder.php.

References $name, and ilSystemStyleIconException\ICON_DOES_NOT_EXIST.

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

getIconByPath()

ilSystemStyleIconFolder::getIconByPath

(

$path

)

Parameters

$path

Returns

ilSystemStyleIcon

Exceptions

ilSystemStyleIconException

Definition at line 169 of file class.ilSystemStyleIconFolder.php.

References $path, and ilSystemStyleIconException\ICON_DOES_NOT_EXIST.

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

getIcons()

ilSystemStyleIconFolder::getIcons

(

)

Gets an Icon from the folders abstraction.

Returns

ilSystemStyleIcon[]

Definition at line 144 of file class.ilSystemStyleIconFolder.php.

References $icons.

Referenced by changeIconColors(), extractColorSet(), getIconsSortedByFolder(), and getUsagesOfColor().

    {
        return $this->icons;
    }

Here is the caller graph for this function:

getIconsSortedByFolder()

ilSystemStyleIconFolder::getIconsSortedByFolder

(

)

Sorts all icons by their occurrence in folders.

Returns

array array(folder_path_name => [$icons])

Definition at line 184 of file class.ilSystemStyleIconFolder.php.

References getIcons().

    {
        $folders = [];

        foreach ($this->getIcons() as $icon) {
            $folders[dirname($icon->getPath())][] = $icon;
        }

        ksort($folders);

        foreach ($folders as $id => $folder) {
            ksort($folders[$id]);
        }

        return $folders;
    }

Here is the call graph for this function:

getPath()

ilSystemStyleIconFolder::getPath

(

)

Returns

string

Definition at line 211 of file class.ilSystemStyleIconFolder.php.

References $path.

Referenced by read(), and xRead().

    {
        return $this->path;
    }

Here is the caller graph for this function:

getUsagesOfColor()

ilSystemStyleIconFolder::getUsagesOfColor

(

$color_id

)

Gets the usages of a certain color.

Parameters

$color_id

Returns

ilSystemStyleIcon[]

Definition at line 252 of file class.ilSystemStyleIconFolder.php.

References $icons, and getIcons().

Referenced by getUsagesOfColorAsString().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getUsagesOfColorAsString()

ilSystemStyleIconFolder::getUsagesOfColorAsString

(

$color_id

)

Gets the usages of a color as string.

Parameters

$color_id

Returns

string

Definition at line 269 of file class.ilSystemStyleIconFolder.php.

References getUsagesOfColor().

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

Here is the call graph for this function:

read()

ilSystemStyleIconFolder::read

(

)

Reads the folder recursively and sorts the icons by name and type.

Exceptions

ilSystemStyleException

Definition at line 53 of file class.ilSystemStyleIconFolder.php.

References getPath(), sortIcons(), and xRead().

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setColorSet()

ilSystemStyleIconFolder::setColorSet

(

$color_set

)

Parameters

$color_set

Definition at line 281 of file class.ilSystemStyleIconFolder.php.

References $color_set.

    {
        $this->color_set = $color_set;
    }

setIcons()

ilSystemStyleIconFolder::setIcons

(

$icons

)

Parameters

ilSystemStyleIcon[]

$icons

Definition at line 203 of file class.ilSystemStyleIconFolder.php.

References $icons.

    {
        $this->icons = $icons;
    }

setPath()

ilSystemStyleIconFolder::setPath

(

$path

)

Parameters

string

$path

Definition at line 219 of file class.ilSystemStyleIconFolder.php.

References $path.

Referenced by __construct().

    {
        $this->path = $path;
    }

Here is the caller graph for this function:

sortIcons()

ilSystemStyleIconFolder::sortIcons ( )

protected

Sorts the Icons by name and type.

Definition at line 62 of file class.ilSystemStyleIconFolder.php.

References Vendor\Package\$a, Vendor\Package\$b, ilSystemStyleIcon\getName(), and ilSystemStyleIcon\getType().

Referenced by read().

    {
        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());
                }
            }
        });
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sortIconsByPath()

ilSystemStyleIconFolder::sortIconsByPath

(

)

Definition at line 79 of file class.ilSystemStyleIconFolder.php.

References Vendor\Package\$a, Vendor\Package\$b, and ilSystemStyleIcon\getPath().

                                      : void
    {
        usort($this->icons, static function (ilSystemStyleIcon $a, ilSystemStyleIcon $b) : int {
            return strcmp($a->getPath(), $b->getPath());
        });
    }

Here is the call graph for this function:

xRead()

ilSystemStyleIconFolder::xRead (   $src = "",   $rel_path = ""  )

protected

Parameters

string	$src
string	$rel_path

Exceptions

ilSystemStyleException
ilSystemStyleIconException

Definition at line 92 of file class.ilSystemStyleIconFolder.php.

References addIcon(), ilSystemStyleException\FILE_OPENING_FAILED, getPath(), and ilSystemStyleIconException\IMAGES_FOLDER_DOES_NOT_EXIST.

Referenced by read().

    {
        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));
                    }
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$color_set

ilSystemStyleIconFolder::$color_set = null

protected

Definition at line 36 of file class.ilSystemStyleIconFolder.php.

Referenced by getColorSet(), and setColorSet().

$icons

ilSystemStyleIconFolder::$icons = []

protected

Definition at line 22 of file class.ilSystemStyleIconFolder.php.

Referenced by getIcons(), getUsagesOfColor(), and setIcons().

$path

ilSystemStyleIconFolder::$path = ""

protected

Definition at line 29 of file class.ilSystemStyleIconFolder.php.

Referenced by __construct(), getIconByPath(), getPath(), and setPath().

---

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

• Services/Style/System/classes/Icons/class.ilSystemStyleIconFolder.php