Download the PHP package fyre/color without Composer
On this page you can find all versions of the php package fyre/color. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package color
FyreColor
FyreColor is a free, open-source immutable color manipulation library for PHP.
It is a modern library, and features full support for RGB, HSL, HSV, CMY and CMYK color-spaces.
Table Of Contents
- Installation
- Basic Usage
- Color Creation
- Color Formatting
- Color Attributes
- Color Manipulation
- Color Schemes
- Color Palettes
- Static Methods
Installation
Using Composer
In PHP:
Basic Usage
From RGB
$red
is a number between 0 and 255.$green
is a number between 0 and 255.$blue
is a number between 0 and 255.$alpha
is a number between 0 and 1, and will default to 1.
From Brightness
$brightness
is a number between 0 and 100.$alpha
is a number between 0 and 1, and will default to 1.
Color Creation
From String
Create a new Color from a HTML color string.
$colorString
is a string containing a color value in either hexadecimal, RGB, RGBA, HSL, HSLA or a standard HTML color name.
From CMY
Create a new Color from CMY values.
$cyan
is a number between 0 and 100.$magenta
is a number between 0 and 100.$yellow
is a number between 0 and 100.$alpha
is a number between 0 and 1, and will default to 1.
From CMYK
Create a new Color from CMYK values.
$cyan
is a number between 0 and 100.$magenta
is a number between 0 and 100.$yellow
is a number between 0 and 100.$key
is a number between 0 and 100.$alpha
is a number between 0 and 1, and will default to 1.
From HSL
Create a new Color from HSL values.
$hue
is a number between 0 and 360.$saturation
is a number between 0 and 100.$lightness
is a number between 0 and 100.$alpha
is a number between 0 and 1, and will default to 1.
From HSV
Create a new Color from HSV values.
$hue
is a number between 0 and 360.$saturation
is a number between 0 and 100.$value
is a number between 0 and 100.$alpha
is a number between 0 and 1, and will default to 1.
Color Formatting
To String
Get a HTML string representation of the color.
The $colorString
returned will be a string containing either a HTML color name (if one exists), a hexadecimal string (if alpha is 1) or an RGBA string.
To Hex String
Get a hexadecimal string representation of the color.
To RGB String
Get a RGB/RGBA string representation of the color.
To HSL String
Get a HSL/HSLA string representation of the color.
Label
Get the closest color name for the color.
Color Attributes
Get Alpha
Get the alpha value of the color (between 0 and 1).
Get Brightness
Get the brightness value of the color (between 0 and 100).
Get Hue
Get the hue value of the color (between 0 and 360).
Get Saturation
Get the saturation value of the color (between 0 and 100).
Luma
Get the relative luminance value of the color (between 0 and 1).
Set Alpha
Set the alpha value of the color.
$alpha
is a number between 0 and 1.
Set Brightness
Set the brightness value of the color.
$brightness
is a number between 0 and 100.
Set Hue
Set the hue value of the color.
$hue
is a number between 0 and 360.
Set Saturation
Set the saturation value of the color.
$saturation
is a number between 0 and 100.
Color Manipulation
Darken
Darken the color by a specified amount.
$amount
is a number between 0 and 1.
Invert
Invert the color.
Lighten
Lighten the color by a specified amount.
$amount
is a number between 0 and 1.
Shade
Shade the color by a specified amount.
$amount
is a number between 0 and 1.
Tint
Tint the color by a specified amount.
$amount
is a number between 0 and 1.
Tone
Tone the color by a specified amount.
$amount
is a number between 0 and 1.
Color Schemes
Complementary
Create a complementary color variation.
Split
Create an array with 2 split color variations.
Analogous
Create an array with 2 analogous color variations.
Triadic
Create an array with 2 triadic color variations.
Tetradic
Create an array with 3 tetradic color variations.
Color Palettes
Create a palette of colors from a Color object you have created using the following methods.
Shades
Create an array with a specified number of shade variations.
$shades
is a number indicating how many shades you wish to generate, and will default to 10.
Tints
Create an array with a specified number of tint variations.
$tints
is a number indicating how many tints you wish to generate, and will default to 10.
Tones
Create an array with a specified number of tone variations.
$tones
is a number indicating how many tones you wish to generate, and will default to 10.
Palette
Create a palette object with a specified number of shades, tints and tone variations.
$shades
is a number indicating how many shades you wish to generate, and will default to 10.$tints
is a number indicating how many tints you wish to generate, and will default to 10.$tones
is a number indicating how many tones you wish to generate, and will default to 10.
Static Methods
Contrast
Calculate the contrast between two colors (between 1 and 21).
$color1
is a Color object.$color2
is a Color object.
Distance
Calculate the distance between two colors.
$color1
is a Color object.$color2
is a Color object.
Find Contrast
Find an optimally contrasting color for another color.
$color1
is a Color object.$color2
is a Color object, and will default to null.$minContrast
is a number between 1 and 21 indicating the minimum valid contrast, and will default to 4.5.$stepSize
is a number between 0 and 1 indicating the amount to darken/lighten the color on each iteration, and will default to 0.01.
If $color2
value is null, $color1
will be used instead.
This method will tint/shade $color2
until it meets a minimum contrast threshold with $color1
, then the new color will be returned. If no valid contrast value can be found, this method will return null instead.
Mix
Create a new Color by mixing two colors together by a specified amount.
$color1
is a Color object.$color2
is a Color object.$amount
is a number between 0 and 1.
Multiply
Create a new Color by multiplying two colors together by a specified amount.
$color1
is a Color object.$color2
is a Color object.$amount
is a number between 0 and 1.