[RELEASE_8.15.0] Add split feature

README.md

@@ -242,7 +242,8 @@ class YourController
    `xltx`, `xlw`, `xml`, `xpm`, `zabw`
 6. [Merge Builder](./docs/pdf/merge-builder.md)
 7. [Convert Builder](./docs/pdf/convert-builder.md)
-8. [PDF customization](./docs/pdf/customization.md) (available for every builder except LibreOffice and Merge)
+8. [Split Builder](./docs/pdf/split-builder.md)
+9. [PDF customization](./docs/pdf/customization.md) (available for every builder except LibreOffice, Merge and Split)
 
 #### Screenshot
 

config/builder_pdf.php

@@ -5,6 +5,7 @@
 use Sensiolabs\GotenbergBundle\Builder\Pdf\LibreOfficePdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\MarkdownPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\MergePdfBuilder;
+use Sensiolabs\GotenbergBundle\Builder\Pdf\SplitPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\UrlPdfBuilder;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
@@ -89,4 +90,15 @@
         ->call('setLogger', [service('logger')->nullOnInvalid()])
         ->tag('sensiolabs_gotenberg.pdf_builder')
     ;
+
+    $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')
+    ;
 };

docs/Pdf/builders_api/ConvertPdfBuilder.md

@@ -0,0 +1,26 @@
+# ConvertPdfBuilder
+
+* `pdfFormat(Sensiolabs\GotenbergBundle\Enumeration\PdfFormat $format)`:
+Convert the resulting PDF into the given PDF/A format.
+
+* `pdfUniversalAccess(bool $bool)`:
+Enable PDF for Universal Access for optimal accessibility.
+
+* `files(string $paths)`:
+
+* `downloadFrom(array $downloadFrom)`:
+
+* `webhookConfiguration(string $name)`:
+Providing an existing $name from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrl(string $url, ?string $method)`:
+Sets the webhook for cases of success.
+Optionaly sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.
+
+* `errorWebhookUrl(?string $url, ?string $method)`:
+Sets the webhook for cases of error.
+Optionaly sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+

docs/Pdf/builders_api/HtmlPdfBuilder.md

@@ -0,0 +1,168 @@
+# HtmlPdfBuilder
+
+* `content(string $template, array $context)`:
+
+* `contentFile(string $path)`:
+The HTML file to convert into PDF.
+
+* `cookies(array $cookies)`:
+
+* `setCookie(string $key, Symfony\Component\HttpFoundation\Cookie|array $cookie)`:
+
+* `forwardCookie(string $name)`:
+
+* `singlePage(bool $bool)`:
+Define whether to print the entire content in one single page.
+If the singlePage form field is set to true, it automatically overrides the values from the paperHeight and nativePageRanges form fields.
+
+* `paperSize(float $width, float $height, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)`:
+Overrides the default paper size, in inches.
+Examples of paper size (width x height):
+Letter - 8.5 x 11 (default)
+Legal - 8.5 x 14
+Tabloid - 11 x 17
+Ledger - 17 x 11
+A0 - 33.1 x 46.8
+A1 - 23.4 x 33.1
+A2 - 16.54 x 23.4
+A3 - 11.7 x 16.54
+A4 - 8.27 x 11.7
+A5 - 5.83 x 8.27
+A6 - 4.13 x 5.83
+
+* `paperStandardSize(Sensiolabs\GotenbergBundle\Enumeration\PaperSizeInterface $paperSize)`:
+
+* `paperWidth(float $width, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)`:
+
+* `paperHeight(float $height, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)`:
+
+* `margins(float $top, float $bottom, float $left, float $right, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)`:
+Overrides the default margins (e.g., 0.39), in inches.
+
+* `marginTop(float $top, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)`:
+
+* `marginBottom(float $bottom, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)`:
+
+* `marginLeft(float $left, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)`:
+
+* `marginRight(float $right, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)`:
+
+* `preferCssPageSize(bool $bool)`:
+Define whether to prefer page size as defined by CSS. (Default false).
+
+* `generateDocumentOutline(bool $bool)`:
+Define whether the document outline should be embedded into the PDF. (Default false).
+
+* `printBackground(bool $bool)`:
+Prints the background graphics. (Default false).
+
+* `omitBackground(bool $bool)`:
+Hides default white background and allows generating PDFs with
+transparency. (Default false).
+
+* `landscape(bool $bool)`:
+Sets the paper orientation to landscape. (Default false).
+
+* `scale(float $scale)`:
+The scale of the page rendering (e.g., 1.0). (Default 1.0).
+
+* `nativePageRanges(string $range)`:
+Page ranges to print, e.g., '1-5, 8, 11-13'. (default All pages).
+
+* `header(string $template, array $context)`:
+
+* `footer(string $template, array $context)`:
+
+* `headerFile(string $path)`:
+HTML file containing the header. (default None).
+
+* `footerFile(string $path)`:
+HTML file containing the footer. (default None).
+
+* `assets(string $paths)`:
+Adds additional files, like images, fonts, stylesheets, and so on (overrides any previous files).
+
+* `addAsset(string $path)`:
+Adds a file, like an image, font, stylesheet, and so on.
+
+* `waitDelay(string $delay)`:
+Sets the duration (i.e., "1s", "2ms", etc.) to wait when loading an HTML
+document before converting it to PDF. (default None).
+
+* `waitForExpression(string $expression)`:
+Sets the JavaScript expression to wait before converting an HTML
+document to PDF until it returns true. (default None).
+For instance: "window.status === 'ready'".
+
+* `emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)`:
+Forces Chromium to emulate, either "screen" or "print". (default "print").
+
+* `userAgent(string $userAgent)`:
+Override the default User-Agent HTTP header. (default None).
+
+* `extraHttpHeaders(array $headers)`:
+Sets extra HTTP headers that Chromium will send when loading the HTML
+document. (default None). (overrides any previous headers).
+
+* `addExtraHttpHeaders(array $headers)`:
+Adds extra HTTP headers that Chromium will send when loading the HTML
+document. (default None).
+
+* `failOnHttpStatusCodes(array $statusCodes)`:
+Return a 409 Conflict response if the HTTP status code from
+the main page is not acceptable. (default [499,599]). (overrides any previous configuration).
+
+* `failOnResourceHttpStatusCodes(array $statusCodes)`:
+Return a 409 Conflict response if the HTTP status code from at least one resource is not acceptable.
+(default None). (overrides any previous configuration).
+
+* `failOnResourceLoadingFailed(bool $bool)`:
+Forces GotenbergScreenshot to return a 409 Conflict response if there are
+exceptions load at least one resource. (default false).
+
+* `failOnConsoleExceptions(bool $bool)`:
+Forces GotenbergPdf to return a 409 Conflict response if there are
+exceptions in the Chromium console. (default false).
+
+* `skipNetworkIdleEvent(bool $bool)`:
+
+* `pdfFormat(?Sensiolabs\GotenbergBundle\Enumeration\PdfFormat $format)`:
+Sets the PDF format of the resulting PDF. (default None).
+
+* `pdfUniversalAccess(bool $bool)`:
+Enable PDF for Universal Access for optimal accessibility. (default false).
+
+* `metadata(array $metadata)`:
+Resets the metadata.
+
+* `addMetadata(string $key, string $value)`:
+The metadata to write.
+
+* `splitMode(?Sensiolabs\GotenbergBundle\Enumeration\SplitMode $splitMode)`:
+Either intervals or pages. (default None).
+
+* `splitSpan(string $splitSpan)`:
+Either the intervals or the page ranges to extract, depending on the selected mode. (default None).
+
+* `splitUnify(bool $bool)`:
+Specify whether to put extracted pages into a single file or as many files as there are page ranges. Only works with pages mode. (default false).
+
+* `downloadFrom(array $downloadFrom)`:
+
+* `webhookConfiguration(string $name)`:
+Providing an existing $name from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrl(string $url, ?string $method)`:
+Sets the webhook for cases of success.
+Optionaly sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.
+
+* `errorWebhookUrl(?string $url, ?string $method)`:
+Sets the webhook for cases of error.
+Optionaly sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
+* `addCookies(array $cookies)`:
+Add cookies to store in the Chromium cookie jar.
+

