mscharley/colourist

This package is abandoned and no longer maintained. No replacement package was suggested.

Colour manipulation library

1.1.2 2016-04-07 04:43 UTC

Requires

• php: >= 5.6
• ext-bcmath: *
• respect/validation: ~1.0

Requires (Dev)

• codeclimate/php-test-reporter: dev-master
• indeyets/pake: ~1.99
• phpmd/phpmd: @stable
• phpunit/phpunit: ~4.0
• psy/psysh: @stable
• squizlabs/php_codesniffer: @stable
• steos/php-quickcheck: dev-master

MIT

• Matthew Scharley

README

Source: https://github.com/mscharley/colourist
Author: Matthew Scharley
Contributors: See contributors on GitHub
Bugs/Support: Github Issues
Copyright: 2015
License: MIT license
Status: Active

Synopsis

colourist is a small library for PHP 5.6+ that helps ease working with colours and colour transformations.

Installation

$ composer require mscharley/colourist

Usage

$colour = \Colourist\Colour::fromHex('#ffccaa');

// Automatically conversions to calculate values you need.
$h = $colour->hue(); 
$l = $colour->lightness();
$b = $colour->brightness();

// Distinguish between different types of saturation.
$sl = $colour->hslSaturation();
$sb = $colour->hsbSaturation();

// Explicit conversions if you need them. 
$hsl = $colour->toHSL();
$sl == $hsl->saturation();
// Colours are immutable - conversions are highly cached as a result.

// Freely convert between colour spaces as required.
$hsb = $colour->toHSB();
$colour->equals($hsb->toRGB()); // TRUE

Gotchas

$colour = \Colourist\Colour::fromHex('#ffccaa');
$colour2 = \Colourist\Colour::fromHex('#aaccff');

// You must use ->equals() for comparing equality.
$colour->equals($colour2); // FALSE
$colour == $colour2; // stack overflow