Collaboration diagram for ilSystemStyleIconColor:

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

	getId ()

	setId ($id)

	getColor ()

	setColor ($color)

	getName ()

	setName ($name)

	getDescription ()

	setDescription ($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
	$id = ""

	$color = ""

	$name = ""

	$description = ""

	$brightness = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

ilSystemStyleIconColor constructor.

Parameters

$id
$name
$color
$description

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

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

References $color, $description, $id, $name, 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.

Parameters

ilSystemStyleIconColor	$color1
ilSystemStyleIconColor	$color2

Returns: int

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

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

Returns: number

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

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

Returns: string

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

    {
        return $this->color;
    }

References $color.

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

Here is the caller graph for this function:

◆ getDescription()

ilSystemStyleIconColor::getDescription ( )

Returns: string

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

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

Returns: int

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

    {
        $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 $r, 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.

Returns: number

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

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

Returns: string

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

    {
        return $this->id;
    }

References $id.

Referenced by ilSystemStyleIconColorSet\addColor().

Here is the caller graph for this function:

◆ getName()

ilSystemStyleIconColor::getName ( )

Returns: string

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

    {
        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

Returns: float|null

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

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

References $brightness, $r, 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.

Returns: number

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

    {
        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 ( $color )

Parameters

$color

Exceptions

ilSystemStyleColorException

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

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

References $color, color, and ilSystemStyleColorException\INVALID_COLOR_EXCEPTION.

Referenced by __construct().

Here is the caller graph for this function:

◆ setDescription()

ilSystemStyleIconColor::setDescription ( $description )

Parameters

string $description

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

    {
        $this->description = $description;
    }

References $description.

Referenced by __construct().

Here is the caller graph for this function:

◆ setId()

ilSystemStyleIconColor::setId ( $id )

Parameters

string $id

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

    {
        $this->id = $id;
    }

References $id.

Referenced by __construct().

Here is the caller graph for this function:

◆ setName()

ilSystemStyleIconColor::setName ( $name )

Parameters

string $name

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

    {
        $this->name = $name;
    }

References $name.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $brightness

ilSystemStyleIconColor::$brightness = null

protected

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

Referenced by getPerceivedBrightness().

◆ $color

ilSystemStyleIconColor::$color = ""

protected

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

Referenced by __construct(), getColor(), and setColor().

◆ $description

ilSystemStyleIconColor::$description = ""

protected

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

Referenced by __construct(), getDescription(), and setDescription().

◆ $id

ilSystemStyleIconColor::$id = ""

protected

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

Referenced by __construct(), getId(), and setId().

◆ $name

ilSystemStyleIconColor::$name = ""

protected

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

Referenced by __construct(), getName(), and setName().

◆ BLUE

const ilSystemStyleIconColor::BLUE = 3

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

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

◆ GREEN

const ilSystemStyleIconColor::GREEN = 2

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

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

◆ GREY

const ilSystemStyleIconColor::GREY = 0

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

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

◆ RED

const ilSystemStyleIconColor::RED = 1

Definition at line 14 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

◆ $brightness

◆ $color

◆ $description

◆ $id

◆ $name

◆ BLUE

◆ GREEN

◆ GREY

◆ RED