ilSystemStyleIconFolder Class Reference

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

Collaboration diagram for ilSystemStyleIconFolder:

Public Member Functions
	__construct (string $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 (string $name)
	getIconByPath (string $path)
	getIconsSortedByFolder ()
	Sorts all icons by their occurrence in folders. More...
	setIcons (array $icons)
	getPath ()
	setPath (string $path)
	getColorSet ()
	getUsagesOfColor (string $color_id)
	Gets the usages of a certain color. More...
	getUsagesOfColorAsString (string $color_id)
	Gets the usages of a color as string. More...
	setColorSet (ilSystemStyleIconColorSet $color_set)

Protected Member Functions
	sortIcons ()
	Sorts the Icons by name and type. More...
	compareIconsByName (ilSystemStyleIcon $a, ilSystemStyleIcon $b)
	readIconsFromFolder (string $src='')
	extractColorSet ()
	Gets the color sets of all icons an merges them into one. More...

Protected Attributes
array	$icons = []
string	$path = ''
	Path to the root of the folder. More...
ilSystemStyleIconColorSet	$color_set
	Complete color set of all icons contained in this folder. More...

Detailed Description

Abstracts a folder containing a set of icons.

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

Constructor & Destructor Documentation

__construct()

ilSystemStyleIconFolder::__construct

(

string

$path

)

ilSystemStyleIconFolder constructor.

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

References 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.

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

Referenced by readIconsFromFolder().

                                                    : void
    {
        $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.

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

References getIcons().

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

Here is the call graph for this function:

compareIconsByName()

ilSystemStyleIconFolder::compareIconsByName ( ilSystemStyleIcon  $a, ilSystemStyleIcon  $b  )

protected

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

References ilSystemStyleIcon\getName(), and ilSystemStyleIcon\getType().

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

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 219 of file class.ilSystemStyleIconFolder.php.

References getIcons().

Referenced by getColorSet().

                                        : void
    {
        $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

(

)

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

References $color_set, and extractColorSet().

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

Here is the call graph for this function:

getIconByName()

ilSystemStyleIconFolder::getIconByName

(

string

$name

)

Exceptions

ilSystemStyleIconException

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

References $name, and ilSystemStyleIconException\ICON_DOES_NOT_EXIST.

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

getIconByPath()

ilSystemStyleIconFolder::getIconByPath

(

string

$path

)

Exceptions

ilSystemStyleIconException

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

References $path, and ilSystemStyleIconException\ICON_DOES_NOT_EXIST.

                                               : ilSystemStyleIcon
    {
        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 138 of file class.ilSystemStyleIconFolder.php.

References $icons.

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

                              : array
    {
        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 173 of file class.ilSystemStyleIconFolder.php.

References $id, and getIcons().

                                            : array
    {
        $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

(

)

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

References $path.

Referenced by read().

                             : string
    {
        return $this->path;
    }

Here is the caller graph for this function:

getUsagesOfColor()

ilSystemStyleIconFolder::getUsagesOfColor

(

string

$color_id

)

Gets the usages of a certain color.

Returns

ilSystemStyleIcon[]

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

References $icons, and getIcons().

Referenced by getUsagesOfColorAsString().

                                                      : array
    {
        $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

(

string

$color_id

)

Gets the usages of a color as string.

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

References getUsagesOfColor().

                                                              : string
    {
        $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 55 of file class.ilSystemStyleIconFolder.php.

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

Referenced by __construct().

                          : void
    {
        $this->readIconsFromFolder($this->getPath());
        $this->sortIcons();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readIconsFromFolder()

ilSystemStyleIconFolder::readIconsFromFolder ( string  $src = '' )

protected

Exceptions

ilSystemStyleException
ilSystemStyleIconException

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

References Vendor\Package\$e, addIcon(), ilSystemStyleException\FILE_OPENING_FAILED, and ilSystemStyleIconException\IMAGES_FOLDER_DOES_NOT_EXIST.

Referenced by read().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setColorSet()

ilSystemStyleIconFolder::setColorSet

(

ilSystemStyleIconColorSet

$color_set

)

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

References $color_set.

                                                                     : void
    {
        $this->color_set = $color_set;
    }

setIcons()

ilSystemStyleIconFolder::setIcons

(

array

$icons

)

Parameters

ilSystemStyleIcon[]

$icons

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

References $icons.

                                          : void
    {
        $this->icons = $icons;
    }

setPath()

ilSystemStyleIconFolder::setPath

(

string

$path

)

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

References $path.

Referenced by __construct().

                                         : void
    {
        $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 64 of file class.ilSystemStyleIconFolder.php.

Referenced by read().

                                  : void
    {
        usort($this->icons, [$this, 'compareIconsByName']);
    }

Here is the caller graph for this function:

sortIconsByPath()

ilSystemStyleIconFolder::sortIconsByPath

(

)

Definition at line 82 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:

Field Documentation

$color_set

ilSystemStyleIconColorSet ilSystemStyleIconFolder::$color_set

protected

Complete color set of all icons contained in this folder.

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

Referenced by getColorSet(), and setColorSet().

$icons

array ilSystemStyleIconFolder::$icons = []

protected

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

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

$path

string ilSystemStyleIconFolder::$path = ''

protected

Path to the root of the folder.

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

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

---

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

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