improved invoices with new renderer (#306)

* added docx renderer and demo template * added csv renderer and demo template * added xlsx renderer and demo template * added ods renderer and demo template * added user calculator * added invoice documentation
2018-09-21 01:27:56 +02:00
parent b035fc9ebd
commit 53f82a808b
121 changed files with 4094 additions and 770 deletions
--- a/src/Invoice/Renderer/AbstractSpreadsheetRenderer.php
+++ b/src/Invoice/Renderer/AbstractSpreadsheetRenderer.php
@@ -0,0 +1,129 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Invoice\Renderer;
+
+use App\Entity\InvoiceDocument;
+use App\Model\InvoiceModel;
+use PhpOffice\PhpSpreadsheet\IOFactory;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
+use Symfony\Component\HttpFoundation\Response;
+
+abstract class AbstractSpreadsheetRenderer extends AbstractRenderer
+{
+    /**
+     * @param Spreadsheet $spreadsheet
+     * @return bool|string
+     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
+     */
+    abstract protected function saveSpreadsheet(Spreadsheet $spreadsheet);
+
+    /**
+     * Render the given InvoiceDocument with the data from the InvoiceModel.
+     *
+     * @param InvoiceDocument $document
+     * @param InvoiceModel $model
+     * @return Response
+     */
+    public function render(InvoiceDocument $document, InvoiceModel $model): Response
+    {
+        $spreadsheet = IOFactory::load($document->getFilename());
+        $worksheet = $spreadsheet->getActiveSheet();
+        $entries = $model->getCalculator()->getEntries();
+        $replacer = $this->modelToReplacer($model);
+        $timesheetAmount = count($entries);
+        $this->addTemplateRows($worksheet, $timesheetAmount);
+
+        $worksheet->setTitle($model->getTemplate()->getTitle());
+
+        $entryRow = 0;
+
+        foreach ($worksheet->getRowIterator() as $row) {
+            $timesheet = $entries[$entryRow];
+            $sheetValues = false;
+            foreach ($row->getCellIterator() as $cell) {
+                $value = $cell->getValue();
+                if (stripos($value, '${entry.') !== false) {
+                    if ($sheetValues === false) {
+                        $sheetValues = $this->timesheetToArray($timesheet);
+                    }
+                    $searcher = str_replace('${', '', $value);
+                    $searcher = str_replace('}', '', $searcher);
+                    if (isset($sheetValues[$searcher])) {
+                        $cell->setValue($sheetValues[$searcher]);
+                    }
+                } elseif (stripos($value, '${') !== false) {
+                    $searcher = str_replace('${', '', $value);
+                    $searcher = str_replace('}', '', $searcher);
+                    if (isset($replacer[$searcher])) {
+                        $cell->setValue($replacer[$searcher]);
+                    }
+                }
+            }
+
+            if ($sheetValues !== false && $entryRow < $timesheetAmount - 1) {
+                $entryRow++;
+            }
+        }
+
+        $filename = $this->saveSpreadsheet($spreadsheet);
+
+        return $this->getFileResponse($filename, basename($document->getFilename()));
+    }
+
+    /**
+     * @param Worksheet $worksheet
+     * @param int $timesheets
+     */
+    protected function addTemplateRows(Worksheet $worksheet, int $timesheets)
+    {
+        $startRow = null;
+        $rowCounter = 0;
+
+        foreach ($worksheet->getRowIterator() as $row) {
+            $cellCounter = 0;
+            foreach ($row->getCellIterator() as $cell) {
+                $value = $cell->getValue();
+                if (stripos($value, '${entry.') !== false) {
+                    $startRow = $row->getRowIndex();
+                    $worksheet->insertNewRowBefore($row->getRowIndex(), $timesheets - 1);
+                    break 2;
+                }
+
+                if ($cellCounter++ >= 10) {
+                    break;
+                }
+            }
+
+            if ($rowCounter++ >= 100) {
+                break;
+            }
+        }
+
+        if ($startRow === null) {
+            throw new \Exception('Invalid invoice document, no template row found.');
+        }
+
+        // fill up all new rows with template values
+        $templateRow = $timesheets + $startRow;
+        $iterator = $worksheet->getRowIterator($templateRow - 1, $templateRow);
+        $templateColumns = [];
+        foreach ($iterator->current()->getCellIterator() as $cell) {
+            $templateColumns[$cell->getColumn()] = $cell->getValue();
+        }
+
+        $iterator = $worksheet->getRowIterator($startRow, $templateRow - 2);
+        foreach ($iterator as $row) {
+            foreach ($row->getCellIterator() as $cell) {
+                $cell->setValue($templateColumns[$cell->getColumn()]);
+            }
+        }
+    }
+}