Collaboration diagram for ilSystemStyleIconColor:

Public Member Functions
	__construct (string $id, string $name, string $color, string $description='')
	ilSystemStyleIconColor constructor. More...

	getId ()

	setId (string $id)

	getColor ()

	setColor (string $color)

	getName ()

	setName (string $name)

	getDescription ()

	setDescription (string $description)

	getDominatAspect ()
	Used to order the colors according to their dominant aspect. More...

	getRedAspect ()
	Get red aspect from a color in hex format. More...

	getGreenAspect ()
	Get green aspect from a color in hex format. More...

	getBlueAspect ()
	Get blue aspect from a color in hex format. More...

	getPerceivedBrightness ()
	Used to sort the colors according to their brightness. More...

Static Public Member Functions
static	compareColors (ilSystemStyleIconColor $color1, ilSystemStyleIconColor $color2)
	Used to sort colors according to their brightness. More...

Data Fields
const	GREY = 0

const	RED = 1

const	GREEN = 2

const	BLUE = 3

Protected Attributes
string	$id = ''
	Unique ID to identify the color by (currently same as color) More...

string	$color = ''
	Value of the color. More...

string	$name = ''
	Name of the color in text. More...

string	$description = ''
	Description of the color. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleIconColor::__construct	(	string	$id,
		string	$name,
		string	$color,
		string	$description = `''`
	)

ilSystemStyleIconColor constructor.

Definition at line 54 of file class.ilSystemStyleIconColor.php.

    {
        $this->setId($id);
        $this->setColor($color);
        $this->setName($name);
        $this->setDescription($description);
    }

References setColor(), setDescription(), setId(), and setName().

Here is the call graph for this function:

Member Function Documentation

◆ compareColors()

static ilSystemStyleIconColor::compareColors	(	ilSystemStyleIconColor	$color1,
		ilSystemStyleIconColor	$color2
	)

static

Used to sort colors according to their brightness.

Definition at line 177 of file class.ilSystemStyleIconColor.php.

                                                                                                        : int
    {
        $value1 = $color1->getPerceivedBrightness();
        $value2 = $color2->getPerceivedBrightness();
 
        if ($value1 == $value2) {
            return 0;
        }
        return ($value1 > $value2) ? +1 : -1;
    }

References getPerceivedBrightness().

Referenced by ilSystemStyleIconColorTest\testCompareColors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBlueAspect()

ilSystemStyleIconColor::getBlueAspect ( )

Get blue aspect from a color in hex format.

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

                                   : int
    {
        return hexdec(substr($this->getColor(), 4, 2));
    }

References getColor().

Referenced by getDominatAspect(), and getPerceivedBrightness().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColor()

ilSystemStyleIconColor::getColor ( )

Definition at line 72 of file class.ilSystemStyleIconColor.php.

                              : string
    {
        return $this->color;
    }

References $color.

Referenced by getBlueAspect(), getGreenAspect(), and getRedAspect().

Here is the caller graph for this function:

◆ getDescription()

ilSystemStyleIconColor::getDescription ( )

Definition at line 101 of file class.ilSystemStyleIconColor.php.

                                    : string
    {
        return $this->description;
    }

References $description.

◆ getDominatAspect()

ilSystemStyleIconColor::getDominatAspect ( )

Used to order the colors according to their dominant aspect.

Due to the vast numbers of colors to be displayed to the user, they must be ordered in some fashion, dominant aspect and brightness are possible values.

Definition at line 115 of file class.ilSystemStyleIconColor.php.

                                      : int
    {
        $r = $this->getRedAspect();
        $g = $this->getGreenAspect();
        $b = $this->getBlueAspect();
 
        if ($r == $g && $r == $b && $g == $b) {
            return self::GREY;
        } elseif ($r > $g && $r > $b) {
            return self::RED;
        } elseif ($g > $r && $g > $b) {
            return self::GREEN;
        } else {
            return self::BLUE;
        }
    }

References Vendor\Package\$b, BLUE, getBlueAspect(), getGreenAspect(), getRedAspect(), GREEN, GREY, and RED.

Here is the call graph for this function:

◆ getGreenAspect()

ilSystemStyleIconColor::getGreenAspect ( )

Get green aspect from a color in hex format.

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

                                    : int
    {
        return hexdec(substr($this->getColor(), 2, 2));
    }

References getColor().

Referenced by getDominatAspect(), and getPerceivedBrightness().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilSystemStyleIconColor::getId ( )

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

                           : string
    {
        return $this->id;
    }

References $id.

Referenced by ilSystemStyleIconColorSet\addColor().

Here is the caller graph for this function:

◆ getName()

ilSystemStyleIconColor::getName ( )

Definition at line 91 of file class.ilSystemStyleIconColor.php.

                             : string
    {
        return $this->name;
    }

