Merge branch 'psr-7'

Author: lkrms

src/Curler/Contract/ICurlerPage.php

@@ -2,7 +2,7 @@
 
 namespace Lkrms\Curler\Contract;
 
-use Lkrms\Http\Contract\IHttpHeaders;
+use Lkrms\Http\Contract\HttpHeadersInterface;
 
 interface ICurlerPage
 {
@@ -42,5 +42,5 @@ public function nextData(): ?array;
      *
      * Return `null` to use the same headers sent with the last request.
      */
-    public function nextHeaders(): ?IHttpHeaders;
+    public function nextHeaders(): ?HttpHeadersInterface;
 }

src/Curler/Curler.php

@@ -22,7 +22,7 @@
 use Lkrms\Http\Catalog\HttpHeader;
 use Lkrms\Http\Catalog\HttpHeaderGroup;
 use Lkrms\Http\Catalog\HttpRequestMethod;
-use Lkrms\Http\Contract\IHttpHeaders;
+use Lkrms\Http\Contract\HttpHeadersInterface;
 use Lkrms\Http\HttpHeaders;
 use Lkrms\Iterator\RecursiveCallbackIterator;
 use Lkrms\Iterator\RecursiveMutableGraphIterator;
@@ -44,13 +44,13 @@
  * A (very) lightweight Guzzle alternative.
  *
  * @property-read string $BaseUrl Resource URL (no query or fragment)
- * @property-read IHttpHeaders $Headers Request headers
+ * @property-read HttpHeadersInterface $Headers Request headers
  * @property-read string|null $Method Most recent request method
  * @property-read string|null $QueryString Query string most recently added to request URL
  * @property-read string|mixed[]|null $Body Request body, as passed to cURL
  * @property-read string|mixed[]|object|null $Data Request body, before serialization
  * @property-read ICurlerPager|null $Pager Pagination handler
- * @property-read IHttpHeaders|null $ResponseHeaders Response headers
+ * @property-read HttpHeadersInterface|null $ResponseHeaders Response headers
  * @property-read array<string,string>|null $ResponseHeadersByName An array that maps lowercase response headers to their combined values
  * @property-read int|null $StatusCode Response status code
  * @property-read string|null $ReasonPhrase Response status explanation
@@ -98,7 +98,7 @@ final class Curler implements IReadable, IWritable, Buildable
     /**
      * Request headers
      *
-     * @var IHttpHeaders
+     * @var HttpHeadersInterface
      */
     protected $Headers;
 
@@ -143,7 +143,7 @@ final class Curler implements IReadable, IWritable, Buildable
     /**
      * Response headers
      *
-     * @var IHttpHeaders|null
+     * @var HttpHeadersInterface|null
      */
     protected $ResponseHeaders;
 
