PHP Color Class An simple colour class for PHP. Note: in documentation the 'colour' spelling is intentional.
Stringable
| Name | Description |
|---|---|
| __construct | Class constructor. |
| __get | get magic method. |
| __set | set magic method. |
| __toString | toString magic method. |
| getArray | Get the red, green and blue values of the colour as an array. |
| getHex | Get the HEX code that represents the colour. |
| hexToRgb | Convert a HEX code into RGB. |
| mix | Mix two colours together. |
| modify | Modify the colour's red, green and blue values. |
| randomise | Randomise red, green and blue values of the colour. |
| range | Calculate and return a range of colours between a start and end colour. |
| rgbToHex | Convert red, green and blue values to a HEX code. |
| set | Set the colour's red, green and blue values // Sets the RGB values. |
| setHex | Set the red, green and blue values of the colour with a HEX code. |
Description
public __construct (int $red, int $green, int $blue)Class constructor. // Constructor to initialize the RGB values. Parameters
(int) $red: [optional] The red value of the colour (between 0 and 255). Default value is 0.*(int) $green: [optional] The green value of the colour (between 0 and 255). Default value is 0.*(int) $blue: [optional] The blue value of the colour (between 0 and 255). Default value is 0. Return Values
void
Description
public __get (string $name)get magic method. // Magic getter for accessing RGB or HEX properties. Parameters
(string) $name: The name of the variable to get. Return Values
mixed
Returns the value of the requested variable.
Description
public __set (string $name, mixed $value)set magic method. // Magic setter for setting RGB or HEX properties. Parameters
(string) $name: The name of the variable to set.*(mixed) $value: The value to set the variable to. Return Values
void
Description
public __toString (void)toString magic method. // Magic method to convert the object to a string, returning the HEX value with a hash. Parameters
This function has no parameters.
Return Values
string
Returns the HEX code that represents the colour.
Description
public getArray (void)Get the red, green and blue values of the colour as an array. Returns the RGB values as an array. Parameters
This function has no parameters.
Return Values
array
Returns an associative array of values. The array will have 'red', 'green' and 'blue' keys.
Description
public getHex (bool $hash)Get the HEX code that represents the colour. // Returns the HEX value of the color. Optionally includes the hash (#). Parameters
(bool) $hash: Whether to prepend the HEX code with a '#' character. Default value is FALSE. Return Values
string
Returns the HEX code.
Description
public static hexToRgb (string $hex)Convert a HEX code into RGB.
Parameters
(string) $hex: The HEX code to convert. Return Values
array
Returns an associative array of values. The array will have 'red', 'green' and 'blue' keys.
Description
public static mix (\Color|string $color1, \Color|string $color2)Mix two colours together. Mixes two colors and returns the resulting color. Parameters
(\Color|string) $color1: The first colour. This can be a Color object or a HEX code as a string.*(\Color|string) $color2: The second colour. This can be a Color object or a HEX code as a string. Return Values
\Color
Returns the result of the mix as a new Color object.
Description
public modify (int $red, int $green, int $blue)Modify the colour's red, green and blue values. // Modifies the RGB values by adding the provided values to the existing ones. Parameters
(int) $red: [optional] The amount to modify the red value of the colour (between -255 and 255). Default value is 0.*(int) $green: [optional] The amount to modify the green value of the colour (between -255 and 255). Default value is 0.*(int) $blue: [optional] The amount to modify the blue value of the colour (between -255 and 255). Default value is 0. Return Values
void
Description
public randomise (void)Randomise red, green and blue values of the colour. // Randomizes the RGB values. Parameters
This function has no parameters.
Return Values
void
Description
public static range (\Color|string $start, \Color|string $end, int $steps)Calculate and return a range of colours between a start and end colour. Generates a gradient of colors between two colors over a defined number of steps. Parameters
(\Color|string) $start: The start colour. This can be a Color object or a HEX code as a string.*(\Color|string) $end: The end colour. This can be a Color object or a HEX code as a string.*(int) $steps: The number of colours to return (including start and end colours). Return Values
mixed
Returns an array of Color objects.
Description
public static rgbToHex (mixed $red, mixed $green, mixed $blue)Convert red, green and blue values to a HEX code.
Parameters
(mixed) $red: The red value of the colour (between 0 and 255).*(mixed) $green: The green value of the colour (between 0 and 255).*(mixed) $blue: The blue value of the colour (between 0 and 255). Return Values
string
Returns the HEX code representing the values given.
Description
public set (int $red, int $green, int $blue)Set the colour's red, green and blue values // Sets the RGB values.
Parameters
(int) $red: [optional] The red value of the colour (between 0 and 255). Default value is 0.*(int) $green: [optional] The green value of the colour (between 0 and 255). Default value is 0.*(int) $blue: [optional] The blue value of the colour (between 0 and 255). Default value is 0. Return Values
void
Description
public setHex (string $hex)Set the red, green and blue values of the colour with a HEX code. // Sets the RGB values from a HEX color code. Parameters
(string) $hex: The HEX code to set. This must be 3 or 6 characters in length and can optionally start with a '#'. Return Values
bool
Returns TRUE on success.