ilSystemStyleIconColorSet Class Reference

Collaboration diagram for ilSystemStyleIconColorSet:

Public Member Functions
	addColor (ilSystemStyleIconColor $color)
	getColors ()
	setColors (array $colors)
	getColorById (string $id='')
	doesColorExist (string $id)
	mergeColorSet (ilSystemStyleIconColorSet $color_set)
	Merges an other colorset into this one. More...
	getColorsSortedAsArray ()
	Orders and sorts the colors to be displayed in GUI (form) More...
	asArray ()
	Returns the ids of the colors of this color set as array. More...
	asString ()
	Returns the ids of the colors of this color set as string. More...

Protected Attributes
array	$colors = []

Detailed Description

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

Member Function Documentation

addColor()

ilSystemStyleIconColorSet::addColor

(

ilSystemStyleIconColor

$color

)

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

References ilSystemStyleIconColor\getId().

Referenced by mergeColorSet().

                                                           : void
    {
        $this->colors[$color->getId()] = $color;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

asArray()

ilSystemStyleIconColorSet::asArray

(

)

Returns the ids of the colors of this color set as array.

Definition at line 104 of file class.ilSystemStyleIconColorSet.php.

References $colors, and getColors().

                             : array
    {
        $colors = [];
        foreach ($this->getColors() as $color) {
            $colors[] = $color->getId();
        }
        return $colors;
    }

Here is the call graph for this function:

asString()

ilSystemStyleIconColorSet::asString

(

)

Returns the ids of the colors of this color set as string.

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

References $colors, and getColors().

                              : string
    {
        $colors = '';
        foreach ($this->getColors() as $color) {
            $colors .= $color->getId() . '; ';
        }
        return $colors;
    }

Here is the call graph for this function:

doesColorExist()

ilSystemStyleIconColorSet::doesColorExist

(

string

$id

)

Definition at line 66 of file class.ilSystemStyleIconColorSet.php.

Referenced by mergeColorSet().

                                              : bool
    {
        return array_key_exists($id, $this->colors);
    }

Here is the caller graph for this function:

getColorById()

ilSystemStyleIconColorSet::getColorById

(

string

$id = ''

)

Exceptions

ilSystemStyleException

Definition at line 58 of file class.ilSystemStyleIconColorSet.php.

References $id, and ilSystemStyleException\INVALID_ID.

                                                 : ilSystemStyleIconColor
    {
        if (!array_key_exists($id, $this->colors)) {
            throw new ilSystemStyleException(ilSystemStyleException::INVALID_ID, $id);
        }
        return $this->colors[$id];
    }

getColors()

ilSystemStyleIconColorSet::getColors

(

)

Returns

ilSystemStyleIconColor[]

Definition at line 42 of file class.ilSystemStyleIconColorSet.php.

References $colors.

Referenced by asArray(), asString(), getColorsSortedAsArray(), and mergeColorSet().

                               : array
    {
        return $this->colors;
    }

Here is the caller graph for this function:

getColorsSortedAsArray()

ilSystemStyleIconColorSet::getColorsSortedAsArray

(

)

Orders and sorts the colors to be displayed in GUI (form)

Returns

array [CategoryOfColor][color]

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

References getColors().

                                            : array
    {
        $colors_categories = [];
        foreach ($this->getColors() as $color) {
            $colors_categories[$color->getDominatAspect()][] = $color;
        }
        ksort($colors_categories);
        foreach ($colors_categories as $category => $colors) {
            usort($colors_categories[$category], ['ilSystemStyleIconColor','compareColors']);
        }

        return $colors_categories;
    }

Here is the call graph for this function:

mergeColorSet()

ilSystemStyleIconColorSet::mergeColorSet

(

ilSystemStyleIconColorSet

$color_set

)

Merges an other colorset into this one.

Definition at line 74 of file class.ilSystemStyleIconColorSet.php.

References addColor(), doesColorExist(), and getColors().

                                                                       : void
    {
        foreach ($color_set->getColors() as $color) {
            if (!$this->doesColorExist($color->getId())) {
                $this->addColor($color);
            }
        }
    }

Here is the call graph for this function:

setColors()

ilSystemStyleIconColorSet::setColors

(

array

$colors

)

Parameters

ilSystemStyleIconColor[]

$colors

Definition at line 50 of file class.ilSystemStyleIconColorSet.php.

References $colors.

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

Field Documentation

$colors

array ilSystemStyleIconColorSet::$colors = []

protected

Definition at line 31 of file class.ilSystemStyleIconColorSet.php.

Referenced by asArray(), asString(), getColors(), and setColors().

---

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

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