@@ -441,7 +441,7 @@ final class Curler implements IReadable, IWritable, Buildable
      */
     public function __construct(
         string $baseUrl,
-        ?IHttpHeaders $headers = null,
+        ?HttpHeadersInterface $headers = null,
         ?ICurlerPager $pager = null,
         bool $cacheResponse = false,
         bool $cachePostResponse = false,
@@ -562,7 +562,7 @@ public function setContentType(?string $mimeType)
      *
      * @return $this
      */
-    public function withHeaders(IHttpHeaders $headers)
+    public function withHeaders(HttpHeadersInterface $headers)
     {
         $clone = $this->clone();
         $clone->Headers = $headers;
@@ -1073,7 +1073,7 @@ private function getCacheKey(): ?string
     /**
      * @param mixed[]|null $query
      */
-    public function head(?array $query = null): IHttpHeaders
+    public function head(?array $query = null): HttpHeadersInterface
     {
         return $this->process(HttpRequestMethod::HEAD, $query);
     }

src/Curler/CurlerBuilder.php

@@ -46,7 +46,7 @@ public function prepareCurler(Curler $curler): Curler
         if ($this->MaxPageSize === null) {
             return $curler;
         }
-        /** @todo implement `Prefer` header wrangling in `IHttpHeaders`? */
+        /** @todo wrangle `Prefer` headers in `HttpHeadersInterface`? */
         $preference = sprintf('odata.maxpagesize=%d', $this->MaxPageSize);
         $value = $curler->Headers->getHeader(HttpHeader::PREFER);
         $pattern = '/^odata\.maxpagesize\h*=/i';

src/Curler/Pager/ODataPager.php

@@ -5,7 +5,7 @@
 use Lkrms\Curler\Contract\ICurlerPage;
 use Lkrms\Curler\Curler;
 use Lkrms\Exception\AssertionFailedException;
-use Lkrms\Http\Contract\IHttpHeaders;
+use Lkrms\Http\Contract\HttpHeadersInterface;
 
 /**
  * Implements ICurlerPage
@@ -38,7 +38,7 @@ final class CurlerPage implements ICurlerPage
     private $NextData;
 
     /**
-     * @var IHttpHeaders|null
+     * @var HttpHeadersInterface|null
      */
     private $NextHeaders;
 
@@ -48,7 +48,7 @@ final class CurlerPage implements ICurlerPage
      * @param null|string $nextUrl The URL of the next page, including the query component (if any)
      * @param null|bool $isLastPage Set if no more data is available
      * @param null|mixed[] $nextData Data to send in the body of the next request
-     * @param null|IHttpHeaders $nextHeaders Replaces the next request's HTTP headers
+     * @param null|HttpHeadersInterface $nextHeaders Replaces the next request's HTTP headers
      */
     public function __construct(
         array $entities,
@@ -57,7 +57,7 @@ public function __construct(
         ?string $nextUrl = null,
         ?bool $isLastPage = null,
         ?array $nextData = null,
-        ?IHttpHeaders $nextHeaders = null
+        ?HttpHeadersInterface $nextHeaders = null
     ) {
         $this->Entities = $entities;
         $this->EntityCount = count($entities) + ($previous ? $previous->entityCount() : 0);
@@ -106,7 +106,7 @@ final public function nextData(): ?array
         return $this->NextData;
     }
 
-    final public function nextHeaders(): ?IHttpHeaders
+    final public function nextHeaders(): ?HttpHeadersInterface
     {
         $this->assertHasNextPage();
 

src/Curler/Support/CurlerPage.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Exception;
+
+use Lkrms\Utility\Get;
+
+/**
+ * Thrown when a function receives an argument that is not of the required type
+ */
+class InvalidArgumentTypeException extends \Lkrms\Exception\InvalidArgumentException
+{
+    /**
+     * @param int $position The argument number (1-based).
+     * @param string $name The name of the argument.
+     * @param string $type The expected type.
+     * @param mixed $value The value given.
+     */
+    public function __construct(int $position, string $name, string $type, $value)
+    {
+        parent::__construct(sprintf(
+            'Argument #%d ($%s) must be of type %s, %s given',
+            $position,
+            ltrim($name, '$'),
+            $type,
+            Get::type($value)
+        ));
+    }
+}

src/Curler/Support/CurlerPageBuilder.php

@@ -2,7 +2,7 @@
 
 namespace Lkrms\Http\Contract;
 
-interface IAccessToken
+interface AccessTokenInterface
 {
     /**
      * Get the object's token string

src/Exception/InvalidArgumentTypeException.php

@@ -4,25 +4,25 @@
 
 use Lkrms\Contract\Arrayable;
 use Lkrms\Contract\ICollection;
-use Lkrms\Contract\IImmutable;
 use Lkrms\Http\Catalog\HttpHeader;
 
 /**
  * A collection of HTTP headers
  *
  * @extends ICollection<string,string[]>
  */
-interface IHttpHeaders extends ICollection, IImmutable
+interface HttpHeadersInterface extends ICollection
 {
     /**
      * Parse and apply an HTTP header field or continuation thereof
      *
      * This method should be called once per HTTP header line. Each line must
      * have a trailing CRLF. If an empty line (`"\r\n"`) is given, subsequent
-     * headers applied via {@see IHttpHeaders::addLine()} are flagged as
-     * trailers. Aside from {@see IHttpHeaders::trailers()} and
-     * {@see IHttpHeaders::withoutTrailers()}, {@see IHttpHeaders} methods make
-     * no distinction between trailers and other headers.
+     * headers applied via {@see HttpHeadersInterface::addLine()} are flagged as
+     * trailers. Aside from {@see HttpHeadersInterface::trailers()} and
+     * {@see HttpHeadersInterface::withoutTrailers()},
+     * {@see HttpHeadersInterface} methods make no distinction between trailers
+     * and other headers.
      *
      * @param bool $strict If `true`, throw an exception if `$line` is not
      * \[RFC7230]-compliant.
@@ -65,7 +65,7 @@ public function merge($items, bool $preserveExisting = false);
      * @return static
      */
     public function authorize(
-        IAccessToken $token,
+        AccessTokenInterface $token,
         string $headerName = HttpHeader::AUTHORIZATION
     );
 

src/Http/Contract/IAccessToken.php renamed to src/Http/Contract/AccessTokenInterface.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Http\Exception;
+
+/**
+ * Thrown when a stream wrapper receives a request it cannot service because it
+ * has been detached from the underlying PHP stream
+ */
+class StreamDetachedException extends \Lkrms\Exception\Exception {}