intellexapps/color

2.0.0 2023-12-19 13:57 UTC

Requires

• php: >=7.4

Requires (Dev)

• phpstan/phpstan: ^1.4
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.8

MIT

• Ivan Sabo

• php
• css
• parsing
• color
• rgb
• cmyk
• rgba
• intellex

README

Color manipulation for PHP

• Supports RGB(A) and CMY(K), with super easy conversion.
• Modify initialized color using the available setters.
• Output colors to any format, including every CSS one.
• Ability to parse colors from any standard and CSS notation.
• Extend parsing with your own custom parsers.
• Predefined list of 142 named web colors.
• No additional 3rd party scripts.

Predefined colors

The list of all 142 standardized HTML colors defined in Predefined\RGBA class:

$chocolateColor = RGBA::Chocolate();
$mistyRoseColor = RGBA::MistyRose();
$navyColor = RGBA::Navy();

A couple of examples

From hex to CSS:

$color = ColorParser::parse('#781190');
echo $color->toCSS();

From CSS to GD color:

$color = ColorParser::parse('rgb(80, 138, 99);');
$image = imageCreateTrueColor(200, 200);
$gdColor = $color->getRGBA()->toImageColorIdentifier($image)

From CMYK to RGBA:

$color = ColorParser::parse('cmyk(20%, 40%, 60%, 20%');
echo $color->getRGBA()->toHexString();

Conversion

When initialize a color will either be RGBA or CMYK. This can be done manually, or by parsing the string.

Note that some parameters (ie. alpha channel in RGBA), will simply be ignored during conversion.

Any color can be cast to another one:

$rgba = new RGBA(190, 11, 32, 0.65);
$cmyk = $rgba->getCMYK(); 

Example with a parser.

$rgba = ColorParser::parse($input)->getRGBA(); 

Output

Options available for RGBA:

$rgba->toImageColorIdentifier($image);
$rgba->toHexString($includeAlpha, $includeHashTag, $uppercase);
$rgba->toCSS();
$rgba->getCMYK();

Options available for CMYK:

$cmyk->toCSS;
$cmyk->getRGBA;

Parsing a color

Use ColorParser::parse($input), which will try every registered parser.

If no parser is able to handle it, ColorCannotBeParsed will be thrown.

Default parsers support most (if not all) RGBA and CMYK formats, but you can create you custom parsers for your specific need.

Supported out of the box:

• CMYK from array [C, M, Y] and [C, M, Y, K]
• RGB(A) from array [R, G, B] and [R, G, B, A]
• RGB(A) from string:
  • RGB
  • ARGB
  • RRGGBB
  • AARRGGBB
  • #RGB
  • #ARGB
  • #RRGGBB
  • #AARRGGBB
• CSS
  • cmyk(c%, m%, y%) and cmyk(c%, m%, y%, k%)
  • rgb(r, b, g) and rgb(r, b, g, a)

Custom parsers

Create and register a new parsers, that will ba included in the next parsing:

1. Create a class and implement AbstractColorParser interface.
2. When implementing method parse($input)
   • if input cannot be parsed -> throw ColorCannotBeParsed
   • if input can be parsed return the Color
3. Register the parser with ColorParser::registerParser(AbstractColorParser $parser).
4. Next time the ColorParser::parse() is called, your parser will be considered as well.

TODO

1. Support for HSV.
2. Detect color name by finding the most similar color in the predefined list.

Credits

Script has been written by the Intellex team.