Merge pull request #507 from KnpLabs/v2-unstable-wkhtmltopdf-headers-…

…and-footer-options

feat: implement wkhtmltopdf backend headers and footers options

src/Backend/WkHtmlToPdf/ExtraOption.php

@@ -5,6 +5,8 @@
 namespace KNPLabs\Snappy\Backend\WkHtmlToPdf;
 
 interface ExtraOption {
+    public function isRepeatable(): bool;
+
     /** @return array<string|int|float> */
     public function compile(): array;
 }

src/Backend/WkHtmlToPdf/ExtraOption/CookieJarOption.php

@@ -10,6 +10,11 @@ final class CookieJarOption implements ExtraOption
 {
     public function __construct(public readonly string $path) {}
 
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
     public function compile(): array
     {
         return ['--no-collate'];

src/Backend/WkHtmlToPdf/ExtraOption/CopiesOption.php

@@ -13,6 +13,11 @@ final class CopiesOption implements ExtraOption
      */
     public function __construct(private readonly int $number) {}
 
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
     public function compile(): array
     {
         return ['--copies', $this->number];

src/Backend/WkHtmlToPdf/ExtraOption/DpiOption.php

@@ -13,6 +13,11 @@ final class DpiOptions implements ExtraOption
      */
     public function __construct(private readonly int $dpi) {}
 
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
     public function compile(): array
     {
         return ['--dpi', $this->dpi];

src/Backend/WkHtmlToPdf/ExtraOption/FooterCenterOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class FooterCenterOption implements ExtraOption
+{
+    public function __construct(public readonly string $text) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--footer-center', $this->text];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/FooterFontNameOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class FooterFontNameOption implements ExtraOption
+{
+    public function __construct(public readonly string $fontName) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--footer-font-name', $this->fontName];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/FooterFontSizeOption.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class FooterFontSizeOption implements ExtraOption
+{
+    /**
+     * @param positive-int $size
+     */
+    public function __construct(public readonly int $size) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--footer-font-size', $this->size];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/FooterHtmlOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class FooterHtmlOption implements ExtraOption
+{
+    public function __construct(public readonly string $uri) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--footer-html', $this->uri];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/FooterLeftOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class FooterLeftOption implements ExtraOption
+{
+    public function __construct(public readonly string $text) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--footer-left', $this->text];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/CollateOption.php → src/Backend/WkHtmlToPdf/ExtraOption/FooterLineOption.php

@@ -6,12 +6,15 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-final class CollateOption implements ExtraOption
+final class FooterLineOption implements ExtraOption
 {
-    public function __construct() {}
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
 
     public function compile(): array
     {
-        return ['--collate'];
+        return ['--footer-line'];
     }
 }

src/Backend/WkHtmlToPdf/ExtraOption/FooterRightOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class FooterRightOption implements ExtraOption
+{
+    public function __construct(public readonly string $text) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--footer-right', $this->text];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/FooterSpacingOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class FooterSpacingOption implements ExtraOption
+{
+    public function __construct(public readonly int $spacing) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--footer-spacing', $this->spacing];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/GrayscaleOption.php

@@ -8,7 +8,10 @@
 
 final class GrayscaleOption implements ExtraOption
 {
-    public function __construct() {}
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
 
     public function compile(): array
     {

src/Backend/WkHtmlToPdf/ExtraOption/HeaderCenterOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class HeaderCenterOption implements ExtraOption
+{
+    public function __construct(public readonly string $text) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--header-center', $this->text];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/HeaderFontNameOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class HeaderFontNameOption implements ExtraOption
+{
+    public function __construct(public readonly string $fontName) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--header-font-name', $this->fontName];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/HeaderFontSizeOption.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class HeaderFontSizeOption implements ExtraOption
+{
+    /**
+     * @param positive-int $size
+     */
+    public function __construct(public readonly int $size) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--header-font-size', $this->size];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/HeaderHtmlOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class HeaderHtmlOption implements ExtraOption
+{
+    public function __construct(public readonly string $uri) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--header-html', $this->uri];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/HeaderLeftOption.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
+
+final class HeaderLeftOption implements ExtraOption
+{
+    public function __construct(public readonly string $text) {}
+
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
+    public function compile(): array
+    {
+        return ['--header-left', $this->text];
+    }
+}

src/Backend/WkHtmlToPdf/ExtraOption/Outline.php → src/Backend/WkHtmlToPdf/ExtraOption/HeaderLineOption.php

@@ -6,10 +6,15 @@
 
 use KNPLabs\Snappy\Backend\WkHtmlToPdf\ExtraOption;
 
-class Outline implements ExtraOption
+final class HeaderLineOption implements ExtraOption
 {
+    public function isRepeatable(): bool
+    {
+        return false;
+    }
+
     public function compile(): array
     {
-        return ['--outline'];
+        return ['--header-line'];
     }
-}
+}