Merge pull request #24 from sunrise-php/release/v2.1.0

v2.1.0

Author: fenric

README.md

@@ -12,7 +12,7 @@
 ## Installation
 
 ```bash
-composer require 'sunrise/http-header-kit:^2.0'
+composer require 'sunrise/http-header-kit:^2.1'
 ```
 
 ## How to use?
@@ -39,6 +39,20 @@ $response->header(...$header);
 
 > ⚠️ Note that in the examples below will use PSR-7.
 
+#### Custom header
+
+> Use this header if you can't find a suitable one below.
+
+```php
+use Sunrise\Http\Header\HeaderCustom;
+use Sunrise\Http\Message\ResponseFactory;
+
+$header = new HeaderCustom('X-Fiend-Name', 'field-value');
+
+(new ResponseFactory) ->createResponse()
+    ->withHeader(...$header);
+```
+
 #### Access-Control-Allow-Credentials
 
 > Usage link: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials

src/AbstractHeader.php

@@ -25,6 +25,8 @@
 
 /**
  * AbstractHeader
+ *
+ * @template-implements IteratorAggregate<int, string>
  */
 abstract class AbstractHeader implements HeaderInterface, IteratorAggregate
 {

src/HeaderAccessControlAllowHeaders.php

@@ -78,7 +78,7 @@ public function setValue(string ...$value) : self
     /**
      * Gets the header value
      *
-     * @return array<int, string>
+     * @return list<string>
      */
     public function getValue() : array
     {

src/HeaderAccessControlAllowMethods.php

@@ -81,7 +81,7 @@ public function setValue(string ...$value) : self
     /**
      * Gets the header value
      *
-     * @return array<int, string>
+     * @return list<string>
      */
     public function getValue() : array
     {

src/HeaderAccessControlAllowOrigin.php

@@ -99,9 +99,12 @@ public function getFieldValue() : string
             return '*';
         }
 
-        $value = $uri->getScheme() . '://' . $uri->getHost();
-        if (null !== $uri->getPort()) {
-            $value .= ':' . $uri->getPort();
+        $value = $uri->getScheme() . ':';
+        $value .= '//' . $uri->getHost();
+
+        $port = $uri->getPort();
+        if (null !== $port) {
+            $value .= ':' . $port;
         }
 
         return $value;

src/HeaderAccessControlExposeHeaders.php

@@ -78,7 +78,7 @@ public function setValue(string ...$value) : self
     /**
      * Gets the header value
      *
-     * @return array<string>
+     * @return list<string>
      */
     public function getValue() : array
     {

src/HeaderAllow.php

@@ -81,7 +81,7 @@ public function setValue(string ...$value) : self
     /**
      * Gets the header value
      *
-     * @return array<int, string>
+     * @return list<string>
      */
     public function getValue() : array
     {

src/HeaderClearSiteData.php

@@ -78,7 +78,7 @@ public function setValue(string ...$value) : self
     /**
      * Gets the header value
      *
-     * @return array<int, string>
+     * @return list<string>
      */
     public function getValue() : array
     {

src/HeaderContentLanguage.php

@@ -87,7 +87,7 @@ public function setValue(string ...$value) : self
     /**
      * Gets the header value
      *
-     * @return array<int, string>
+     * @return list<string>
      */
     public function getValue() : array
     {

src/HeaderCustom.php

@@ -0,0 +1,77 @@
+<?php declare(strict_types=1);
+
+/**
+ * It's free open-source software released under the MIT License.
+ *
+ * @author Anatoly Fenric <anatoly@fenric.ru>
+ * @copyright Copyright (c) 2018, Anatoly Fenric
+ * @license https://github.com/sunrise-php/http-header-kit/blob/master/LICENSE
+ * @link https://github.com/sunrise-php/http-header-kit
+ */
+
+namespace Sunrise\Http\Header;
+
+/**
+ * Import classes
+ */
+use InvalidArgumentException;
+
+/**
+ * HeaderCustom
+ */
+class HeaderCustom extends AbstractHeader implements HeaderInterface
+{
+
+    /**
+     * The header name
+     *
+     * @var string
+     */
+    protected $fieldName;
+
+    /**
+     * The header value
+     *
+     * @var string
+     */
+    protected $fieldValue;
+
+    /**
+     * Constructor of the class
+     *
+     * @param string $fieldName
+     * @param string $fieldValue
+     *
+     * @throws InvalidArgumentException
+     *         If the name or value isn't valid.
+     */
+    public function __construct(string $fieldName, string $fieldValue)
+    {
+        if (!preg_match(HeaderInterface::RFC7230_TOKEN, $fieldName)) {
+            throw new InvalidArgumentException(sprintf('Name of the header "%s" is not valid', $fieldName));
+        }
+
+        if (!preg_match(HeaderInterface::RFC7230_FIELD_VALUE, $fieldValue)) {
+            throw new InvalidArgumentException(sprintf('Value of the header "%s" is not valid', $fieldName));
+        }
+
+        $this->fieldName = $fieldName;
+        $this->fieldValue = $fieldValue;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFieldName() : string
+    {
+        return $this->fieldName;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFieldValue() : string
+    {
+        return $this->fieldValue;
+    }
+}