create example

Author: lukas-staab

README.md

@@ -22,6 +22,10 @@ file_put_contents('main.pdf', $pdf);
 header("Content-type:application/pdf");
 echo $pdf;
 ```
+### Try the sample 
+```
+php -f samples/simple-report.php
+```
 
 # Contribute 
 Please run 

composer.json

@@ -14,7 +14,6 @@
         "php": "^7.4|^8.0",
         "symfony/process": "^5.3",
         "twig/twig": "^3.3",
-        "psr/cache": "^3.0",
         "psr/log": "^2.0"
     },
     "require-dev": {

samples/basic.tex.twig

@@ -0,0 +1,101 @@
+\documentclass[11pt]{article}
+
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\usepackage{graphicx}
+\usepackage{xcolor}
+\usepackage{ngerman}
+\usepackage[tx]{sfmath}
+\usepackage{calc}
+\usepackage{lastpage}
+\usepackage{xifthen}
+\usepackage{multicol}
+\renewcommand\familydefault{\sfdefault}
+\usepackage{tgheros}
+\usepackage{intcalc}
+\usepackage{amsmath,amssymb,amsthm,textcomp}
+%\usepackage{enumerate}
+\usepackage{enumitem}
+\usepackage{tikz}
+
+\usepackage{geometry}
+\geometry{a4paper,
+left=25mm,right=25mm,%
+bindingoffset=0mm, top=20mm,bottom=20mm}
+
+% pdf version to min 1.6
+\pdfminorversion=6
+
+\newcommand{\footerstring}{}
+\linespread{1.3}
+
+\newcommand{\linia}{\rule{\linewidth}{0.5pt}}
+
+\newcommand{\mysection}[1]{
+\begin{center}
+{\large \textsc{#1}}
+\vspace*{-0.5cm}
+\\\linia\\
+\vspace*{-0.5cm}
+\end{center}
+}
+
+% custom theorems if needed
+\newtheoremstyle{mytheor}
+{1ex}{1ex}{\normalfont}{0pt}{\scshape}{.}{1ex}
+{{\thmname{#1 }}{\thmnumber{#2}}{\thmnote{ (#3)}}}
+
+\theoremstyle{mytheor}
+\newtheorem{defi}{Definition}
+
+% my own titles
+\makeatletter
+\renewcommand{\maketitle}{
+\begin{center}
+\vspace*{-0.5cm}
+{\huge \textsc{\@title}}
+\linia
+\end{center}
+}
+\makeatother
+%%%
+
+% custom footers and headers
+\usepackage{fancyhdr}
+\pagestyle{fancy}
+\lhead{}
+\chead{}
+\rhead{}
+\lfoot{\footerstring}
+\cfoot{}
+\rfoot{Seite~\thepage{}~von~\pageref{LastPage}}
+\renewcommand{\headrulewidth}{0pt}
+\renewcommand{\footrulewidth}{0pt}
+
+%
+% all section titles centered and bolded
+\usepackage{sectsty}
+\allsectionsfont{\centering\bfseries\large}
+%
+% add section label
+\renewcommand\thesection{}
+%
+
+%%%----------%%%----------%%%----------%%%----------%%%
+
+\begin{document}
+
+\title{(% block title %)(% endblock %)}
+\author{(% block author %)(% endblock %)}
+(% if  logopath is defined %)
+\vspace*{-2.0cm}
+\begin{figure}[h]
+\centering
+\label{fig:logo}
+%\includegraphics[width=3cm]{(( logopath ))}
+\end{figure}
+(% endif %)
+
+\maketitle
+(% block main %)(% endblock %)
+\end{document}

samples/simple-report.php

@@ -0,0 +1,59 @@
+<?php
+
+use PhpLatexRenderer\LatexRenderer;
+
+define('ROOT', dirname(__FILE__, 2));
+
+require ROOT . '/vendor/autoload.php';
+
+$tex = new LatexRenderer(__DIR__, 'pdflatex', true);
+$monolog = new \Monolog\Logger('Tex-Samples', [new \Monolog\Handler\RotatingFileHandler(ROOT . '/runtime/log/sample.log')]);
+$tex->setLogger($monolog);
+$tex->setTmpDir(ROOT . '/runtime/');
+$pdf = $tex->renderPdf('simple-report', [
+    'title' => 'My Custom Title',
+    'author' => 'Me!',
+    'content' => [
+        [
+          'headline' => 'This is a Test Headline',
+          'items' => [
+              [
+                  'label' => 'test',
+                  'value' => 'value',
+              ],
+              [
+                  'label' => 'test',
+                  'value' => 'value',
+              ],
+          ],
+        ],
+        [
+            'headline' => 'test2',
+            'items' => [
+                [
+                    'label' => 'test',
+                    'value' => 'value',
+                ],
+            ],
+            'resume' => true,
+        ],
+        [
+            'text' => 'Please sign only if all of the above data is correct',
+            'signatures' => [
+                [
+                    'label' => 'Signature 1',
+                    'name' => 'Person 1',
+                ],
+                [
+                    'label' => 'Signature 2',
+                    'name' => 'Person 2',
+                ],
+                [
+                    'label' => 'Signature 3',
+                    'name' => 'Person 3',
+                ],
+            ],
+        ],
+    ],
+]);
+echo $pdf !== null ? 'Success' .PHP_EOL : 'Failure' . PHP_EOL;

samples/simple-report.tex.twig

@@ -0,0 +1,44 @@
+(% extends "basic.tex.twig" %)
+(% block title %)Mein Titel(% endblock %)
+(% block main %)
+(% for section in content %)
+    (% if section.headline is defined %)
+        \vspace*{-0.5cm}
+        \mysection{(( section.headline ))}
+    (% endif %)
+    (% if section.text is defined %)
+        \vspace{5mm}
+        {\footnotesize
+            (( section.text ))
+        }
+        \vspace{5mm}
+        \newline
+        (% endif %)
+    (% if section.items is defined %)
+        \begin{enumerate}[label=\Roman*(% if section.resume is defined and section.resume %),resume(% endif %)]
+            \itemsep-2mm
+            (% for item in section.items %)
+            \item \textbf{(( item.label ))}\hfill (( item.value ))
+            (% endfor %)
+        \end{enumerate}
+    (% endif %)%section.items end
+    (% if section.signatures is defined %)
+        \vspace{5mm}
+        \hspace{15pt}
+        (% for signature in section.signatures %)
+            \parbox[b]{120pt}{% size of the first signature box
+                \strut
+                \textbf{(( signature.label))} \\[1.25cm]% This 2cm is the space for the signature under the names
+                \hrule
+                \vspace{0.25cm}
+                (( signature.name ))
+            }
+            (% if not loop.last %)
+                \hspace{30pt}
+            (% endif %)
+        (% endfor %)% end signature loop
+        \newline
+        \vspace{5mm}
+    (% endif %)%end signatures
+(% endfor  %)%end content
+(% endblock %)

src/LatexRenderer.php

@@ -51,16 +51,22 @@ public function __construct($templateDirs, string $latexExec = 'pdflatex', bool
         $this->logger = new NullLogger();
     }
 
-    public function setLogger(LoggerInterface $logger)
+    public function setLogger(LoggerInterface $logger): void
     {
         $this->logger = $logger;
     }
 
+    /**
+     * @param $templateDir
+     */
     public function setTemplateDir($templateDir): void
     {
         $this->twig->setLoader(new FilesystemLoader($templateDir));
     }
 
+    /**
+     * @param string $tmpDir the directory path where the latex runtime files will be located
+     */
     public function setTmpDir(string $tmpDir): void
     {
         if (!str_ends_with($tmpDir, '/')) {
@@ -72,6 +78,10 @@ public function setTmpDir(string $tmpDir): void
         }
     }
 
+    /**
+     * @param array $files
+     * @return string|null returns pdf as string or null on failure
+     */
     public function renderPdf(string $templateName, array $variables, array $files = []): ?string
     {
         try {