Merge pull request #21 from hanovruslan/reader-interface

Added proper reader interface

Author: Miljar

README.md

@@ -7,47 +7,20 @@ PHPExif serves as a wrapper around some native or CLI tools which access this EX
 ## Supported tools
 
 * Native PHP functionality (exif_read_data, iptcparse)
-* [Exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool/‎) adapter (wrapper for the exiftool binary)
+* [Exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool‎) adapter (wrapper for the exiftool binary)
 
 ## Installation (composer)
 
 ```json
-"miljar/php-exif": "0.*"
+"miljar/php-exif": "~0.2"
 ```
 
 
 ## Usage
 
-### Using factory method
+[Before v0.2.2](Resources/doc/usage_0.2.1.md)
 
-```php
-<?php
-// reader with Native adapter
-$reader = \PHPExif\Reader::factory(\PHPExif\Reader::TYPE_NATIVE);
-
-// reader with Exiftool adapter
-//$reader = \PHPExif\Reader::factory(\PHPExif\Reader::TYPE_EXIFTOOL);
-
-$exif = $reader->getExifFromFile('/path/to/file');
-
-echo 'Title: ' . $exif->getTitle() . PHP_EOL;
-```
-
-### Using custom options
-
-```php
-<?php
-$adapter = new \PHPExif\Reader\Adapter\Exiftool(
-    array(
-        'toolPath'  => '/path/to/exiftool',
-    )
-);
-$reader = new \PHPExif\Reader($adapter);
-
-$exif = $reader->getExifFromFile('/path/to/file');
-
-echo 'Title: ' . $exif->getTitle() . PHP_EOL;
-```
+[v0.2.2+](Resources/doc/usage.md)
 
 ## Contributing
 

Resources/doc/usage.md

@@ -0,0 +1,32 @@
+## Usage ##
+
+### Using factory method
+
+```php
+<?php
+// reader with Native adapter
+$reader = \PHPExif\Reader\Reader::factory(\PHPExif\Reader\Reader::TYPE_NATIVE);
+
+// reader with Exiftool adapter
+//$reader = \PHPExif\Reader\Reader::factory(\PHPExif\Reader\Reader::TYPE_EXIFTOOL);
+
+$exif = $reader->read('/path/to/file');
+
+echo 'Title: ' . $exif->getTitle() . PHP_EOL;
+```
+
+### Using custom options
+
+```php
+<?php
+$adapter = new \PHPExif\Adapter\Exiftool(
+    array(
+        'toolPath'  => '/path/to/exiftool',
+    )
+);
+$reader = new \PHPExif\Reader\Reader($adapter);
+
+$exif = $reader->read('/path/to/file');
+
+echo 'Title: ' . $exif->getTitle() . PHP_EOL;
+```

Resources/doc/usage_0.2.1.md

@@ -0,0 +1,32 @@
+## Usage ##
+
+### Using factory method
+
+```php
+<?php
+// reader with Native adapter
+$reader = \PHPExif\Reader::factory(\PHPExif\Reader::TYPE_NATIVE);
+
+// reader with Exiftool adapter
+//$reader = \PHPExif\Reader::factory(\PHPExif\Reader::TYPE_EXIFTOOL);
+
+$exif = $reader->getExifFromFile('/path/to/file');
+
+echo 'Title: ' . $exif->getTitle() . PHP_EOL;
+```
+
+### Using custom options
+
+```php
+<?php
+$adapter = new \PHPExif\Reader\Adapter\Exiftool(
+    array(
+        'toolPath'  => '/path/to/exiftool',
+    )
+);
+$reader = new \PHPExif\Reader($adapter);
+
+$exif = $reader->getExifFromFile('/path/to/file');
+
+echo 'Title: ' . $exif->getTitle() . PHP_EOL;
+```

lib/PHPExif/Reader/AdapterAbstract.php lib/PHPExif/Adapter/AdapterAbstract.php

@@ -9,7 +9,7 @@
  * @package     Reader
  */
 
-namespace PHPExif\Reader;
+namespace PHPExif\Adapter;
 
 /**
  * PHP Exif Reader Adapter Abstract

lib/PHPExif/Reader/AdapterInterface.php lib/PHPExif/Adapter/AdapterInterface.php

@@ -9,7 +9,7 @@
  * @package     Reader
  */
 
-namespace PHPExif\Reader;
+namespace PHPExif\Adapter;
 
 /**
  * PHP Exif Reader Adapter

lib/PHPExif/Reader/Adapter/Exiftool.php lib/PHPExif/Adapter/Exiftool.php

@@ -9,13 +9,12 @@
  * @package     Reader
  */
 
-namespace PHPExif\Reader\Adapter;
+namespace PHPExif\Adapter;
 
-use PHPExif\Reader\AdapterAbstract;
 use PHPExif\Exif;
-use \InvalidArgumentException;
-use \RuntimeException;
-use \DateTime;
+use InvalidArgumentException;
+use RuntimeException;
+use DateTime;
 
 /**
  * PHP Exif Exiftool Reader Adapter
@@ -45,7 +44,7 @@ class Exiftool extends AdapterAbstract
      * Setter for the exiftool binary path
      * 
      * @param string $path The path to the exiftool binary
-     * @return \PHPExif\Reader\Adapter\Exiftool Current instance
+     * @return \PHPExif\Adapter\Exiftool Current instance
      * @throws \InvalidArgumentException When path is invalid
      */
     public function setToolPath($path)

