Make Twig dependency optional #12
Conversation
|
I think you can work with @StevenRenaux to make a unique PR. See #11. |
src/Builder/TwigTrait.php
Outdated
| * | ||
| * @throws PdfPartRenderingException if the template could not be rendered | ||
| */ | ||
| public function renderPart(PdfPart $pdfPart, string $template, array $context = []): self |
There was a problem hiding this comment.
Maybe we can find a better name, WDYT ? HTML has htmlContent, what about twigContent, twigHeader and twigFooter ? They can use a protected renderPart method.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
the twig* prefix will be needed since this trait is used in the HtmlPdfBuilder class which has already a htmlContent method (or just content).
There was a problem hiding this comment.
Why does HtmlBuilder need Twig ? The whole point of this PR was to not have this depdency. Or am I missing something ?
There was a problem hiding this comment.
It doesn't "need" Twig, the dependency is optional and the method checks if Twig is available.
Are you suggesting to keep the TwigBuilder? As we've discussed it, it wouldn't make sense IMHO since every chromium route could be called with rendered templates.
src/Builder/HtmlPdfBuilder.php
Outdated
| /** | ||
| * The HTML file to convert into PDF. | ||
| */ | ||
| public function htmlContent(string $filePath): self |
There was a problem hiding this comment.
why the prefix html ? We are in a HtmlBuilder context. content should suffice IMO. Same goes for header / footer
There was a problem hiding this comment.
I renamed the twig method to content and the HTML file method to contentFile
src/Builder/TwigTrait.php
Outdated
| * | ||
| * @throws PdfPartRenderingException if the template could not be rendered | ||
| */ | ||
| public function renderPart(PdfPart $pdfPart, string $template, array $context = []): self |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
src/Pdf/Gotenberg.php
Outdated
| $builder->setConfigurations($this->userConfigurations); | ||
|
|
||
| if (null !== $htmlTemplate) { | ||
| $builder->htmlTemplate($htmlTemplate); |
There was a problem hiding this comment.
what is htmlTemplate in context of markdown ?
There was a problem hiding this comment.
It's the HTML file that wraps the markdown content (https://gotenberg.dev/docs/routes#markdown-files-into-pdf-route). I renamed it to htmlWrapper for rendering with Twig and htmlWrapperFile for HTML files, WDYT?
Fixes #1 - Make TwigBundle dependency optional + some refactoring
Allow passing required options to the builder from GotenbergInterface