Merge pull request #50 from kiwilan/develop

v2.0.11

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "kiwilan/php-opds",
   "description": "PHP package to create OPDS feed for eBooks.",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "keywords": [
     "php",
     "ebook",

src/Engine/OpdsJsonEngine.php

@@ -57,7 +57,7 @@ public function feed(): self
             ];
         }
 
-        if ($this->opds->getConfig()->getStartUrl() && ! $this->opds->getConfig()->isForceJson()) {
+        if ($this->opds->getConfig()->getStartUrl() && ! $this->opds->getConfig()->isUseForceJson()) {
             $this->contents['links'][] = $this->addJsonLink(
                 rel: 'alternate',
                 href: $this->getVersionUrl(OpdsVersionEnum::v1Dot2),

src/Opds.php

@@ -48,7 +48,7 @@ public static function make(OpdsConfig $config = new OpdsConfig()): self
         $self->url = OpdsEngine::getCurrentUrl();
         $self->parseUrl();
 
-        if ($config->isForceJson()) {
+        if ($config->isUseForceJson()) {
             $self->version = OpdsVersionEnum::v2Dot0;
         }
 
@@ -125,7 +125,7 @@ public function get(): self
             $this->version = $this->queryVersion;
         }
 
-        if ($this->config->isForceJson()) {
+        if ($this->config->isUseForceJson()) {
             $this->version = OpdsVersionEnum::v2Dot0;
         }
 
@@ -146,6 +146,10 @@ public function get(): self
         }
         $this->response = OpdsResponse::make($this->engine->__toString(), $this->output, 200);
 
+        if ($this->config->isUseForceExit()) {
+            $this->response->forceExit();
+        }
+
         return $this;
     }
 

src/OpdsConfig.php

@@ -21,6 +21,7 @@ class OpdsConfig
      * @param  ?DateTime  $updated  Updated date, for example: `new DateTime()`.
      * @param  int  $maxItemsPerPage  Maximum items per page, default is `32`.
      * @param  bool  $forceJson  Force OPDS version 2.0 as default, default is `false`.
+     * @param  bool  $forceExit  Force send response as default, default is `false`.
      */
     public function __construct(
         protected ?string $name = 'opds',
@@ -34,6 +35,7 @@ public function __construct(
         protected ?DateTime $updated = null,
         protected int $maxItemsPerPage = 16,
         protected bool $forceJson = false,
+        protected bool $forceExit = false,
     ) {
         if (! $this->updated) {
             $this->updated = new DateTime();
@@ -90,11 +92,16 @@ public function getMaxItemsPerPage(): int
         return $this->maxItemsPerPage;
     }
 
-    public function isForceJson(): bool
+    public function isUseForceJson(): bool
     {
         return $this->forceJson;
     }
 
+    public function isUseForceExit(): bool
+    {
+        return $this->forceExit;
+    }
+
     public function setName(string $name): self
     {
         $this->name = $name;
@@ -176,6 +183,13 @@ public function forceJson(): self
         return $this;
     }
 
+    public function forceExit(): self
+    {
+        $this->forceExit = true;
+
+        return $this;
+    }
+
     /**
      * Laravel export
      * Generate a URL friendly "slug" from a given string.

src/OpdsResponse.php

@@ -15,6 +15,7 @@ protected function __construct(
         protected bool $isXml = false,
         protected array $headers = [],
         protected ?string $contents = null,
+        protected ?bool $forceExit = null,
     ) {
     }
 
@@ -93,6 +94,14 @@ public function getContents(): string
         return $this->contents;
     }
 
+    /**
+     * To know if `exit` will be used after sending response.
+     */
+    public function isUseForceExit(): bool
+    {
+        return $this->forceExit ?? false;
+    }
+
     /**
      * Get contents as array.
      *
@@ -156,13 +165,27 @@ public function setContents(string $contents): self
         return $this;
     }
 
+    /**
+     * Force `exit` after sending response.
+     */
+    public function forceExit(): self
+    {
+        $this->forceExit = true;
+
+        return $this;
+    }
+
     /**
      * Send content to browser with correct header.
      *
      * @param  bool  $exit  To use `exit` after sending response.
      */
     public function send(bool $exit = false): string
     {
+        if ($this->forceExit !== null && $this->forceExit && ! $exit) {
+            $exit = true;
+        }
+
         foreach ($this->headers as $type => $value) {
             header($type.': '.$value);
         }

tests/OpdsConfigTest.php

@@ -27,7 +27,7 @@
     expect($config->getPaginationQuery())->toBe('pagination');
     expect($config->getUpdated())->toBeInstanceOf(DateTime::class);
     expect($config->getMaxItemsPerPage())->toBe(10);
-    expect($config->isForceJson())->toBeTrue();
+    expect($config->isUseForceJson())->toBeTrue();
 });
 
 it('can use slug', function () {

tests/OpdsResponseTest.php

@@ -84,3 +84,28 @@
     expect($response->isJson())->toBeFalse();
     expect(fn () => $response->getJson())->toThrow(\Exception::class);
 });
+
+it('can use force exit', function () {
+    $html = '<!DOCTYPE html>';
+    $config = new OpdsConfig();
+    $config->forceExit();
+    $opds = Opds::make($config);
+
+    $engine = OpdsXmlEngine::make($opds);
+    $engine->setContents(['html' => $html]);
+
+    expect($engine->getContents())->toBe(['html' => $html]);
+
+    $response = $opds->getResponse();
+    expect($response->isUseForceExit())->toBeTrue();
+
+    $opds = Opds::make();
+
+    $engine = OpdsXmlEngine::make($opds);
+    $engine->setContents(['html' => $html]);
+
+    expect($engine->getContents())->toBe(['html' => $html]);
+
+    $response = $opds->getResponse();
+    expect($response->isUseForceExit())->toBeFalse();
+});