Merge pull request #446 from christeredvartsen/issue-444

Added a getData method to the model interface
imbo · Mar 17, 2016 · 1da4a2c · 1da4a2c
2 parents c982fea + 2f975fe
commit 1da4a2c
Show file tree

Hide file tree

Showing 25 changed files with 379 additions and 5 deletions.
diff --git a/ChangeLog.markdown b/ChangeLog.markdown
@@ -1,6 +1,12 @@
 Changelog for Imbo
 ==================
 
+Imbo-2.1.2
+----------
+__N/A__
+
+* #444: Added a getData() method to the Imbo\Model\ModelInterface (Christer Edvartsen)
+
 Imbo-2.1.1
 ----------
 __2016-03-11__

diff --git a/library/Imbo/Model/AccessRule.php b/library/Imbo/Model/AccessRule.php
@@ -128,4 +128,16 @@ public function setUsers(array $users) {
     public function getUsers() {
         return $this->users;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'id' => $this->getId(),
+            'group' => $this->getGroup(),
+            'resources' => $this->getResources(),
+            'users' => $this->getUsers(),
+        ];
+    }
 }
diff --git a/library/Imbo/Model/AccessRules.php b/library/Imbo/Model/AccessRules.php
@@ -44,4 +44,11 @@ public function setRules(array $rules) {
     public function getRules() {
         return $this->rules;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return $this->getRules();
+    }
 }
diff --git a/library/Imbo/Model/ArrayModel.php b/library/Imbo/Model/ArrayModel.php
@@ -44,9 +44,7 @@ public function setData(array $data) {
     }
 
     /**
-     * Get the data
-     *
-     * @return array
+     * {@inheritdoc}
      */
     public function getData() {
         return $this->data;

diff --git a/library/Imbo/Model/Error.php b/library/Imbo/Model/Error.php
@@ -162,6 +162,19 @@ public function getImageIdentifier() {
         return $this->imageIdentifier;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'httpCode' => $this->getHttpCode(),
+            'errorMessage' => $this->getErrorMessage(),
+            'date' => $this->getDate(),
+            'imboErrorCode' => $this->getImboErrorCode(),
+            'imageIdentifier' => $this->getImageIdentifier(),
+        ];
+    }
+
     /**
      * Create an error based on an exception instance
      *

diff --git a/library/Imbo/Model/Group.php b/library/Imbo/Model/Group.php
@@ -72,4 +72,14 @@ public function setResources(array $resources = []) {
     public function getResources() {
         return $this->resources;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'name' => $this->getName(),
+            'resources' => $this->getResources(),
+        ];
+    }
 }
diff --git a/library/Imbo/Model/Groups.php b/library/Imbo/Model/Groups.php
@@ -137,4 +137,17 @@ public function setPage($page) {
     public function getPage() {
         return $this->page;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'groups' => $this->getGroups(),
+            'count' => $this->getCount(),
+            'hits' => $this->getHits(),
+            'limit' => $this->getLimit(),
+            'page' => $this->getPage(),
+        ];
+    }
 }
diff --git a/library/Imbo/Model/Image.php b/library/Imbo/Model/Image.php
@@ -435,6 +435,27 @@ public function hasBeenTransformed($flag = null) {
         return $this;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'filesize' => $this->getFilesize(),
+            'mimeType' => $this->getMimeType(),
+            'extension' => $this->getExtension(),
+            'metadata' => $this->getMetadata(),
+            'width' => $this->getWidth(),
+            'height' => $this->getHeight(),
+            'addedDate' => $this->getAddedDate(),
+            'updatedDate' => $this->getUpdatedDate(),
+            'user' => $this->getUser(),
+            'imageIdentifier' => $this->getImageIdentifier(),
+            'checksum' => $this->getChecksum(),
+            'originalChecksum' => $this->getOriginalChecksum(),
+            'hasBeenTransformed' => $this->hasBeenTransformed(),
+        ];
+    }
+
     /**
      * Check if a mime type is supported by Imbo
      *

diff --git a/library/Imbo/Model/Images.php b/library/Imbo/Model/Images.php
@@ -165,4 +165,18 @@ public function setPage($page) {
     public function getPage() {
         return $this->page;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'images' => $this->getImages(),
+            'fields' => $this->getFields(),
+            'count' => $this->getCount(),
+            'hits' => $this->getHits(),
+            'limit' => $this->getLimit(),
+            'page' => $this->getPage(),
+        ];
+    }
 }
diff --git a/library/Imbo/Model/ListModel.php b/library/Imbo/Model/ListModel.php
@@ -100,4 +100,15 @@ public function setEntry($entry) {
 
         return $this;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'list' => $this->getList(),
+            'container' => $this->getContainer(),
+            'entry' => $this->getEntry(),
+        ];
+    }
 }
diff --git a/library/Imbo/Model/ModelInterface.php b/library/Imbo/Model/ModelInterface.php
@@ -16,4 +16,11 @@
  * @author Christer Edvartsen <cogo@starzinger.net>
  * @package Models
  */
-interface ModelInterface {}
+interface ModelInterface {
+    /**
+     * Return the "data" found in the model
+     *
+     * @return mixed
+     */
+    function getData();
+}
diff --git a/library/Imbo/Model/Stats.php b/library/Imbo/Model/Stats.php
@@ -151,4 +151,16 @@ public function offsetSet($offset, $value) {
     public function offsetUnset($offset) {
         unset($this->customStats[$offset]);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'numUsers' => $this->getNumUsers(),
+            'numBytes' => $this->getNumBytes(),
+            'numImages' => $this->getNumImages(),
+            'customStats' => $this->getCustomStats(),
+        ];
+    }
 }
