league/color-extractor

Extract colors from an image as a human would do.

Installs: 9 406

Dependents: 0

Stars: 350

Watchers: 15

Forks: 42

Open Issues: 6

Language: PHP

0.1.8 2015-06-21 12:26 UTC

README

Build Status Total Downloads Latest Stable Version

Extract colors from an image like a human would do.

Install

Via Composer

$ composer require league/color-extractor:0.1.*

Usage

require 'vendor/autoload.php';

use League\ColorExtractor\Client as ColorExtractor;

$client = new ColorExtractor;

$image = $client->loadPng('./some/image.png');

// Get the most used color hex code
$palette = $image->extract();

// Get three most used color hex code
$palette = $image->extract(3);

// Change the Minimum Color Ratio (0 - 1)
// Default: 0
$image->setMinColorRatio(1);
$palette = $image->extract();

Service Providers

Integration with most frameworks would require a bridge package, but for Silex and Laravel 4 a simple service provider will suffice.

Silex

First register ColorExtractorServiceProvider in your application:

use League\ColorExtractor\Silex\ColorExtractorServiceProvider;

// ... create $app
$app->register(new ColorExtractorServiceProvider);

Then you can use like this:

$image = $app['color-extractor']->loadPng('./some/image.png');
...
$palette = $image->extract();

Laravel 4

Find the providers key in app/config/app.php and register the ColorExtractorServiceProvider:

'providers' => array(
    // ...
    'League\ColorExtractor\Laravel\ColorExtractorServiceProvider',
)

Then you can use it exactly the same way as the Silex service provider. If you prefer to use Facades, find the aliases key in app/config/app.php and register the ColorExtractorFacade:

'aliases' => array(
    // ...
    'ColorExtractor' => 'League\ColorExtractor\Laravel\ColorExtractorFacade',
)

Example:

$image = ColorExtractor::loadPng('./some/image.png');
...
$palette = $image->extract();

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.