Skip to content
Colour manipulation library for PHP
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
tests
.codeclimate.yml
.gitignore
LICENSE
README.md
circle.yml
composer.json
pakefile.php
phpcs.xml
phpunit.xml

README.md

colourist

Circle CI Code Climate

Latest Stable Version Total Downloads

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
You can’t perform that action at this time.