docs/Pdf/builders_api/LibreOfficePdfBuilder.md

@@ -0,0 +1,112 @@
+# LibreOfficePdfBuilder
+
+* `password(string $password)`:
+Set the password for opening the source file.
+
+* `landscape(bool $bool)`:
+Sets the paper orientation to landscape.
+
+* `nativePageRanges(string $range)`:
+Page ranges to print, e.g., '1-4' - empty means all pages.
+If multiple files are provided, the page ranges will be applied independently to each file.
+
+* `doNotExportFormFields(bool $bool)`:
+Set whether to export the form fields or to use the inputted/selected content of the fields.
+
+* `singlePageSheets(bool $bool)`:
+Set whether to render the entire spreadsheet as a single page.
+
+* `pdfFormat(Sensiolabs\GotenbergBundle\Enumeration\PdfFormat $format)`:
+Convert the resulting PDF into the given PDF/A format.
+
+* `pdfUniversalAccess(bool $bool)`:
+Enable PDF for Universal Access for optimal accessibility.
+
+* `merge(bool $bool)`:
+Merge alphanumerically the resulting PDFs.
+
+* `files(string $paths)`:
+Adds office files to convert (overrides any previous files).
+
+* `metadata(array $metadata)`:
+Resets the metadata.
+
+* `addMetadata(string $key, string $value)`:
+The metadata to write.
+
+* `allowDuplicateFieldNames(bool $bool)`:
+Specify whether multiple form fields exported are allowed to have the same field name.
+
+* `doNotExportBookmarks(bool $bool)`:
+Specify if bookmarks are exported to PDF.
+
+* `exportBookmarksToPdfDestination(bool $bool)`:
+Specify that the bookmarks contained in the source LibreOffice file should be exported to the PDF file as Named Destination.
+
+* `exportPlaceholders(bool $bool)`:
+Export the placeholders fields visual markings only. The exported placeholder is ineffective.
+
+* `exportNotes(bool $bool)`:
+Specify if notes are exported to PDF.
+
+* `exportNotesPages(bool $bool)`:
+Specify if notes pages are exported to PDF. Notes pages are available in Impress documents only.
+
+* `exportOnlyNotesPages(bool $bool)`:
+Specify, if the form field exportNotesPages is set to true, if only notes pages are exported to PDF.
+
+* `exportNotesInMargin(bool $bool)`:
+Specify if notes in margin are exported to PDF.
+
+* `convertOooTargetToPdfTarget(bool $bool)`:
+Specify that the target documents with .od[tpgs] extension, will have that extension changed to .pdf when the link is exported to PDF. The source document remains untouched.
+
+* `exportLinksRelativeFsys(bool $bool)`:
+Specify that the file system related hyperlinks (file:// protocol) present in the document will be exported as relative to the source document location.
+
+* `exportHiddenSlides(bool $bool)`:
+Export, for LibreOffice Impress, slides that are not included in slide shows.
+
+* `skipEmptyPages(bool $bool)`:
+Specify that automatically inserted empty pages are suppressed. This option is active only if storing Writer documents.
+
+* `addOriginalDocumentAsStream(bool $bool)`:
+Specify that a stream is inserted to the PDF file which contains the original document for archiving purposes.
+
+* `losslessImageCompression(bool $bool)`:
+Specify if images are exported to PDF using a lossless compression format like PNG or compressed using the JPEG format.
+
+* `quality(int $quality)`:
+Specify the quality of the JPG export. A higher value produces a higher-quality image and a larger file. Between 1 and 100.
+
+* `reduceImageResolution(bool $bool)`:
+Specify if the resolution of each image is reduced to the resolution specified by the form field maxImageResolution.
+
+* `maxImageResolution(Sensiolabs\GotenbergBundle\Enumeration\ImageResolutionDPI $resolution)`:
+If the form field reduceImageResolution is set to true, tell if all images will be reduced to the given value in DPI. Possible values are: 75, 150, 300, 600 and 1200.
+
+* `splitMode(?Sensiolabs\GotenbergBundle\Enumeration\SplitMode $splitMode)`:
+Either intervals or pages. (default None).
+
+* `splitSpan(string $splitSpan)`:
+Either the intervals or the page ranges to extract, depending on the selected mode. (default None).
+
+* `splitUnify(bool $bool)`:
+Specify whether to put extracted pages into a single file or as many files as there are page ranges. Only works with pages mode. (default false).
+
+* `downloadFrom(array $downloadFrom)`:
+
+* `webhookConfiguration(string $name)`:
+Providing an existing $name from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrl(string $url, ?string $method)`:
+Sets the webhook for cases of success.
+Optionaly sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.
+
+* `errorWebhookUrl(?string $url, ?string $method)`:
+Sets the webhook for cases of error.
+Optionaly sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+