lib/PHPExif/Reader/Adapter/Native.php lib/PHPExif/Adapter/Native.php

@@ -9,11 +9,10 @@
  * @package     Reader
  */
 
-namespace PHPExif\Reader\Adapter;
+namespace PHPExif\Adapter;
 
-use PHPExif\Reader\AdapterAbstract;
 use PHPExif\Exif;
-use \DateTime;
+use DateTime;
 
 /**
  * PHP Exif Native Reader Adapter

lib/PHPExif/Reader/NoAdapterException.php lib/PHPExif/Adapter/NoAdapterException.php

@@ -9,9 +9,9 @@
  * @package     Reader
  */
 
-namespace PHPExif\Reader;
+namespace PHPExif\Adapter;
 
-use \Exception;
+use Exception;
 
 /**
  * PHP Exif Reader Adapter
@@ -23,5 +23,5 @@
  */
 class NoAdapterException extends Exception
 {
-
+    //empty
 }

lib/PHPExif/Reader.php lib/PHPExif/Reader/Reader.php

@@ -9,10 +9,12 @@
  * @package     Reader
  */
 
-namespace PHPExif;
+namespace PHPExif\Reader;
 
-use PHPExif\Reader\AdapterInterface;
-use PHPExif\Reader\NoAdapterException;
+use PHPExif\Adapter\AdapterInterface;
+use PHPExif\Adapter\NoAdapterException;
+use PHPExif\Adapter\Exiftool as ExiftoolAdapter;
+use PHPExif\Adapter\Native as NativeAdapter;
 
 /**
  * PHP Exif Reader
@@ -23,47 +25,32 @@
  * @package     Reader
  * @
  */
-class Reader
+class Reader implements ReaderInterface
 {
     const TYPE_NATIVE   = 'native';
     const TYPE_EXIFTOOL = 'exiftool';
 
     /**
      * The current adapter
      *
-     * @var \PHPExif\Reader\AdapterInterface
+     * @var \PHPExif\Adapter\AdapterInterface
      */
     protected $adapter;
 
     /**
      * Reader constructor
      *
-     * @param \PHPExif\Reader\AdapterInterface $adapter
+     * @param \PHPExif\Adapter\AdapterInterface $adapter
      */
-    public function __construct(AdapterInterface $adapter = null)
-    {
-        if (!is_null($adapter)) {
-            $this->setAdapter($adapter);
-        }
-    }
-
-    /**
-     * Setter for the reader adapter
-     *
-     * @param \PHPExif\Reader\AdapterInterface $adapter
-     * @return \PHPExif\Reader Current instance for chaining
-     */
-    public function setAdapter(AdapterInterface $adapter)
+    public function __construct(AdapterInterface $adapter)
     {
         $this->adapter = $adapter;
-
-        return $this;
     }
 
     /**
      * Getter for the reader adapter
      *
-     * @return \PHPExif\Reader\AdapterInterface
+     * @return \PHPExif\Adapter\AdapterInterface
      * @throws NoAdapterException When no adapter is set
      */
     public function getAdapter()
@@ -79,20 +66,19 @@ public function getAdapter()
      * Factory for the reader
      *
      * @param string $type
-     * @return \PHPExif\Reader
+     * @return $this
      * @throws \InvalidArgumentException When given type is invalid
      */
     public static function factory($type)
     {
         $classname = get_called_class();
-
         $adapter = null;
         switch ($type) {
             case self::TYPE_NATIVE:
-                $adapter = new Reader\Adapter\Native();
+                $adapter = new NativeAdapter();
                 break;
             case self::TYPE_EXIFTOOL:
-                $adapter = new Reader\Adapter\Exiftool();
+                $adapter = new ExiftoolAdapter();
                 break;
             default:
                 throw new \InvalidArgumentException(
@@ -109,8 +95,19 @@ public static function factory($type)
      * @param string $file
      * @return \PHPExif\Exif Instance of Exif object with data
      */
-    public function getExifFromFile($file)
+    public function read($file)
     {
         return $this->getAdapter()->getExifFromFile($file);
     }
+
+    /**
+     * alias to read method
+     *
+     * @param string $file
+     * @return \PHPExif\Exif Instance of Exif object with data
+     */
+    public function getExifFromFile($file)
+    {
+        return $this->read($file);
+    }
 }

lib/PHPExif/Reader/ReaderInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace PHPExif\Reader;
+
+interface ReaderInterface
+{
+    /**
+     * Reads & parses the EXIF data from given file
+     *
+     * @param string $file
+     * @return \PHPExif\Exif Instance of Exif object with data
+     */
+    public function read($file);
+}

tests/PHPExif/ExifTest.php

@@ -1,4 +1,5 @@
 <?php
+
 class ExifTest extends \PHPUnit_Framework_TestCase
 {
     /**
@@ -406,8 +407,8 @@ public function testAdapterConsistency()
             PHPEXIF_TEST_ROOT . '/files/dsc_5794.jpg'
         );
 
-        $adapter_exiftool = new \PHPExif\Reader\Adapter\Exiftool();
-        $adapter_native = new \PHPExif\Reader\Adapter\Native();
+        $adapter_exiftool = new \PHPExif\Adapter\Exiftool();
+        $adapter_native = new \PHPExif\Adapter\Native();
 
         foreach ($testfiles as $file) {
             $result_exiftool = $adapter_exiftool->getExifFromFile($file);