Add image candidate set type getter

Author: jkphl

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Scrutinizer Code Quality][scrutinizer-image]][scrutinizer-url] [![Code Climate][codeclimate-image]][codeclimate-url]  [![Clear architecture][clear-architecture-image]][clear-architecture-url]
 
-> PHP library for translating HTML responsive images to CSS (sort of ...)
+> PHP library for translating HTML5 responsive images to CSS background images (sort of ...)
 
 ## Documentation
 

src/Respimgcss/Application/Contract/ImageCandidateSetInterface.php

@@ -44,10 +44,17 @@
  */
 interface ImageCandidateSetInterface extends \Jkphl\Respimgcss\Domain\Contract\ImageCandidateSetInterface
 {
+    /**
+     * Return the image candidate set type
+     *
+     * @return string|null Image candidate set type
+     */
+    public function getType(): string;
+
     /**
      * Return all image candidates as an array
      *
-     * @return array
+     * @return array Image candidates
      */
     public function toArray(): array;
 }

src/Respimgcss/Application/Model/ImageCandidateSet.php

@@ -53,7 +53,7 @@ class ImageCandidateSet extends \Jkphl\Respimgcss\Domain\Model\ImageCandidateSet
      *
      * @var string
      */
-    protected $type;
+    protected $type = null;
     /**
      * Image candidate values
      *
@@ -115,10 +115,20 @@ public function offsetSet($offset, $value): void
     /**
      * Return all image candidates as an array
      *
-     * @return array
+     * @return array Image candidates
      */
     public function toArray(): array
     {
         return $this->imageCandidates;
     }
+
+    /**
+     * Return the image candidate set type
+     *
+     * @return string|null Image candidate set type
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
 }

src/Respimgcss/Tests/Application/ImageCandidateSetTest.php

@@ -37,6 +37,7 @@
 namespace Jkphl\Respimgcss\Tests\Application;
 
 use Jkphl\Respimgcss\Application\Model\ImageCandidateSet;
+use Jkphl\Respimgcss\Domain\Contract\ImageCandidateInterface;
 use Jkphl\Respimgcss\Domain\Model\DensityImageCandidate;
 use Jkphl\Respimgcss\Domain\Model\WidthImageCandidate;
 use Jkphl\Respimgcss\Tests\AbstractTestBase;
@@ -59,6 +60,7 @@ public function testImageCandidateSetInconsistentType()
     {
         $imageCandidateSet = new ImageCandidateSet(new DensityImageCandidate('image.jpg', 1));
         $this->assertInstanceOf(ImageCandidateSet::class, $imageCandidateSet);
+        $this->assertEquals(ImageCandidateInterface::TYPE_DENSITY, $imageCandidateSet->getType());
 
         $imageCandidateSet[] = new DensityImageCandidate('image.jpg', 2);
         $imageCandidateSet[] = new DensityImageCandidate('image.jpg', 3);