diff --git a/library/Imbo/Model/Status.php b/library/Imbo/Model/Status.php
@@ -102,4 +102,15 @@ public function setStorageStatus($status) {
     public function getStorageStatus() {
         return $this->storageStatus;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'date' => $this->getDate(),
+            'database' => $this->getDatabaseStatus(),
+            'storage' => $this->getStorageStatus(),
+        ];
+    }
 }
diff --git a/library/Imbo/Model/User.php b/library/Imbo/Model/User.php
@@ -102,4 +102,15 @@ public function setLastModified(DateTime $date) {
     public function getLastModified() {
         return $this->lastModified;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData() {
+        return [
+            'id' => $this->getUserId(),
+            'numImages' => $this->getNumImages(),
+            'lastModified' => $this->getLastModified(),
+        ];
+    }
 }
diff --git a/tests/phpunit/ImboUnitTest/Model/AccessRuleTest.php b/tests/phpunit/ImboUnitTest/Model/AccessRuleTest.php
@@ -76,4 +76,22 @@ public function testSetAndGetUsers() {
         $this->assertSame($this->model, $this->model->setUsers(['u1', 'u2']));
         $this->assertSame(['u1', 'u2'], $this->model->getUsers());
     }
+
+    /**
+     * @covers Imbo\Model\AccessRule::getData
+     */
+    public function testGetData() {
+        $this->model
+            ->setId(1)
+            ->setGroup('name')
+            ->setResources(['r1', 'r2'])
+            ->setUsers(['u1', 'u2']);
+
+        $this->assertSame([
+            'id' => 1,
+            'group' => 'name',
+            'resources' => ['r1', 'r2'],
+            'users' => ['u1', 'u2'],
+        ], $this->model->getData());
+    }
 }
diff --git a/tests/phpunit/ImboUnitTest/Model/AccessRulesTest.php b/tests/phpunit/ImboUnitTest/Model/AccessRulesTest.php
@@ -40,14 +40,17 @@ public function tearDown() {
     /**
      * @covers Imbo\Model\AccessRules::getRules
      * @covers Imbo\Model\AccessRules::setRules
+     * @covers Imbo\Model\AccessRules::getData
      */
     public function testSetAndGetId() {
         $rules = [
             ['id' => 1, 'group' => 'group', 'users' => ['user']],
             ['id' => 2, 'resources' => ['image.get', 'image.head'], 'users' => ['user']],
         ];
         $this->assertSame([], $this->model->getRules());
+        $this->assertSame([], $this->model->getData());
         $this->assertSame($this->model, $this->model->setRules($rules));
         $this->assertSame($rules, $this->model->getRules());
+        $this->assertSame($rules, $this->model->getData());
     }
 }
diff --git a/tests/phpunit/ImboUnitTest/Model/ErrorTest.php b/tests/phpunit/ImboUnitTest/Model/ErrorTest.php
@@ -142,4 +142,25 @@ public function testWillUseImageIdentifierFromImageModelIfRequestHasAnImageWhenC
         $this->assertSame(123, $model->getImboErrorCode());
         $this->assertSame('imageId', $model->getImageIdentifier());
     }
+
+    /**
+     * @covers Imbo\Model\Error::getData
+     */
+    public function testGetData() {
+        $date = new DateTime();
+
+        $this->model->setHttpCode(404);
+        $this->model->setErrorMessage('message');
+        $this->model->setDate($date);
+        $this->model->setImboErrorCode(100);
+        $this->model->setImageIdentifier('identifier');
+
+        $this->assertSame([
+            'httpCode' => 404,
+            'errorMessage' => 'message',
+            'date' => $date,
+            'imboErrorCode' => 100,
+            'imageIdentifier' => 'identifier',
+        ], $this->model->getData());
+    }
 }
diff --git a/tests/phpunit/ImboUnitTest/Model/GroupTest.php b/tests/phpunit/ImboUnitTest/Model/GroupTest.php
@@ -56,4 +56,18 @@ public function testSetAndGetResources() {
         $this->assertSame($this->model, $this->model->setResources(['image.get', 'image.head']));
         $this->assertSame(['image.get', 'image.head'], $this->model->getResources());
     }
+
+    /**
+     * @covers Imbo\Model\Group::getData
+     */
+    public function testGetData() {
+        $this->model
+            ->setName('name')
+            ->setResources(['image.get', 'image.head']);
+
+        $this->assertSame([
+            'name' => 'name',
+            'resources' => ['image.get', 'image.head'],
+        ], $this->model->getData());
+    }
 }
diff --git a/tests/phpunit/ImboUnitTest/Model/GroupsTest.php b/tests/phpunit/ImboUnitTest/Model/GroupsTest.php
@@ -85,4 +85,23 @@ public function testCanCountImages() {
         $this->assertSame($this->model, $this->model->setGroups(['group1' => [], 'group2' => []]));
         $this->assertSame(2, $this->model->getCount());
     }
+
+    /**
+     * @covers Imbo\Model\Groups::getData
+     */
+    public function testGetData() {
+        $this->model
+            ->setGroups(['group' => [], 'group2' => []])
+            ->setHits(10)
+            ->setPage(10)
+            ->setLimit(10);
+
+        $this->assertSame([
+            'groups' => ['group' => [], 'group2' => []],
+            'count' => 2,
+            'hits' => 10,
+            'limit' => 10,
+            'page' => 10,
+        ], $this->model->getData());
+    }
 }