References $name.

◆ getPerceivedBrightness()

ilSystemStyleIconColor::getPerceivedBrightness ( )

Used to sort the colors according to their brightness.

Due to the vast numbers of colors to be displayed to the user, they must be ordered in some fashion, dominant aspect and brightness are possible values. See: https://en.wikipedia.org/wiki/YIQ

Definition at line 161 of file class.ilSystemStyleIconColor.php.

                                            : float
    {
        $r = $this->getRedAspect();
        $g = $this->getGreenAspect();
        $b = $this->getBlueAspect();
 
        return sqrt(
            $r * $r * .299 +
            $g * $g * .587 +
            $b * $b * .114
        );
    }

References Vendor\Package\$b, getBlueAspect(), getGreenAspect(), and getRedAspect().

Referenced by compareColors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRedAspect()

ilSystemStyleIconColor::getRedAspect ( )

Get red aspect from a color in hex format.

Definition at line 135 of file class.ilSystemStyleIconColor.php.

                                  : int
    {
        return hexdec(substr($this->getColor(), 0, 2));
    }

References getColor().

Referenced by getDominatAspect(), and getPerceivedBrightness().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColor()

ilSystemStyleIconColor::setColor ( string $color )

Exceptions

ilSystemStyleColorException

Definition at line 80 of file class.ilSystemStyleIconColor.php.

                                           : void
    {
        $color = strtoupper($color);
 
        if (!ctype_xdigit($color) || (strlen($color) != 6 && strlen($color) != 3)) {
            throw new ilSystemStyleColorException(ilSystemStyleColorException::INVALID_COLOR_EXCEPTION, $color);
        }
 
        $this->color = $color;
    }

References $color, and ilSystemStyleColorException\INVALID_COLOR_EXCEPTION.

Referenced by __construct().

Here is the caller graph for this function:

◆ setDescription()

ilSystemStyleIconColor::setDescription ( string $description )

Definition at line 106 of file class.ilSystemStyleIconColor.php.

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

References $description.

Referenced by __construct().

Here is the caller graph for this function:

◆ setId()

ilSystemStyleIconColor::setId ( string $id )

Definition at line 67 of file class.ilSystemStyleIconColor.php.

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

References $id.

Referenced by __construct().

Here is the caller graph for this function:

◆ setName()

ilSystemStyleIconColor::setName ( string $name )

Definition at line 96 of file class.ilSystemStyleIconColor.php.

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

References $name.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $color

string ilSystemStyleIconColor::$color = ''

protected

Value of the color.

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

Referenced by getColor(), and setColor().

◆ $description

string ilSystemStyleIconColor::$description = ''

protected

Description of the color.

Definition at line 49 of file class.ilSystemStyleIconColor.php.

Referenced by getDescription(), and setDescription().

◆ $id

string ilSystemStyleIconColor::$id = ''

protected

Unique ID to identify the color by (currently same as color)

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

Referenced by getId(), and setId().

◆ $name

string ilSystemStyleIconColor::$name = ''

protected

Name of the color in text.

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

Referenced by getName(), and setName().

◆ BLUE

const ilSystemStyleIconColor::BLUE = 3

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

Referenced by getDominatAspect(), ilSystemStyleIconColorSetTest\testGetColorsSortedAsArray(), and ilSystemStyleIconColorTest\testGetDominantAspect().

◆ GREEN

const ilSystemStyleIconColor::GREEN = 2

Definition at line 28 of file class.ilSystemStyleIconColor.php.

Referenced by getDominatAspect(), ilSystemStyleIconColorSetTest\testGetColorsSortedAsArray(), and ilSystemStyleIconColorTest\testGetDominantAspect().

◆ GREY

const ilSystemStyleIconColor::GREY = 0

Definition at line 26 of file class.ilSystemStyleIconColor.php.

Referenced by getDominatAspect(), ilSystemStyleIconColorSetTest\testGetColorsSortedAsArray(), and ilSystemStyleIconColorTest\testGetDominantAspect().

◆ RED

const ilSystemStyleIconColor::RED = 1

Definition at line 27 of file class.ilSystemStyleIconColor.php.

Referenced by getDominatAspect(), ilSystemStyleIconColorSetTest\testGetColorsSortedAsArray(), and ilSystemStyleIconColorTest\testGetDominantAspect().

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ compareColors()

◆ getBlueAspect()

◆ getColor()

◆ getDescription()

◆ getDominatAspect()

◆ getGreenAspect()

◆ getId()

◆ getName()

◆ getPerceivedBrightness()

◆ getRedAspect()

◆ setColor()

◆ setDescription()

◆ setId()

◆ setName()

Field Documentation

◆ $color

◆ $description

◆ $id

◆ $name

◆ BLUE

◆ GREEN

◆ GREY

◆ RED