Initial watermark plugin implementation #15

Author: Peter Bubelíny

README.md

@@ -17,13 +17,15 @@ Service that provides API to manipulate images.
   - [Reflection](http://webino-image-thumb.demo.webino.org/application/demo/reflection)
   - [Whitespace cropper](http://webino-image-thumb.demo.webino.org/application/demo/whitespace-cropper)
   - [Sharpen](http://webino-image-thumb.demo.webino.org/application/demo/sharpen)
+  - [Watermark](http://webino-image-thumb.demo.webino.org/application/demo/watermark)
 
 ## Features
 
   - Resize, crop, pad, rotate, show and save images
   - Create image reflection
   - Crop whitespace
   - Sharpen images
+  - Watermark
 
 ## Setup
 
@@ -68,6 +70,13 @@ Service that provides API to manipulate images.
         $sharpen = $thumbnailer->createSharpen();
         $thumb   = $thumbnailer->create($imagePath, [], [$sharpen]);
 
+  - Use watermark plugin:
+
+        $watermarkPath  = 'public/images/my_watermark.png';
+        $watermarkThumb = $this->thumbnailer->create($watermarkFile);
+        $watermark      = $this->thumbnailer->createWatermark($watermarkThumb,[30,30]);
+        $thumb          = $this->thumbnailer->create($image, [], [$watermark]);
+
 ## Options
 
  The options array allows you to customize the behavior of the library a bit. Some of these options are implementation-specific, and are noted as such.  So, let's first go over what options are available to us:
@@ -185,6 +194,14 @@ Service that provides API to manipulate images.
     * `$margin` - What pixels of a margin should be around the original image.
     * `$color`  - The hex value of the color you would like to crop.
 
+## Watermark plugin
+
+  * `createWatermark(PHPThumb $watermarkThumb, $position = [0, 0])`
+
+    * `$watermarkThumb` - What pixels of a margin should be around the original image.
+    * `$position`  - Position of watermark, X and Y from the left bottom corner.
+
+
 ## Changelog
 
 ### 2.0.0 [UNRELEASED]
@@ -193,6 +210,7 @@ Service that provides API to manipulate images.
   - Added Whitespace Cropper plugin
   - Added Sharpen plugin
   - Removed ZF autoloader support
+  - Added Watermark plugin
 
 ### 1.0.0
 

src/WebinoImageThumb/PhpThumb/Plugin/Watermark.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Webino (https://github.com/webino/)
+ *
+ * @link      https://github.com/webino/WebinoImageThumb/ for the canonical source repository
+ * @copyright Copyright (c) 2013-2015 Webino, s. r. o. (http://webino.sk/)
+ * @license   BSD-3-Clause
+ */
+
+namespace WebinoImageThumb\PhpThumb\Plugin;
+
+use PHPThumb\GD as PHPThumb;
+
+/**
+ * Add watermark to image
+ *
+ * @author Peter Bubelíny <neri@neridev.com>
+ */
+class Watermark implements \PHPThumb\PluginInterface
+{
+    /**
+     * @var int
+     */
+    protected $watermarkThumb;
+
+    /**
+     * @var int
+     */
+    protected $position = [0, 0];
+
+    /**
+     * Watermark constructor
+     * @param int $watermark
+     * @param int $position
+     */
+    public function __construct($watermarkThumb, $position)
+    {
+        $this->watermarkThumb = $watermarkThumb;
+        $this->position = $position;
+    }
+
+
+    /**
+     * @param PHPThumb $phpthumb
+     * @return PHPThumb
+     */
+    public function execute($phpthumb)
+    {
+
+        $currentDimensions = $phpthumb->getCurrentDimensions();
+        $height            = $currentDimensions['height'];
+        $oldImage          = $phpthumb->getOldImage();
+        $watermarkThumb    = $this->watermarkThumb->getOldImage();
+
+        $watermarkCurrentDimensions = $this->watermarkThumb->getCurrentDimensions();
+        $watermarkWidth             = $watermarkCurrentDimensions['width'];
+        $watermarkHeight            = $watermarkCurrentDimensions['height'];
+
+        $position[0] = $this->position[0];
+        $position[1] = $this->position[1];
+        $positionY   = ($height-$watermarkHeight)-$position[1];
+
+        imagecopy(
+            $oldImage,
+            $watermarkThumb,
+            $position[0],
+            $positionY,
+            0,
+            0,
+            $watermarkWidth,
+            $watermarkHeight
+        );
+
+        $phpthumb->setWorkingImage($oldImage);
+
+        return $phpthumb;
+    }
+}

src/WebinoImageThumb/Service/ImageThumb.php

@@ -79,4 +79,16 @@ public function createSharpen($offset = 0, array $matrix = [])
     {
         return new ExtraPlugins\Sharpen($offset, $matrix);
     }
+
+    /**
+     * Create a watermark on image
+     *
+     * @param int $watermark
+     * @param array $position
+     * @return ExtraPlugins\Watermark
+     */
+    public function createWatermark($watermarkThumb, array $position = [0,0])
+    {
+        return new ExtraPlugins\Watermark($watermarkThumb, $position);
+    }
 }

tests/resources/data/media/watermark.png

@@ -9,6 +9,7 @@
 
 namespace Application\Controller;
 
+use PHPThumb\PHPThumb;
 use WebinoImageThumb\Service\ImageThumb;
 use Zend\Mvc\Controller\AbstractActionController;
 
@@ -90,4 +91,27 @@ public function sharpenAction()
 
         return false;
     }
-}
+
+    /**
+     * Save and show an image with watermark
+     */
+    public function watermarkAction()
+    {
+        $watermarkPath  = __DIR__ . '/../../../data/media/watermark.png';
+        $image     = __DIR__ . '/../../../data/media/test.jpg';
+
+        $watermarkThumb = $this->thumbnailer->create($watermarkPath);
+        $watermarkThumb
+            ->resize(100, 100);
+
+        $watermark = $this->thumbnailer->createWatermark($watermarkThumb,[30,30]);
+        $thumb     = $this->thumbnailer->create($image, [], [$watermark]);
+
+        $thumb
+            ->resize(200, 200)
+            ->show()
+            ->save('public/watermark_test.jpg');
+
+        return false;
+    }
+}

tests/resources/src/Application/Controller/DemoController.php

@@ -40,4 +40,13 @@ public function testSharpen()
         $src = file_get_contents($this->uri . 'application/demo/sharpen');
         $this->assertJpegImage($src);
     }
+
+    /**
+     * Watermark plugin test
+     */
+    public function testWatermark()
+    {
+        $src = file_get_contents($this->uri . 'application/demo/watermark');
+        $this->assertJpegImage($src);
+    }
 }

tests/selenium/WebinoImageThumb/HomeTest.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * Webino (http://webino.sk/)
+ *
+ * @link        https://github.com/webino/WebinoImageThumb/ for the canonical source repository
+ * @copyright   Copyright (c) 2013-2015 Webino, s. r. o. (http://webino.sk/)
+ * @license     BSD-3-Clause
+ */
+
+use Tester\Assert;
+use WebinoImageThum\PHPThumb\Plugins\Watermark;
+use WebinoImageThumb\Service\ImageThumb;
+
+require __DIR__ . '/../bootstrap.php';
+
+// TODO test
+/*
+$thumbnailer = new ImageThumb;
+$plugin = $thumbnailer->createWatermark($watermarkThumb);
+
+
+Assert::type(Watermark::class, $plugin);
+*/
+
+Assert::true(true);
+