2017 © Pedro Peláez
 

library 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.

image

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.

  • Wednesday, April 11, 2018
  • by psliwa
  • Repository
  • 34 Watchers
  • 547 Stars
  • 328,875 Installations
  • PHP
  • 23 Dependents
  • 2 Suggesters
  • 89 Forks
  • 16 Open issues
  • 14 Versions
  • 12 % Grown

The README.md

Image Optimizer Build Status

This library is handy and very easy to use optimizer for image files. It uses optipng, pngquant, jpegoptim, [svgo][9] 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., (*1)

Thanks to ImageOptimizer and libraries that it uses, your image files can be 10%-70% smaller., (*2)

Installation

Using composer:, (*3)

composer require ps/image-optimizer

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., (*4)

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., (*5)

Supported options:, (*6)

  • ignore_errors (default: true)
  • single_optimizer_timeout_in_seconds (default: 60) - useful when you want to have control how long optimizing lasts. For example in some cases optimizing may not be worth when it takes big amount of time. Pass null in order to turn off timeout.
  • output_filepath_pattern (default: %basename%/%filename%%ext%) - destination where optimized file will be stored. By default it overrides original file. There are 3 placehoders: %basename%, %filename% (without extension and dot) and %ext% (extension with dot) which will be replaced by values from original file.
  • execute_only_first_png_optimizer (default: true) - execute the first successful or all png optimizers
  • execute_only_first_jpeg_optimizer (default: true) - execute the first successful or all jpeg optimizers
  • optipng_options (default: array('-i0', '-o2', '-quiet')) - an array of arguments to pass to the library
  • pngquant_options (default: array('--force'))
  • pngcrush_options (default: array('-reduce', '-q', '-ow'))
  • pngout_options (default: array('-s3', '-q', '-y'))
  • advpng_options (default: array('-z', '-4', '-q'))
  • gifsicle_options (default: array('-b', '-O5'))
  • jpegoptim_options (default: array('--strip-all', '--all-progressive'))
  • jpegtran_options (default: array('-optimize', '-progressive'))
  • svgo_options (default: array('--disable=cleanupIDs'))
  • custom_optimizers (default array())
  • 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
  • advpng_bin
  • gifsicle_bin
  • jpegoptim_bin
  • jpegtran_bin
  • svgo_bin

You can pass array of options as first argument of ImageOptimizer\OptimizerFactory constructor. Second argument is optionally Psr\LoggerInterface., (*7)

$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
  • advpng - homepage
  • jpegtran - homepage
  • jpegoptim - homepage
  • gifsicle - homepage
  • svgo - [homepage][9]

You can obtain concrete optimizer by passing his name to ImageOptimizer\OptimizerFactory::get method:, (*8)

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

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

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

Custom optimizers

You can easily define custom optimizers:, (*9)

$factory = new \ImageOptimizer\OptimizerFactory(array('custom_optimizers' => array(
    'some_optimizier' => array(
        'command' => 'some_command',
        'args' => array('-some-flag')
    )
)), $logger);

And then usage:, (*10)

$customOptimizer = $factory->get('some_optimizier');

I got "All optimizers failed to optimize the file"

Probably you don't have required optimazers installed. Let's have a look at Vagrantfile file in order to see an example how to install those commands., (*11)

In order to see all intermediate errors, you can use logger (be default NullLogger is used, so logs are not available):, (*12)

class StdoutLogger extends \Psr\Log\AbstractLogger { 
    public function log($level, $message, array $context = array()) { 
        echo $message."\n"; 
    }
}

$factory = new \ImageOptimizer\OptimizerFactory(array(), new StdoutLogger());

$factory->get()->optimize('yourfile.jpg');

// and have a look at stdout

License

MIT, (*13)

The Versions

11/04 2018

dev-master

9999999-dev

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.

  Sources   Download

MIT

The Requires

 

The Development Requires

image optimization compression optipng jpegoptim image optimizer

11/04 2018

1.2.0

1.2.0.0

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.

  Sources   Download

MIT

The Requires

 

The Development Requires

image optimization compression optipng jpegoptim image optimizer

11/04 2018

1.1.4

1.1.4.0

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.

  Sources   Download

MIT

The Requires

 

The Development Requires

image optimization compression optipng jpegoptim image optimizer

09/04 2018

1.1.3

1.1.3.0

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.

  Sources   Download

MIT

The Requires

 

The Development Requires

image optimization compression optipng jpegoptim image optimizer

24/07 2017

1.1.2

1.1.2.0

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.

  Sources   Download

MIT

The Requires

 

The Development Requires

image optimization compression optipng jpegoptim image optimizer

28/06 2017

1.1.1

1.1.1.0

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.

  Sources   Download

MIT

The Requires

 

The Development Requires

image optimization compression optipng jpegoptim image optimizer

25/03 2017

1.1.0

1.1.0.0

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.

  Sources   Download

MIT

The Requires

 

The Development Requires

image optimization compression optipng jpegoptim image optimizer

16/01 2016

1.0.6

1.0.6.0

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.

  Sources   Download

MIT

The Requires

 

image optimization compression optipng jpegoptim image optimizer

06/01 2016

1.0.5

1.0.5.0

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.

  Sources   Download

MIT

The Requires

 

image optimization compression optipng jpegoptim image optimizer

18/11 2015

1.0.4

1.0.4.0

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.

  Sources   Download

MIT

The Requires

 

image optimization compression optipng jpegoptim image optimizer

30/05 2015

1.0.3

1.0.3.0

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.

  Sources   Download

MIT

The Requires

 

image optimization compression optipng jpegoptim image optimizer

30/01 2015

1.0.2

1.0.2.0

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.

  Sources   Download

MIT

The Requires

 

image optimization compression optipng jpegoptim image optimizer

06/08 2014

1.0.1

1.0.1.0

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.

  Sources   Download

MIT

The Requires

 

image optimization compression optipng jpegoptim image optimizer

03/08 2014

1.0.0

1.0.0.0

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.

  Sources   Download

MIT

The Requires

 

image optimization compression optipng jpegoptim image optimizer