Initial release commit

README.md

@@ -0,0 +1,29 @@
+ImageOptimizer
+===========
+PHP image optimizer for png, jpeg and gif files. It uses mozjpeg, pngquant and gifsicle for the optimization process.
+
+**This guide assumes you have mozjpeg, pngquant and gifsicle installed.**
+
+Installation
+----------- 
+You can install this library with composer or include it manually in your project.
+
+Quick start
+-----------
+
+```php
+ $optimizer = new Optimizer(
+    array(
+        Optimizer::PNGQUANT_PATH => '/usr/local/bin/pngquant',
+        Optimizer::MOZJPEG_PATH => '/usr/local/bin/cjpeg',
+        Optimizer::GIFSICLE_PATH => '/usr/local/bin/gifsicle'
+    )
+);
+```
+
+After this you can run the optimization process. If the optimization failed the method will throw an Exception, otherwise it returns TRUE.
+
+```php
+$optimizer->optimize('example.jpg', 'example-optimized.jpg'));
+```
+

composer.json

@@ -16,17 +16,17 @@
     "gifsicle",
     "php"
   ],
+  "minimum-stability": "dev",
   "license": "MIT",
-  "minimum-stability": "stable",
   "require": {
-    "php": ">=5.3"
+    "php": ">=5.4"
   },
   "require-dev": {
     "phpunit/phpunit": "~4.8"
   },
   "autoload": {
     "psr-0": {
-      "ImageOptimizer": "src/"
+      "ImageOptimizer": "src"
     }
   }
 }

src/ImageOptimizer/Optimizer.php

@@ -3,9 +3,9 @@
 namespace ImageOptimizer;
 
 use Exception;
-use ImageOptimizer\Optimizer\Gifsicle;
-use ImageOptimizer\Optimizer\Mozjpeg;
-use ImageOptimizer\Optimizer\Pngquant;
+use ImageOptimizer\Provider\Optimization\Gifsicle;
+use ImageOptimizer\Provider\Optimization\Mozjpeg;
+use ImageOptimizer\Provider\Optimization\Pngquant;
 
 /**
  * Class Optimizer
@@ -56,6 +56,8 @@ public function __construct($optimizer = array())
      * @param string $input
      * @param string $output
      *
+     * @return bool
+     *
      * @throws Exception
      */
     public function optimize($input, $output = '')
@@ -84,5 +86,7 @@ public function optimize($input, $output = '')
         if (false === $result) {
             throw new Exception('Could not write to file');
         }
+
+        return true;
     }
 }

src/ImageOptimizer/Optimizer/AbstractImage.php → src/ImageOptimizer/Provider/Optimization/AbstractOptimizationProvider.php

@@ -1,18 +1,20 @@
 <?php
 
-namespace ImageOptimizer\Optimizer;
+namespace ImageOptimizer\Provider\Optimization;
+
+use Exception;
 
 /**
- * Class AbstractImage
+ * Class AbstractOptimizationProvider
  *
- * @package ImageOptimizer\Optimizer
+ * @package ImageOptimizer\Provider\Optimization
  */
-abstract class AbstractImage
+abstract class AbstractOptimizationProvider
 {
     protected $binaryPath;
 
     /**
-     * AbstractImage constructor.
+     * AbstractOptimizationProvider constructor.
      *
      * @param string $binaryPath
      */
@@ -26,7 +28,9 @@ public function __construct($binaryPath)
      *
      * @param mixed $image
      *
-     * @return void
+     * @return string
+     *
+     * @throws Exception
      */
     abstract public function optimize($image);
 }

src/ImageOptimizer/Optimizer/Gifsicle.php → src/ImageOptimizer/Provider/Optimization/Gifsicle.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace ImageOptimizer\Optimizer;
+namespace ImageOptimizer\Provider\Optimization;
 
 use Exception;
 
 /**
  * Class Gifsicle
  *
- * @package ImageOptimizer\Optimizer
+ * @package ImageOptimizer\Provider\Optimization
  */
-class Gifsicle extends AbstractImage
+class Gifsicle extends AbstractOptimizationProvider
 {
     /**
      * Gifsicle constructor.
@@ -27,14 +27,15 @@ public function __construct($binaryPath)
      * @param mixed $image
      *
      * @return string
+     *
      * @throws Exception
      */
     public function optimize($image)
     {
         $content = shell_exec($this->binaryPath.' -O2 '.escapeshellarg($image));
 
         if (!$content) {
-            throw new Exception();
+            throw new Exception('There was an error during the optimization');
         }
 
         return $content;

src/ImageOptimizer/Optimizer/Mozjpeg.php → src/ImageOptimizer/Provider/Optimization/Mozjpeg.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace ImageOptimizer\Optimizer;
+namespace ImageOptimizer\Provider\Optimization;
 
 use Exception;
 
 /**
  * Class Mozjpeg
  *
- * @package ImageOptimizer\Optimizer
+ * @package ImageOptimizer\Provider\Optimization
  */
-class Mozjpeg extends AbstractImage
+class Mozjpeg extends AbstractOptimizationProvider
 {
     /**
      * Mozjpeg constructor.
@@ -27,14 +27,15 @@ public function __construct($binaryPath)
      * @param mixed $image
      *
      * @return string
+     *
      * @throws Exception
      */
     public function optimize($image)
     {
-        $content = shell_exec($this->binaryPath.' '.escapeshellarg($image));
+        $content = shell_exec($this->binaryPath.' -optimize '.escapeshellarg($image));
 
         if (!$content) {
-            throw new Exception();
+            throw new Exception('There was an error during the optimization');
         }
 
         return $content;

src/ImageOptimizer/Optimizer/Pngquant.php → src/ImageOptimizer/Provider/Optimization/Pngquant.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace ImageOptimizer\Optimizer;
+namespace ImageOptimizer\Provider\Optimization;
 
 use Exception;
 
 /**
  * Class Pngquant
  *
- * @package ImageOptimizer\Optimizer
+ * @package ImageOptimizer\Provider\Optimization
  */
-class Pngquant extends AbstractImage
+class Pngquant extends AbstractOptimizationProvider
 {
     /**
      * Pngquant constructor.
@@ -27,14 +27,15 @@ public function __construct($binaryPath)
      * @param mixed $image
      *
      * @return string
+     *
      * @throws Exception
      */
     public function optimize($image)
     {
         $content = shell_exec($this->binaryPath.' - < '.escapeshellarg($image));
 
         if (!$content) {
-            throw new Exception();
+            throw new Exception('There was an error during the optimization');
         }
 
         return $content;