Merge branch 'modern-language-changes' into v2.0

Author: michaelsavchuk

README.md

@@ -30,19 +30,17 @@ require 'vendor/autoload.php';
 
 ### Get an icon
 
-Icons echo by default.
-
 ```php
 <?php
 require 'vendor/autoload.php';
-$icons = new Feather\Icons;
+$icons = new Feather\Icons();
 ?>
 
 <!-- Display the 'anchor' icon !-->
-<?php $icons->get('feather'); ?>
+<?php echo $icons->get('feather'); ?>
 
 <!-- Get creative! !-->
-<button class="icon-button">Learn More <?php $icons->get('arrow-right'); ?></button>
+<button class="icon-button">Learn More <?php echo $icons->get('arrow-right'); ?></button>
 ```
 
 ### Get an icon with modified properties
@@ -67,45 +65,32 @@ $icons->get('mail');
 // <svg ... color="red" stroke-width="3" ... >...</svg>
 ```
 
-### Get an icon as a string
-
-Set the third argument to `false` to get a string instead of echoing the icon.
-
-```php
-$icon_string = $icons->get('activity', array(), false);
-// Then do whatever with $icon_string
-```
-
 ## API
 
 ### `Feather\Icons`
 
 Usage:
 
 ```php
-$icons = new Feather\Icons;
+$icons = new Feather\Icons();
 ```
 
 <br>
 
-### `Feather\Icons->get($name, $attributes = array(), $echo = true)`
+### `Feather\Icons->get($name, $attributes = array())`
 
-Gets an icon as svg. Can be echoed (default) or returned as a string. Attributes passed will be merged over the class defaults.
+Gets an icon as a string. Attributes passed will be merged over the class defaults.
 
 ```php
-$icons = new Feather\Icons;
+$icons = new Feather\Icons();
 
-// Echo an icon
-$icons->get('anchor');
+// Get an icon
+echo $icons->get('anchor');
 // <svg ... >...</svg>
 
-// Echo an icon with modified properties
-$icons->get('battery', array('class' => 'fooclass', 'stroke-width' => 1, 'aria-label' => 'Battery icon'));
+// Get an icon with modified properties
+echo $icons->get('battery', array('class' => 'fooclass', 'stroke-width' => 1, 'aria-label' => 'Battery icon'));
 // <svg ... class="feather feather-battery fooclass", stroke-width="1", aria-label="Battery icon" ... >...</svg>
-
-// Get an icon as a string without echoing it
-$cloud_icon = $icons->get('cloud', array(), false);
-doStuffWith($cloud_icon);
 ```
 
 #### Arguments
@@ -114,7 +99,6 @@ doStuffWith($cloud_icon);
 |------------|-------|---------------------------------------------------------------------------------|
 |$name       |string |The name of the icon. A full list can be found [here](https://feathericons.com/).|
 |$attributes?|array  |Attributes to modify/add (see 'Usage' above for example)                         |
-|$echo?      |boolean|Whether to echo the icon svg (true) or not (false)                               |
 
 <br>
 
@@ -124,7 +108,7 @@ Sets default attributes of the class. These are used as default attributes for t
 disable this by setting the `$merge` argument to false, but only do it if you know what you are doing.
 
 ```php
-$icons = new Feather\Icons;
+$icons = new Feather\Icons();
 
 // Set some default attributes (this will be merged with the current defaults in the class)
 $icons->setAttributes(array('color' => 'red', 'stroke-width' => 3));
@@ -148,7 +132,7 @@ $icons->get('delete');
 Get the current attributes for the class. To set it, use the `setAttributes()` method;
 
 ```php
-$icons = new Feather\Icons;
+$icons = new Feather\Icons();
 
 $attrs = $icons->getAttributes();
 ```
