Create 1.x branch

.gitattributes

@@ -1,6 +1,8 @@
+/bin export-ignore
 /docs export-ignore
 /tests export-ignore
 /.php-cs-fixer.dist.php export-ignore
+/composer-dependency-analyser.php export-ignore
 /phpstan.neon export-ignore
 /phpunit.xml export-ignore
 /.git* export-ignore

.php-cs-fixer.dist.php

@@ -2,6 +2,7 @@
 
 $finder = (new PhpCsFixer\Finder())
     ->in([
+        __DIR__ . '/bin',
         __DIR__ . '/config',
         __DIR__ . '/docs',
         __DIR__ . '/src',

.phpstorm.meta.php

@@ -2,14 +2,7 @@
 
 namespace PHPSTORM_META {
     expectedArguments(
-        \Sensiolabs\GotenbergBundle\Builder\Pdf\AbstractPdfBuilder::fileName(),
-        1,
-        \Symfony\Component\HttpFoundation\HeaderUtils::DISPOSITION_INLINE,
-        \Symfony\Component\HttpFoundation\HeaderUtils::DISPOSITION_ATTACHMENT,
-    );
-
-    expectedArguments(
-        \Sensiolabs\GotenbergBundle\Builder\Screenshot\AbstractScreenshotBuilder::fileName(),
+        \Sensiolabs\GotenbergBundle\Builder\AbstractBuilder::fileName(),
         1,
         \Symfony\Component\HttpFoundation\HeaderUtils::DISPOSITION_INLINE,
         \Symfony\Component\HttpFoundation\HeaderUtils::DISPOSITION_ATTACHMENT,

README.md

@@ -245,7 +245,8 @@ class YourController
 6. [Merge Builder](./docs/pdf/merge-builder.md)
 7. [Convert Builder](./docs/pdf/convert-builder.md)
 8. [Split Builder](./docs/pdf/split-builder.md)
-9. [PDF customization](./docs/pdf/customization.md) (available for every builder except LibreOffice, Merge and Split)
+9. [Flatten Builder](./docs/pdf/flatten-builder.md)
+10. [PDF customization](./docs/pdf/customization.md) (available for HTML, Markdown and Url builder)
 
 #### Screenshot
 

bin/config.dump-reference

@@ -0,0 +1,23 @@
+#!/usr/bin/env php
+<?php
+
+use Sensiolabs\GotenbergBundle\DependencyInjection\SensiolabsGotenbergExtension;
+use Sensiolabs\GotenbergBundle\SensiolabsGotenbergBundle;
+use Symfony\Component\Config\Definition\Dumper\YamlReferenceDumper;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+require dirname(__DIR__).'/vendor/autoload.php';
+
+$yamlDumper = new YamlReferenceDumper();
+
+$containerBuilder = new ContainerBuilder();
+$gotenbergBundle = new SensiolabsGotenbergBundle();
+
+$containerBuilder->registerExtension($gotenbergBundle->getContainerExtension());
+
+$gotenbergBundle->build($containerBuilder);
+
+/** @var SensiolabsGotenbergExtension $gotenbergExtension */
+$gotenbergExtension = $containerBuilder->getExtension('sensiolabs_gotenberg');
+
+echo $yamlDumper->dump($gotenbergExtension->getConfiguration([], $containerBuilder));

composer-dependency-analyser.php

@@ -8,6 +8,7 @@
 $config = new Configuration();
 
 return $config
+    ->addPathToScan(__DIR__.'/bin', isDev: true)
     ->addPathToScan(__DIR__.'/src', isDev: false)
     ->addPathToScan(__DIR__.'/src/DataCollector', isDev: true)
     ->addPathToScan(__DIR__.'/src/Debug', isDev: true)

composer.json

@@ -22,6 +22,7 @@
     ],
     "require": {
         "php": ">=8.1",
+        "ext-json": "*",
         "psr/container": "^2.0",
         "psr/log": "^3.0",
         "symfony/config": "^6.4 || ^7.0",
@@ -49,6 +50,7 @@
         "symfony/stopwatch": "^6.4 || ^7.0",
         "symfony/twig-bundle": "^6.4 || ^7.0",
         "symfony/var-dumper": "^6.4 || ^7.0",
+        "symfony/yaml": "^6.4 || ^7.0",
         "twig/twig": "^3.14"
     },
     "config": {
@@ -59,6 +61,7 @@
     },
     "suggest": {
         "symfony/monolog-bundle": "Enables logging througout the generating process.",
+        "symfony/routing": "Allows you to use webhook to generate URL or route.",
         "symfony/twig-bundle": "Allows you to use Twig to render templates into PDF.",
         "monolog/monolog": "Enables logging througout the generating process.",
         "async-aws/s3": "Upload any file to aws s3 compatible endpoints supporting multi part upload without memory overhead.",

config/builder.php

@@ -0,0 +1,38 @@
+<?php
+
+use Sensiolabs\GotenbergBundle\Builder\AbstractBuilder;
+use Sensiolabs\GotenbergBundle\Configurator\BuilderConfigurator;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\abstract_arg;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\service_locator;
+
+return static function (ContainerConfigurator $container): void {
+    $services = $container->services();
+
+    $services->defaults()
+        ->tag('monolog.logger', ['channel' => 'sensiolabs_gotenberg'])
+    ;
+
+    $services->set('.sensiolabs_gotenberg.abstract_builder', AbstractBuilder::class)
+        ->abstract()
+        ->args([
+            service('sensiolabs_gotenberg.client'),
+            service_locator([
+                'asset_base_dir_formatter' => service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
+                'webhook_configuration_registry' => service('.sensiolabs_gotenberg.webhook_configuration_registry'),
+                'logger' => service('logger')->nullOnInvalid(),
+                'request_stack' => service('request_stack')->nullOnInvalid(),
+                'router' => service('router.default')->nullOnInvalid(),
+                'twig' => service('twig')->nullOnInvalid(),
+            ]),
+        ])
+    ;
+
+    $services->set('sensiolabs_gotenberg.builder_configurator', BuilderConfigurator::class)
+        ->args([
+            abstract_arg('Mapping of methods per builder for each configuration key'),
+            abstract_arg('Mapping of values per builder for each configuration key'),
+        ])
+    ;
+};

config/builder_pdf.php

@@ -1,6 +1,7 @@
 <?php
 
 use Sensiolabs\GotenbergBundle\Builder\Pdf\ConvertPdfBuilder;
+use Sensiolabs\GotenbergBundle\Builder\Pdf\FlattenPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\HtmlPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\LibreOfficePdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\MarkdownPdfBuilder;
@@ -17,88 +18,68 @@
         ->tag('monolog.logger', ['channel' => 'sensiolabs_gotenberg'])
     ;
 
+    // HTML
     $services->set('.sensiolabs_gotenberg.pdf_builder.html', HtmlPdfBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-            service('request_stack'),
-            service('twig')->nullOnInvalid(),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.pdf_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
     ;
 
+    // URL
     $services->set('.sensiolabs_gotenberg.pdf_builder.url', UrlPdfBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-            service('request_stack'),
-            service('twig')->nullOnInvalid(),
-            service('router')->nullOnInvalid(),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
         ->call('setRequestContext', [service('.sensiolabs_gotenberg.request_context')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.pdf_builder')
     ;
 
+    // Markdown
     $services->set('.sensiolabs_gotenberg.pdf_builder.markdown', MarkdownPdfBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-            service('request_stack'),
-            service('twig')->nullOnInvalid(),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.pdf_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
     ;
 
+    // Office
     $services->set('.sensiolabs_gotenberg.pdf_builder.office', LibreOfficePdfBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.pdf_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
     ;
 
+    // Merge
     $services->set('.sensiolabs_gotenberg.pdf_builder.merge', MergePdfBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.pdf_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
     ;
 
+    // Convert
     $services->set('.sensiolabs_gotenberg.pdf_builder.convert', ConvertPdfBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.pdf_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
     ;
 
+    // Split
     $services->set('.sensiolabs_gotenberg.pdf_builder.split', SplitPdfBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.pdf_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
+    ;
+
+    // Flatten
+    $services->set('.sensiolabs_gotenberg.pdf_builder.flatten', FlattenPdfBuilder::class)
+        ->share(false)
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
     ;
 };

config/builder_screenshot.php

@@ -13,44 +13,28 @@
         ->tag('monolog.logger', ['channel' => 'sensiolabs_gotenberg'])
     ;
 
+    // HTML
     $services->set('.sensiolabs_gotenberg.screenshot_builder.html', HtmlScreenshotBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-            service('request_stack'),
-            service('twig')->nullOnInvalid(),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.screenshot_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
     ;
 
-    $services->set('.sensiolabs_gotenberg.screenshot_builder.url', UrlScreenshotBuilder::class)
+    // Markdown
+    $services->set('.sensiolabs_gotenberg.screenshot_builder.markdown', MarkdownScreenshotBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-            service('request_stack'),
-            service('twig')->nullOnInvalid(),
-            service('router')->nullOnInvalid(),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->call('setRequestContext', [service('.sensiolabs_gotenberg.request_context')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.screenshot_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
     ;
 
-    $services->set('.sensiolabs_gotenberg.screenshot_builder.markdown', MarkdownScreenshotBuilder::class)
+    // URL
+    $services->set('.sensiolabs_gotenberg.screenshot_builder.url', UrlScreenshotBuilder::class)
         ->share(false)
-        ->args([
-            service('sensiolabs_gotenberg.client'),
-            service('.sensiolabs_gotenberg.asset.base_dir_formatter'),
-            service('.sensiolabs_gotenberg.webhook_configuration_registry'),
-            service('request_stack'),
-            service('twig')->nullOnInvalid(),
-        ])
-        ->call('setLogger', [service('logger')->nullOnInvalid()])
-        ->tag('sensiolabs_gotenberg.screenshot_builder')
+        ->parent('.sensiolabs_gotenberg.abstract_builder')
+        ->tag('sensiolabs_gotenberg.builder')
+        ->configurator(service('sensiolabs_gotenberg.builder_configurator'))
+        ->call('setRequestContext', [service('.sensiolabs_gotenberg.request_context')->nullOnInvalid()])
     ;
 };

config/debug.php

@@ -1,6 +1,7 @@
 <?php
 
 use Sensiolabs\GotenbergBundle\DataCollector\GotenbergDataCollector;
+use Sensiolabs\GotenbergBundle\Debug\Client\TraceableGotenbergClient;
 use Sensiolabs\GotenbergBundle\Debug\TraceableGotenbergPdf;
 use Sensiolabs\GotenbergBundle\Debug\TraceableGotenbergScreenshot;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -26,11 +27,19 @@
         ])
     ;
 
+    $services->set('sensiolabs_gotenberg.traceable_client', TraceableGotenbergClient::class)
+        ->decorate('sensiolabs_gotenberg.client')
+        ->args([
+            new Reference('.inner'),
+        ])
+    ;
+
     $services->set('sensiolabs_gotenberg.data_collector', GotenbergDataCollector::class)
         ->args([
             service('sensiolabs_gotenberg.pdf'),
             service('sensiolabs_gotenberg.screenshot'),
-            tagged_locator('sensiolabs_gotenberg.pdf_builder'),
+            tagged_locator('sensiolabs_gotenberg.builder'),
+            service('sensiolabs_gotenberg.client'),
             abstract_arg('All default options will be set through the configuration.'),
         ])
         ->tag('data_collector', ['template' => '@SensiolabsGotenberg/Collector/sensiolabs_gotenberg.html.twig', 'id' => 'sensiolabs_gotenberg'])

config/services.php

@@ -19,7 +19,6 @@
 use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service_locator;
-use function Symfony\Component\DependencyInjection\Loader\Configurator\tagged_locator;
 
 return static function (ContainerConfigurator $container): void {
     $services = $container->services();
@@ -47,14 +46,14 @@
 
     $services->set('sensiolabs_gotenberg.pdf', GotenbergPdf::class)
         ->args([
-            tagged_locator('sensiolabs_gotenberg.pdf_builder'),
+            abstract_arg('PDF builders services'),
         ])
         ->alias(GotenbergPdfInterface::class, 'sensiolabs_gotenberg.pdf')
     ;
 
     $services->set('sensiolabs_gotenberg.screenshot', GotenbergScreenshot::class)
         ->args([
-            tagged_locator('sensiolabs_gotenberg.screenshot_builder'),
+            abstract_arg('Screenshot builders services'),
         ])
         ->alias(GotenbergScreenshotInterface::class, 'sensiolabs_gotenberg.screenshot')
     ;

docs/builders_api.md

@@ -3,6 +3,7 @@
 ## Pdf
 
 * [ConvertPdfBuilder](./pdf/builders_api/ConvertPdfBuilder.md)
+* [FlattenPdfBuilder](./pdf/builders_api/FlattenPdfBuilder.md)
 * [HtmlPdfBuilder](./pdf/builders_api/HtmlPdfBuilder.md)
 * [LibreOfficePdfBuilder](./pdf/builders_api/LibreOfficePdfBuilder.md)
 * [MarkdownPdfBuilder](./pdf/builders_api/MarkdownPdfBuilder.md)