Add table

CONTRIBUTE.md

@@ -31,7 +31,7 @@ layouts:
 - [x] implement block
 - [x] implement flow
 - [x] implement grid
-- [ ] implement table
+- [x] implement table
 
 layout blocks:
 
@@ -51,6 +51,7 @@ extend layout support:
 - [ ] alignment for blocks
 - [ ] column/row spans for grids, tables
 - [ ] auto, contain, cover for content types
+- [ ] top/right/bottom/left different weight borders
 
 extend drawing support:
 
@@ -67,8 +68,6 @@ extend PDF support:
 
 This is a large, long-lived project, and as such there are maintenance and architecture topics.
 
-Topics:
-
 Known bugs / issues:
 - [ ] Should use new `enum` construct instead of `const`
 - [ ] Images of size 0 lead to crash

src/Frontend/Layout/AbstractBlock.php

@@ -12,7 +12,7 @@
 namespace PdfGenerator\Frontend\Layout;
 
 use PdfGenerator\Frontend\Layout\Traits\BlockTrait;
-use PdfGenerator\Frontend\LayoutEngine\AbstractBlockVisitor;
+use PdfGenerator\Frontend\LayoutEngine\BlockVisitorInterface;
 
 abstract class AbstractBlock
 {
@@ -21,9 +21,9 @@ abstract class AbstractBlock
     /**
      * @template T
      *
-     * @param AbstractBlockVisitor<T> $visitor
+     * @param BlockVisitorInterface<T> $visitor
      *
      * @return T
      */
-    abstract public function accept(AbstractBlockVisitor $visitor);
+    abstract public function accept(BlockVisitorInterface $visitor);
 }

src/Frontend/Layout/Block.php

@@ -11,7 +11,7 @@
 
 namespace PdfGenerator\Frontend\Layout;
 
