Securimage_Color Class Reference

Collaboration diagram for Securimage_Color:

Public Member Functions
	__construct ($color='#ffffff')
	Create a new Securimage_Color object. More...

Data Fields
	$r
	$g
	$b

Protected Member Functions
	constructRGB ($red, $green, $blue)
	Construct from an rgb triplet. More...
	constructHTML ($color)
	Construct from an html hex color code. More...

Detailed Description

Definition at line 2197 of file securimage.php.

Constructor & Destructor Documentation

__construct()

Securimage_Color::__construct

(

$color = '#ffffff'

)

Create a new Securimage_Color object.

Constructor expects 1 or 3 arguments.
When passing a single argument, specify the color using HTML hex format,
when passing 3 arguments, specify each RGB component (from 0-255) individually.
$color = new Securimage_Color('#0080FF') or
$color = new Securimage_Color(0, 128, 255)

Parameters

string

$color

Exceptions

Exception

Definition at line 2214 of file securimage.php.

    {
        $args = func_get_args();

        if (sizeof($args) == 0) {
            $this->r = 255;
            $this->g = 255;
            $this->b = 255;
        } elseif (sizeof($args) == 1) {
            // set based on html code
            if (substr($color, 0, 1) == '#') {
                $color = substr($color, 1);
            }

            if (strlen($color) != 3 && strlen($color) != 6) {
                throw new InvalidArgumentException(
                    'Invalid HTML color code passed to Securimage_Color'
                );
            }

            $this->constructHTML($color);
        } elseif (sizeof($args) == 3) {
            $this->constructRGB($args[0], $args[1], $args[2]);
        } else {
            throw new InvalidArgumentException(
                'Securimage_Color constructor expects 0, 1 or 3 arguments; ' . sizeof($args) . ' given'
            );
        }
    }

Member Function Documentation

constructHTML()

Securimage_Color::constructHTML (   $color )

protected

Construct from an html hex color code.

Parameters

string

$color

Definition at line 2280 of file securimage.php.

References $blue, $green, and $red.

    {
        if (strlen($color) == 3) {
            $red = str_repeat(substr($color, 0, 1), 2);
            $green = str_repeat(substr($color, 1, 1), 2);
            $blue = str_repeat(substr($color, 2, 1), 2);
        } else {
            $red = substr($color, 0, 2);
            $green = substr($color, 2, 2);
            $blue = substr($color, 4, 2);
        }

        $this->r = hexdec($red);
        $this->g = hexdec($green);
        $this->b = hexdec($blue);
    }

constructRGB()

Securimage_Color::constructRGB (   $red,   $green,   $blue  )

protected

Construct from an rgb triplet.

Parameters

int	$red	The red component, 0-255
int	$green	The green component, 0-255
int	$blue	The blue component, 0-255

Definition at line 2250 of file securimage.php.

References $blue, $green, and $red.

    {
        if ($red < 0) {
            $red = 0;
        }
        if ($red > 255) {
            $red = 255;
        }
        if ($green < 0) {
            $green = 0;
        }
        if ($green > 255) {
            $green = 255;
        }
        if ($blue < 0) {
            $blue = 0;
        }
        if ($blue > 255) {
            $blue = 255;
        }

        $this->r = $red;
        $this->g = $green;
        $this->b = $blue;
    }

Field Documentation

$b

Securimage_Color::$b

Definition at line 2201 of file securimage.php.

$g

Securimage_Color::$g

Definition at line 2200 of file securimage.php.

$r

Securimage_Color::$r

Definition at line 2199 of file securimage.php.

---

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

• Services/Captcha/lib/securimage_3_5_1/securimage.php