ps/image-optimizer

Image optimization / compression library. This library is able to optimize png, jpg and gif files in very easy and handy way. It uses optipng, pngquant, pngcrush, pngout, gifsicle, jpegoptim and jpegtran tools.

Installs: 883

Dependents: 2

Stars: 56

Watchers: 11

Forks: 8

Open Issues: 3

Language: PHP

1.0.3 2015-05-30 01:48 UTC

README

This library is handy and very easy to use optimizer for image files. It uses optipng, pngquant, jpegoptim and few more libraries, so before use it you should install proper libraries on your server. Project contains Vagrantfile that defines testing virtual machine with all libraries installed, so you can check Vagrantfile how to install all those stuff.

Thanks to ImageOptimizer and librares that it uses, your image files can be 10%-70% smaller.

Basic usage

    $factory = new \ImageOptimizer\OptimizerFactory();
    $optimizer = $factory->get();

    $filepath = /* path to image */;

    $optimizer->optimize($filepath);
    //optimized file overwrites original one

Configuration

By default optimizer does not throw any exception, if file can not be optimized or optimizing library for given file is not installed, optimizer will not touch original file. This behaviour is ok when you want to eventually optimize files uploaded by user. When in your use case optimization fault should cause exception, ignore_errors option was created especially for you.

This library is very smart, you do not have to configure paths to all binaries of libraries that are used by ImageOptimizer, library will be looking for those binaries in few places, so if binaries are placed in standard places, it will be found automatically.

Supported options:

  • ignore_errors (default: true)
  • optipng_bin (default: will be guessed) - you can enforce paths to binaries, but by default it will be guessed
  • pngquant_bin
  • pngcrush_bin
  • pngout_bin
  • gifsicle_bin
  • jpegoptim_bin
  • jpegtran_bin

You can pass array of options as first argument of ImageOptimizer\OptimizerFactory constructor. Second argument is optionally Psr\LoggerInterface.

    $factory = new \ImageOptimizer\OptimizerFactory(array('ignore_errors' => false), $logger);

Supported optimizers

  • default (smart) - it guess file type and choose optimizer for this file type
  • png - chain of optimizers for png files, by default it uses pngquant and optipng. pngquant is lossy optimization
  • jpg - first of two optimizations will be executed: jpegtran or jpegoptim
  • gif - alias to gifsicle
  • pngquant - homepage
  • optipng - homepage
  • pngcrush - homepage
  • pngout - homepage
  • jpegtran - homepage
  • jpegoptim - homepage
  • gifsicle - homepage

You can obtain concrete optimizer by passing his name to ImageOptimizer\OptimizerFactory::get method:

    //default optimizer is `smart`
    $optimizer = $factory->get();

    //png optimizer
    $pngOptimizer = $factory->get('png');

    //jpegoptim optimizer etc.
    $jpgOptimizer = $factory->get('jpegoptim');

License

MIT