-use PdfGenerator\Frontend\LayoutEngine\AbstractBlockVisitor;
+use PdfGenerator\Frontend\LayoutEngine\BlockVisitorInterface;
 
 class Block extends AbstractBlock
 {
@@ -35,11 +35,11 @@ public function cloneWithBlock(AbstractBlock $block): self
     /**
      * @template T
      *
-     * @param AbstractBlockVisitor<T> $visitor
+     * @param BlockVisitorInterface<T> $visitor
      *
      * @return T
      */
-    public function accept(AbstractBlockVisitor $visitor): mixed
+    public function accept(BlockVisitorInterface $visitor): mixed
     {
         return $visitor->visitBlock($this);
     }

src/Frontend/Layout/ContentBlock.php

@@ -12,7 +12,7 @@
 namespace PdfGenerator\Frontend\Layout;
 
 use PdfGenerator\Frontend\Content\AbstractContent;
-use PdfGenerator\Frontend\LayoutEngine\AbstractBlockVisitor;
+use PdfGenerator\Frontend\LayoutEngine\BlockVisitorInterface;
 
 class ContentBlock extends AbstractBlock
 {
@@ -36,11 +36,11 @@ public function cloneWithContent(?AbstractContent $content): self
     /**
      * @template T
      *
-     * @param AbstractBlockVisitor<T> $visitor
+     * @param BlockVisitorInterface<T> $visitor
      *
      * @return T
      */
-    public function accept(AbstractBlockVisitor $visitor): mixed
+    public function accept(BlockVisitorInterface $visitor): mixed
     {
         return $visitor->visitContentBlock($this);
     }

src/Frontend/Layout/Flow.php

@@ -13,7 +13,7 @@
 
 use PdfGenerator\Frontend\Content\AbstractContent;
 use PdfGenerator\Frontend\Layout\Style\FlowDirection;
-use PdfGenerator\Frontend\LayoutEngine\AbstractBlockVisitor;
+use PdfGenerator\Frontend\LayoutEngine\BlockVisitorInterface;
 
 class Flow extends AbstractBlock
 {
@@ -72,11 +72,11 @@ public function getGap(): float
     /**
      * @template T
      *
-     * @param AbstractBlockVisitor<T> $visitor
+     * @param BlockVisitorInterface<T> $visitor
      *
      * @return T
      */
-    public function accept(AbstractBlockVisitor $visitor): mixed
+    public function accept(BlockVisitorInterface $visitor): mixed
     {
         return $visitor->visitFlow($this);
     }

src/Frontend/Layout/Grid.php

@@ -13,10 +13,13 @@
 
 use PdfGenerator\Frontend\Layout\Parts\Row;
 use PdfGenerator\Frontend\Layout\Style\ColumnSize;
-use PdfGenerator\Frontend\LayoutEngine\AbstractBlockVisitor;
+use PdfGenerator\Frontend\Layout\Traits\ColumnSizesTrait;
+use PdfGenerator\Frontend\LayoutEngine\BlockVisitorInterface;
 
 class Grid extends AbstractBlock
 {
+    use ColumnSizesTrait;
+
     /**
      * @var Row[]
      */
@@ -65,44 +68,15 @@ public function getPerpendicularGap(): float
         return $this->perpendicularGap;
     }
 
-    /**
-     * @return (string|float|ColumnSize)[]
-     */
-    public function getColumnSizes(): array
-    {
-        return $this->columnSizes;
-    }
-
     /**
      * @template T
      *
-     * @param AbstractBlockVisitor<T> $visitor
+     * @param BlockVisitorInterface<T> $visitor
      *
      * @return T
      */
-    public function accept(AbstractBlockVisitor $visitor): mixed
+    public function accept(BlockVisitorInterface $visitor): mixed
     {
         return $visitor->visitGrid($this);
     }
-
-    /**
-     * returns all column sizes for all columns used in the grid.
-     * if column size undefined for some column, defaults to AUTO.
-     *
-     * @return (float|string|ColumnSize)[]
-     */
-    public function getNormalizedColumnSizes(): array
-    {
-        $maxColumn = max(...array_keys($this->getColumnSizes()));
-        foreach ($this->getRows() as $row) {
-            $maxColumn = max($maxColumn, ...array_keys($row->getColumns()));
-        }
-
-        $columnSizes = array_fill(0, $maxColumn + 1, ColumnSize::AUTO);
-        foreach ($this->getColumnSizes() as $index => $columnSize) {
-            $columnSizes[$index] = $columnSize;
-        }
-
-        return $columnSizes;
-    }
 }

src/Frontend/Layout/Table.php

@@ -13,10 +13,13 @@
 
 use PdfGenerator\Frontend\Layout\Parts\Row;
 use PdfGenerator\Frontend\Layout\Style\ColumnSize;
-use PdfGenerator\Frontend\LayoutEngine\AbstractBlockVisitor;
+use PdfGenerator\Frontend\Layout\Traits\ColumnSizesTrait;
+use PdfGenerator\Frontend\LayoutEngine\BlockVisitorInterface;
 
 class Table extends AbstractBlock
 {
+    use ColumnSizesTrait;
+
     /**
      * @var Row[]
      */
@@ -64,6 +67,14 @@ public function getBody(): array
         return $this->body;
     }
 
+    /**
+     * @return Row[]
+     */
+    public function getRows(): array
+    {
+        return array_merge($this->head, $this->body);
+    }
+
     /**
      * @param Row[] $body
      */
@@ -86,11 +97,11 @@ public function getColumnSizes(): array
     /**
      * @template T
      *
-     * @param AbstractBlockVisitor<T> $visitor
+     * @param BlockVisitorInterface<T> $visitor
      *
      * @return T
      */
-    public function accept(AbstractBlockVisitor $visitor): mixed
+    public function accept(BlockVisitorInterface $visitor): mixed
     {
         return $visitor->visitTable($this);
     }

src/Frontend/Layout/Traits/ColumnSizesTrait.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the famoser/pdf-generator project.
+ *
+ * (c) Florian Moser <git@famoser.ch>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PdfGenerator\Frontend\Layout\Traits;
+
+use PdfGenerator\Frontend\Layout\Style\ColumnSize;
+
+trait ColumnSizesTrait
+{
+    /**
+     * @return (string|float|ColumnSize)[]
+     */
+    public function getColumnSizes(): array
+    {
+        return $this->columnSizes;
+    }
+
+    /**
+     * returns all column sizes for all columns used in the grid.
+     * if column size undefined for some column, defaults to AUTO.
+     *
+     * @return (float|string|ColumnSize)[]
+     */
+    public function getNormalizedColumnSizes(): array
+    {
+        $maxColumn = max([0, ...array_keys($this->getColumnSizes())]);
+        foreach ($this->getRows() as $row) {
+            $maxColumn = max($maxColumn, ...array_keys($row->getColumns()));
+        }
+
+        $columnSizes = array_fill(0, $maxColumn + 1, ColumnSize::AUTO);
+        foreach ($this->getColumnSizes() as $index => $columnSize) {
+            $columnSizes[$index] = $columnSize;
+        }
+
+        return $columnSizes;
+    }
+}