@@ -160,7 +144,7 @@ $attrs = $icons->getAttributes();
 Constant array of default attributes. They are applied to every new `Icons` class. You can use this to reset the attributes of an `Icons` class.
 
 ```php
-$icons = new Feather\Icons;
+$icons = new Feather\Icons();
 
 // Add/modify some default attributes
 $icons->setAttributes( ... );

src/Exception/IconNotFoundException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Feather\Exception;
+
+class IconNotFoundException extends \Exception
+{
+
+}

src/Icons.php

@@ -2,6 +2,8 @@
 
 namespace Feather;
 
+use Feather\Exception\IconNotFoundException;
+
 require __DIR__ . '/defaultAttributes.php';
 
 class Icons
@@ -15,7 +17,7 @@ public function __construct()
         $this->icons = require implode(DIRECTORY_SEPARATOR, [dirname(__FILE__), '..', 'resources', 'icons.php']);
     }
 
-    public function get($name, $attributes = [], $echo = true)
+    public function get(string $name, array $attributes = []): string
     {
         if (isset($this->icons[$name])) {
             $contents   = $this->icons[$name];
@@ -47,26 +49,24 @@ function ($final, $current) use ($attributes) {
 
             $icon = '<svg ' . $dom_attributes . '>' . $contents . '</svg>';
 
-            if ($echo) {
-                echo $icon;
-            } else {
-                return $icon;
-            }
+            return $icon;
         }
 
-        return false;
+        throw new IconNotFoundException(\sprintf('Icon `%s` not found', $name));
     }
 
-    public function setAttributes($attributes, $merge = true)
+    public function setAttributes(array $attributes, bool $merge = true): self
     {
         if ($merge) {
             $this->attributes = array_merge($this->attributes, $attributes);
         } else {
             $this->attributes = $attributes;
         }
+
+        return $this;
     }
 
-    public function getAttributes()
+    public function getAttributes(): array
     {
         return $this->attributes;
     }

tests/FeatherTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Feather\Exception\IconNotFoundException;
 use PHPUnit\Framework\TestCase;
 
 class FeatherTest extends TestCase
@@ -36,27 +37,27 @@ protected function setUp(): void
         );
     }
 
-    public function testIconsHasDefaultAttributes()
+    public function testIconsHasDefaultAttributes(): void
     {
         $this->assertEquals(Feather\DEFAULT_ATTRIBUTES, $this->icons->getAttributes());
     }
 
-    public function testIconDefaultXML()
+    public function testIconDefaultXML(): void
     {
         foreach ($this->XMLTestData as $test_data) {
             $this->assertXMLStringEqualsXMLString(
                 $test_data['xml'],
-                $this->icons->get($test_data['name'], [], false),
+                $this->icons->get($test_data['name'], []),
                 'Icon fail: ' . $test_data['name']
             );
         }
     }
 
-    public function testIconXMLWithAttributes()
+    public function testIconXMLWithAttributes(): void
     {
         $test_data = $this->AttributeTestData;
 
-        $icon = $this->icons->get($test_data['name'], $test_data['attributes'], false);
+        $icon = $this->icons->get($test_data['name'], $test_data['attributes']);
 
         $this->assertXMLStringEqualsXMLString(
             $test_data['xml'],
@@ -65,12 +66,12 @@ public function testIconXMLWithAttributes()
         );
     }
 
-    public function testIconXMLWithAttributesFromClass()
+    public function testIconXMLWithAttributesFromClass(): void
     {
         $test_data = $this->AttributeTestData;
 
         $this->icons->setattributes($test_data['attributes']);
-        $icon = $this->icons->get($test_data['name'], [], false);
+        $icon = $this->icons->get($test_data['name'], []);
 
         $this->assertXMLStringEqualsXMLString(
             $test_data['xml'],
@@ -80,4 +81,11 @@ public function testIconXMLWithAttributesFromClass()
 
         $this->icons->setAttributes(Feather\DEFAULT_ATTRIBUTES);
     }
+
+    public function testIconNotFound(): void
+    {
+        $this->expectException(IconNotFoundException::class);
+
+        $this->icons->get('icon-that-should-not-be-found');
+    }
 }