improved type declarations on FastCGI classes

swoole · Feb 16, 2024 · 4832d80 · 4832d80
1 parent 497bb74
commit 4832d80
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 12 deletions.
diff --git a/src/core/Coroutine/FastCGI/Client.php b/src/core/Coroutine/FastCGI/Client.php
@@ -17,6 +17,8 @@
 use Swoole\FastCGI\HttpRequest;
 use Swoole\FastCGI\HttpResponse;
 use Swoole\FastCGI\Record\EndRequest;
+use Swoole\FastCGI\Record\Stderr;
+use Swoole\FastCGI\Record\Stdout;
 use Swoole\FastCGI\Request;
 use Swoole\FastCGI\Response;
 
@@ -91,6 +93,7 @@ public function execute(Request $request, float $timeout = -1): Response
  $this->socket->close();
  $this->socket = null;
  }
+ /* @var array<Stdout|Stderr|EndRequest> $records */
  return match (true) {
  $request instanceof HttpRequest => new HttpResponse($records),
  default => new Response($records),

diff --git a/src/core/FastCGI/HttpResponse.php b/src/core/FastCGI/HttpResponse.php
@@ -11,6 +11,9 @@
 
 namespace Swoole\FastCGI;
 
+use Swoole\FastCGI\Record\EndRequest;
+use Swoole\FastCGI\Record\Stderr;
+use Swoole\FastCGI\Record\Stdout;
 use Swoole\Http\Status;
 
 class HttpResponse extends Response
@@ -21,15 +24,24 @@ class HttpResponse extends Response
  /** @var string */
  protected $reasonPhrase;
 
- /** @var array */
- protected $headers = [];
+ /**
+ * @var array<string, string>
+ */
+ protected array $headers = [];
 
- /** @var array */
- protected $headersMap = [];
+ /**
+ * @var array<string, string>
+ */
+ protected array $headersMap = [];
 
- /** @var array */
- protected $setCookieHeaderLines = [];
+ /**
+ * @var array<string>
+ */
+ protected array $setCookieHeaderLines = [];
 
+ /**
+ * @param array<Stdout|Stderr|EndRequest> $records
+ */
  public function __construct(array $records = [])
  {
  parent::__construct($records);
@@ -62,7 +74,7 @@ public function __construct(array $records = [])
  }
  }
  $statusCode = (int) ($statusCode ?? Status::OK);
- $reasonPhrase = (string) ($reasonPhrase ?? Status::getReasonPhrase($statusCode));
+ $reasonPhrase = $reasonPhrase ?? Status::getReasonPhrase($statusCode);
  $this->withStatusCode($statusCode)->withReasonPhrase($reasonPhrase);
  $this->withBody($body);
  }
@@ -95,6 +107,9 @@ public function getHeader(string $name): ?string
  return $name ? $this->headers[$name] : null;
  }
 
+ /**
+ * @return array<string, string>
+ */
  public function getHeaders(): array
  {
  return $this->headers;
@@ -107,6 +122,9 @@ public function withHeader(string $name, string $value): self
  return $this;
  }
 
+ /**
+ * @param array<string, string> $headers
+ */
  public function withHeaders(array $headers): self
  {
  foreach ($headers as $name => $value) {
@@ -115,6 +133,9 @@ public function withHeaders(array $headers): self
  return $this;
  }
 
+ /**
+ * @return array<string>
+ */
  public function getSetCookieHeaderLines(): array
  {
  return $this->setCookieHeaderLines;

diff --git a/src/core/FastCGI/Response.php b/src/core/FastCGI/Response.php
@@ -17,13 +17,16 @@
 
 class Response extends Message
 {
- public function __construct(array $records = [])
+ /**
+ * @param array<Stdout|Stderr|EndRequest> $records
+ */
+ public function __construct(array $records)
  {
  if (!static::verify($records)) {
  throw new \InvalidArgumentException('Bad records');
  }
- $body = '';
- $error = '';
+
+ $body = $error = '';
  foreach ($records as $record) {
  if ($record instanceof Stdout) {
  if ($record->getContentLength() > 0) {
@@ -38,8 +41,11 @@ public function __construct(array $records = [])
  $this->withBody($body)->withError($error);
  }
 
- public static function verify(array $records): bool
+ /**
+ * @param array<Stdout|Stderr|EndRequest> $records
+ */
+ protected static function verify(array $records): bool
  {
- return !empty($records) && $records[count($records) - 1] instanceof EndRequest;
+ return !empty($records) && $records[array_key_last($records)] instanceof EndRequest;
  }
 }