Color Class Reference

Collaboration diagram for Color:

Static Public Member Functions
static	hex2array ($color)
static	rgba2array ($color)
static	rgb2array ($color)
static	hsl2array ($color)
static	mix ($color1, $color2, $percentOfColor1=50, $f=null)
static	opacity ($color, $opacity)
static	brighten ($color, $factor=35)
static	rgba ($color)
static	rgb ($color)
static	hex ($color)
static	hsl ($color)
static	hsla ($color)

Static Public Attributes
static	$colorstrings

Detailed Description

class to mix colors and convert them between different types

Since

2.1

Member Function Documentation

static brighten (   $color,   $factor = 35  )

static

Make the passed color brighter

Author

Till Glöggler tgloe.nosp@m.ggl@.nosp@m.uos.d.nosp@m.e

Parameters

string	$color	any type of css-valid color
int	$factor	percentage of brightning, 100 for white and 0 for no changes to color

Returns

string brightened color in same format as the passed one

static hex (   $color )

static

converts a css-hex-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

static hex2array (   $color )

static

converts a css-hex-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

static hsl (   $color )

static

converts a css-hsl-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

static hsl2array (   $color )

static

converts a css-hsl-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

static hsla (   $color )

static

converts a css-hsla-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

static mix (   $color1,   $color2,   $percentOfColor1 = 50,   $f = null  )

static

Mixes two colors by preferring the first one with $percentOfColor1 percent. If color2 is the only color with alpha-chanel, it will return a color in the format of color2 else (most of the time) in the format of color1.

Returns

string: "#ffffff", "rgb(...)", "rgba(...)" depending on color1 and alpha-chanel

static opacity (   $color,   $opacity  )

static

Sets the opacity for a color. Hue and saturation is kept, but opacity is changed. Returns a format with alpha-chanel (rgba or hsla) depending on the given format.

static rgb (   $color )

static

converts a css-rgb-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

static rgb2array (   $color )

static

converts a css-rgb-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

static rgba (   $color )

static

converts a css-rgba-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

static rgba2array (   $color )

static

converts a css-rgba-color into a rgba-quadruple

Parameters

string

$color

the color to be converted

Returns

array colors as rgba-quadruple

Field Documentation

$colorstrings

static

Initial value:

 array(
        'aqua'           => array(0, 255, 255, 1),
        'azure'          => array(240, 255, 255, 1),
        'blue'           => array(0, 0, 255, 1),
        'cyan'           => array(0, 255, 255, 1),
        'darkblue'       => array(0, 0, 139, 1),
        'darkred'        => array(139, 0, 0, 1),
        'gold'           => array(255, 215, 0, 1),
        'gray'           => array(128, 128, 128, 1),
        'indigo'         => array(75, 0, 130, 1),
        'lightsteelblue' => array(176, 196, 222, 1),
        'lightyellow'    => array(255, 255, 224, 1),
        'lime'           => array(0, 255, 0, 1),
        'magenta'        => array(255, 0, 255, 1),
        'navy'           => array(0, 0, 128, 1),
        'olive'          => array(128, 128, 0, 1),
        'orange'         => array(255, 165, 0, 1),
        'pink'           => array(255, 192, 203, 1),
        'red'            => array(255, 0, 0, 1),
        'purple'         => array(128, 0, 128, 1),
        'violet'         => array(238, 130, 238, 1),
        'yellow'         => array(255, 255, 0, 1),
        'black'          => array(0, 0, 0, 1),
        'white'          => array(255, 255, 255, 1)
    )

---

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

• lib/classes/Color.class.php