Abstracts an Icon and the necessary actions to get all colors out of an svg Icon. More...

Collaboration diagram for ilSystemStyleIcon:

Public Member Functions
	__construct (string $name, string $path, string $type)

	changeColors (array $color_changes)
	Changes colors in the svg file of the icon and updates the icon abstraction by extracting the colors again. More...

	getType ()

	setType (string $type)

	getName ()

	setName (string $name)

	__toString ()

	getPath ()

	setPath (string $path)

	getDirRelToCustomizing ()
	Only get dir rel to the Customizing dir without name and extension from. More...

	getColorSet ()

	setColorSet (ilSystemStyleIconColorSet $color_set)

	usesColor (string $color_id)

Protected Member Functions
	extractColorSet ()
	Extracts all colors from the icon by parsing the svg file for a regular expresion. More...

Protected Attributes
string	$path = ''
	Path to the icon including name and extension. More...

string	$name = ''
	Name of the Icon. More...

string	$type = ''
	Extension of the icon. More...

ilSystemStyleIconColorSet	$color_set
	Color set extracted from the icon. More...

Detailed Description

Abstracts an Icon and the necessary actions to get all colors out of an svg Icon.

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

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleIcon::__construct	(	string	$name,
		string	$path,
		string	$type
	)

Definition at line 46 of file class.ilSystemStyleIcon.php.

    {
        $this->setName($name);
        $this->setType($type);
        $this->setPath($path);
    }

References setName(), setPath(), and setType().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

ilSystemStyleIcon::__toString ( )

Definition at line 88 of file class.ilSystemStyleIcon.php.

                                : string
    {
        return $this->getName();
    }

References getName().

Here is the call graph for this function:

◆ changeColors()

ilSystemStyleIcon::changeColors ( array $color_changes )

Changes colors in the svg file of the icon and updates the icon abstraction by extracting the colors again.

Definition at line 56 of file class.ilSystemStyleIcon.php.

                                                      : void
    {
        if ($this->getType() == 'svg') {
            $icon = file_get_contents($this->getPath());
            foreach ($color_changes as $old_color => $new_color) {
                $icon = preg_replace('/#' . $old_color . '/i', '#' . $new_color, $icon, -1);
            }
            file_put_contents($this->getPath(), $icon);
        }
        $this->extractColorSet();
    }

References extractColorSet(), getPath(), and getType().

Here is the call graph for this function:

◆ extractColorSet()

ilSystemStyleIcon::extractColorSet ( )

protected

Extracts all colors from the icon by parsing the svg file for a regular expresion.

Definition at line 127 of file class.ilSystemStyleIcon.php.

                                        : void
    {
        $regex_for_extracting_color = '/((?<=#)[\dabcdef]{6})|((?<=#)[\dabcdef]{3})/i';
 
        $this->color_set = new ilSystemStyleIconColorSet();
        if ($this->getType() == 'svg') {
            $icon_content = file_get_contents($this->getPath());
            $color_matches = [];
            preg_match_all($regex_for_extracting_color, $icon_content, $color_matches);
            if (is_array($color_matches) && is_array($color_matches[0])) {
                foreach ($color_matches[0] as $color_value) {
                    $numeric = strtoupper(str_replace('#', '', $color_value));
                    $color = new ilSystemStyleIconColor('id_' . $numeric, $color_value, $numeric, $color_value);
                    $this->getColorSet()->addColor($color);
                }
            }
        }
    }

References getColorSet(), getPath(), and getType().

Referenced by changeColors(), and getColorSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColorSet()

ilSystemStyleIcon::getColorSet ( )

Definition at line 116 of file class.ilSystemStyleIcon.php.

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

References $color_set, and extractColorSet().

Referenced by extractColorSet(), and usesColor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDirRelToCustomizing()

ilSystemStyleIcon::getDirRelToCustomizing ( )

Only get dir rel to the Customizing dir without name and extension from.

Definition at line 107 of file class.ilSystemStyleIcon.php.

                                            : string
    {
        $path = strstr($this->getPath(), 'global/skin');
        if (!$path) {
            return '';
        }
        return dirname($path);
    }

References $path, and getPath().

Here is the call graph for this function:

◆ getName()

ilSystemStyleIcon::getName ( )

Definition at line 78 of file class.ilSystemStyleIcon.php.

                             : string
    {
        return $this->name;
    }

References $name.

Referenced by __toString(), and ilSystemStyleIconsGUI\renderIconPreview().

Here is the caller graph for this function:

◆ getPath()

ilSystemStyleIcon::getPath ( )

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

                             : string
    {
        return $this->path;
    }

References $path.

Referenced by changeColors(), extractColorSet(), getDirRelToCustomizing(), and ilSystemStyleIconsGUI\renderIconPreview().

Here is the caller graph for this function:

◆ getType()

ilSystemStyleIcon::getType ( )

Definition at line 68 of file class.ilSystemStyleIcon.php.

                             : string
    {
        return $this->type;
    }

References $type.

Referenced by changeColors(), and extractColorSet().

Here is the caller graph for this function:

◆ setColorSet()

ilSystemStyleIcon::setColorSet ( ilSystemStyleIconColorSet $color_set )

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

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

References $color_set.

◆ setName()

ilSystemStyleIcon::setName ( string $name )

Definition at line 83 of file class.ilSystemStyleIcon.php.

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

References $name.

Referenced by __construct().

Here is the caller graph for this function:

◆ setPath()

ilSystemStyleIcon::setPath ( string $path )

Definition at line 98 of file class.ilSystemStyleIcon.php.

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

References $path.

Referenced by __construct().

Here is the caller graph for this function:

◆ setType()

ilSystemStyleIcon::setType ( string $type )

Definition at line 73 of file class.ilSystemStyleIcon.php.

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

References $type.

Referenced by __construct().

Here is the caller graph for this function:

◆ usesColor()

ilSystemStyleIcon::usesColor ( string $color_id )

Definition at line 151 of file class.ilSystemStyleIcon.php.

                                               : bool
    {
        return $this->getColorSet()->doesColorExist($color_id);
    }

References getColorSet().

Here is the call graph for this function:

Field Documentation

◆ $color_set

ilSystemStyleIconColorSet ilSystemStyleIcon::$color_set

protected

Color set extracted from the icon.

Definition at line 44 of file class.ilSystemStyleIcon.php.

Referenced by getColorSet(), and setColorSet().

◆ $name

string ilSystemStyleIcon::$name = ''

protected

Name of the Icon.

Definition at line 34 of file class.ilSystemStyleIcon.php.

Referenced by getName(), and setName().

◆ $path

string ilSystemStyleIcon::$path = ''

protected

Path to the icon including name and extension.

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

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

◆ $type

string ilSystemStyleIcon::$type = ''

protected

Extension of the icon.

Definition at line 39 of file class.ilSystemStyleIcon.php.

Referenced by getType(), and setType().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ changeColors()

◆ extractColorSet()

◆ getColorSet()

◆ getDirRelToCustomizing()

◆ getName()

◆ getPath()

◆ getType()

◆ setColorSet()

◆ setName()

◆ setPath()

◆ setType()

◆ usesColor()

Field Documentation

◆ $color_set

◆ $name

◆ $path

◆ $type