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

	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)

	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.

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

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

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

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

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

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

◆ extractColorSet()

ilSystemStyleIconFolder::extractColorSet ( )

protected

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

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

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

◆ getColorSet()

ilSystemStyleIconFolder::getColorSet ( )

Returns: ilSystemStyleIconColorSet

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

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

◆ getIconByName()

ilSystemStyleIconFolder::getIconByName ( $name )

Parameters

$name

Returns: ilSystemStyleIcon

Exceptions

ilSystemStyleIconException

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

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

References ilSystemStyleIconException\ICON_DOES_NOT_EXIST.

◆ getIcons()

ilSystemStyleIconFolder::getIcons ( )

Gets an Icon from the folders abstraction.

Returns: ilSystemStyleIcon[]

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

        {
                return $this->icons;
        }

◆ getIconsSortedByFolder()

ilSystemStyleIconFolder::getIconsSortedByFolder ( )

Sorts all icons by their occurrence in folders.

Returns: array array(folder_path_name => [$icons])

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

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

◆ getPath()

ilSystemStyleIconFolder::getPath ( )

Returns: string

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

        {
                return $this->path;
        }

References $path.

Referenced by read().

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

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

◆ getUsagesOfColorAsString()

ilSystemStyleIconFolder::getUsagesOfColorAsString ( $color_id )

Gets the usages of a color as string.

Parameters

$color_id

Returns: string

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

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

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

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

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

Referenced by __construct().

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

        {
                $this->color_set = $color_set;
        }

◆ setIcons()

ilSystemStyleIconFolder::setIcons ( $icons )

Parameters

ilSystemStyleIcon[] $icons

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

        {
                $this->icons = $icons;
        }

◆ setPath()

ilSystemStyleIconFolder::setPath ( $path )

Parameters

string $path

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

        {
                $this->path = $path;
        }

References $path.

Referenced by __construct().

Here is the caller graph for this function:

◆ sortIcons()

ilSystemStyleIconFolder::sortIcons ( )

protected

Sorts the Icons by name and type.

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

                                      {
                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;
                                }else if($b->getType() == "svg"){
                                        return true;
                                }else{
                                        return strcmp($a->getType(),$b->getType());
                                }
                        }
                });
        }

References ilSystemStyleIcon\getType().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xRead()

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

protected

Parameters

string	$src
string	$rel_path

Exceptions

ilSystemStyleException
ilSystemStyleIconException

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

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

References $file, $info, ilSystemStyleException\FILE_OPENING_FAILED, and ilSystemStyleIconException\IMAGES_FOLDER_DOES_NOT_EXIST.

Referenced by read().

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.

◆ $icons

ilSystemStyleIconFolder::$icons = []

protected

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

◆ $path

ilSystemStyleIconFolder::$path = ""

protected

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

Referenced by __construct().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addIcon()

◆ changeIconColors()

◆ extractColorSet()

◆ getColorSet()

◆ getIconByName()

◆ getIcons()

◆ getIconsSortedByFolder()

◆ getPath()

◆ getUsagesOfColor()

◆ getUsagesOfColorAsString()

◆ read()

◆ setColorSet()

◆ setIcons()

◆ setPath()

◆ sortIcons()

◆ xRead()

Field Documentation

◆ $color_set

◆ $icons

◆ $path