StreamContainerInterface

Author: sirn-se

Makefile

@@ -14,7 +14,7 @@ cs: composer.lock
 stan: composer.lock
 	./vendor/bin/phpstan analyse --memory-limit 256M
 
-coverage: composer.lock
+coverage: composer.lock clean-coverage
 	./vendor/bin/phpunit --coverage-clover coverage/clover.xml --coverage-html=coverage -d --min-coverage=100
 
 composer.phar:
@@ -25,7 +25,10 @@ composer.lock: composer.phar
 
 vendor/bin/phpunit: install
 
-clean:
-	rm composer.lock
-	rm -r vendor
-	rm -r coverage
+clean: clean-coverage
+	rm -f composer.lock
+	rm -rf vendor
+	rm -rf coverage
+
+clean-coverage:
+	rm -rf coverage

README.md

@@ -17,6 +17,11 @@ Install with [Composer](https://getcomposer.org/);
 composer require phrity/net-stream
 ```
 
+## Interfaces
+
+* [StreamInterface](docs/StreamInterface.md) - Interface indicating a Stream implementation
+* [StreamContainerInterface](docs/StreamContainerInterface.md) - Interface indicating a class containg a Stream
+
 ## Included classes
 
 * [Stream](docs/Stream.md) - PSR-7 StreamFactory compatible Stream class
@@ -33,6 +38,7 @@ composer require phrity/net-stream
 
 | Version | PHP | |
 | --- | --- | --- |
+| `2.4` | `^8.1` | StreamInterface, StreamContainerInterface |
 | `2.3` | `^8.1` | Float timeout, hasContents method, Listeners |
 | `2.2` | `^8.1` | Improved context handling |
 | `2.1` | `^8.0` | Set context on server |

composer.json

@@ -29,7 +29,6 @@
         "psr/http-message": "^1.1 | ^2.0"
     },
     "require-dev": {
-        "php-coveralls/php-coveralls": "^2.0",
         "phpstan/phpstan": "^2.0",
         "phpunit/phpunit": "^10.0 | ^11.0  | ^12.0",
         "phrity/net-uri": "^2.0",

docs/Stream.md

@@ -43,7 +43,7 @@ class Stream implements StreamInterface, Stringable
 
     // Additional methods
 
-     // Get stream context
+    // StreamInterface methods
     public function getContext(): Context;
     public function getResource(): resource;
 }

docs/StreamContainerInterface.md

@@ -0,0 +1,18 @@
+[Documentation](../README.md) / StreamContainerInterface
+
+# StreamContainerInterface
+
+Interface indicating a class containg a Stream.
+
+## Synopsis
+
+```php
+namespace Phrity\Net;
+
+interface StreamContainerInterface
+{
+    // Methods
+
+    public function getStream(): StreamInterface;
+}
+```

docs/StreamInterface.md

@@ -0,0 +1,19 @@
+[Documentation](../README.md) / StreamInterface
+
+# StreamInterface
+
+Interface indicating a Stream implementation.
+
+## Synopsis
+
+```php
+namespace Phrity\Net;
+
+interface StreamInterface extends Psr\Http\Message\StreamInterface
+{
+    // Methods
+
+    public function getContext(): Context;
+    public function getResource(): resource;
+}
+```

src/Stream.php

@@ -263,7 +263,7 @@ public function __toString(): string
     }
 
 
-    // ---------- Extended methods ------------------------------------------------------------------------------------
+    // ---------- StreamInterface methods -----------------------------------------------------------------------------
 
     /**
      * Return context for stream.

src/StreamCollection.php

@@ -15,7 +15,7 @@
 class StreamCollection implements Countable, Iterator
 {
     protected ErrorHandler $handler;
-    /** @var array<string, StreamInterface> */
+    /** @var array<string, StreamInterface|StreamContainerInterface> */
     private array $streams = [];
 
     /**
@@ -31,12 +31,12 @@ public function __construct()
 
     /**
      * Attach stream to collection.
-     * @param StreamInterface $attach Stream to attach.
+     * @param StreamInterface|StreamContainerInterface $attach Stream to attach.
      * @param string|null $key Definable name of stream.
      * @return string Name of stream.
      * @throws StreamException If already attached.
      */
-    public function attach(StreamInterface $attach, string|null $key = null): string
+    public function attach(StreamInterface|StreamContainerInterface $attach, string|null $key = null): string
     {
         if ($key && array_key_exists($key, $this->streams)) {
             throw new StreamException(StreamException::COLLECT_KEY_CONFLICT, ['key' => $key]);
@@ -48,10 +48,10 @@ public function attach(StreamInterface $attach, string|null $key = null): string
 
     /**
      * Detach stream from collection.
-     * @param StreamInterface|string $detach Stream or name of stream to detach.
+     * @param StreamInterface|StreamContainerInterface|string $detach Stream or name of stream to detach.
      * @return bool If a stream was detached.
      */
-    public function detach(StreamInterface|string $detach): bool
+    public function detach(StreamInterface|StreamContainerInterface|string $detach): bool
     {
         if (is_string($detach)) {
             if (array_key_exists($detach, $this->streams)) {
@@ -78,7 +78,7 @@ public function getReadable(): self
     {
         $readables = new self();
         foreach ($this->streams as $key => $stream) {
-            if ($stream->isReadable()) {
+            if ($this->getStream($stream)->isReadable()) {
                 $readables->attach($stream, $key);
             }
         }
@@ -93,7 +93,7 @@ public function getWritable(): self
     {
         $writables = new self();
         foreach ($this->streams as $key => $stream) {
-            if ($stream->isWritable()) {
+            if ($this->getStream($stream)->isWritable()) {
                 $writables->attach($stream, $key);
             }
         }
@@ -116,8 +116,8 @@ public function waitRead(int|float $timeout = 60): self
 
         $read = [];
         foreach ($this->streams as $key => $stream) {
-            if ($stream->isReadable()) {
-                $read[$key] = $stream->getResource();
+            if ($this->getStream($stream)->isReadable()) {
+                $read[$key] = $this->getStream($stream)->getResource();
             }
         }
         if (empty($read)) {
@@ -157,9 +157,9 @@ public function count(): int
 
     /**
      * Return the current stream.
-     * @return StreamInterface|null Current stream.
+     * @return StreamInterface|StreamContainerInterface|null Current stream.
      */
-    public function current(): StreamInterface|null
+    public function current(): StreamInterface|StreamContainerInterface|null
     {
         return current($this->streams) ?: null;
     }
@@ -212,4 +212,9 @@ protected function createKey(): string
         } while (array_key_exists($key, $this->streams));
         return $key;
     }
+
+    protected function getStream(StreamInterface|StreamContainerInterface $stream): StreamInterface
+    {
+        return $stream instanceof StreamInterface ? $stream : $stream->getStream();
+    }
 }

src/StreamContainerInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Phrity\Net;
+
+/**
+ * StreamContainerInterface.
+ */
+interface StreamContainerInterface
+{
+    /**
+     * @return StreamInterface
+     */
+    public function getStream(): StreamInterface;
+}