ilSystemStyleIconColorSet Class Reference

Collaboration diagram for ilSystemStyleIconColorSet:

Public Member Functions
	addColor (ilSystemStyleIconColor $color)
	getColors ()
	setColors (array $colors)
	getColorById ($id="")
	doesColorExist ($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
	$colors = []

Detailed Description

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

Member Function Documentation

addColor()

ilSystemStyleIconColorSet::addColor

(

ilSystemStyleIconColor

$color

)

Parameters

ilSystemStyleIconColor

$color

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

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

References ilSystemStyleIconColor\getId().

Referenced by mergeColorSet().

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.

Returns

array [color_id]

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

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

References $colors, and getColors().

Here is the call graph for this function:

asString()

ilSystemStyleIconColorSet::asString

(

)

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

Returns

array

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

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

References $colors, and getColors().

Here is the call graph for this function:

doesColorExist()

ilSystemStyleIconColorSet::doesColorExist

(

$id

)

Parameters

string

$id

Returns

bool

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

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

References $id.

Referenced by mergeColorSet().

Here is the caller graph for this function:

getColorById()

ilSystemStyleIconColorSet::getColorById

(

$id = ""

)

Parameters

string

$id

Returns

ilSystemStyleIconColor

Exceptions

ilSystemStyleException

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

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

References $id, and ilSystemStyleException\INVALID_ID.

getColors()

ilSystemStyleIconColorSet::getColors

(

)

Returns

ilSystemStyleIconColor[]

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

    {
        return $this->colors;
    }

References $colors.

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

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 85 of file class.ilSystemStyleIconColorSet.php.

    {
        $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], array("ilSystemStyleIconColor","compareColors"));
        }
 
        return $colors_categories;
    }

References $colors, and getColors().

Here is the call graph for this function:

mergeColorSet()

ilSystemStyleIconColorSet::mergeColorSet

(

ilSystemStyleIconColorSet

$color_set

)

Merges an other colorset into this one.

Parameters

ilSystemStyleIconColorSet

$color_set

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

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

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

Here is the call graph for this function:

setColors()

ilSystemStyleIconColorSet::setColors

(

array

$colors

)

Parameters

ilSystemStyleIconColor[]

$colors

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

    {
        $this->colors = $colors;
    }

References $colors.

Field Documentation

$colors

ilSystemStyleIconColorSet::$colors = []

protected

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

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

---

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

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