PEAR Manual
Prev |  | Next

# Image_Text::setColors()

Image_Text::setColors() -- Set the color-set

## Synopsis

    require_once 'ImageText.php';

``bool Image_Text::setColors` (mixed $colors)`

## Description

Using this method you can set multiple colors for your text. Use a simple numeric array to determine their order and give it to this function. Multiple colors will be cycled by the options specified 'color_mode' option. The given array will overwrite the existing color settings!

The following colors syntaxes are understood by this method:

- "#ffff00" hexadecimal format (HTML style), with and without #.

- "#08ffff00" hexadecimal format (HTML style) with alpha channel (08), with and without #.

- array with 'r','g','b' and (optionally) 'a' keys, using int values.

- a GD color special color (tiled,...).

A single color or an array of colors are allowed here.

## Parameter

mixed `$colors`

  Single color or array of colors.

## Return value

returns True on success, otherwise PEAR::Error.

## Throws

throws no exceptions thrown

## See

see Image_Text::setColor(), Image_Text::set()

## Note

This function can not be called statically.

Prev | Home | Next
Image_Text::setColor() | Up | Package Image_Text Constants