ODT: Basic table writing support

Author: ivanlanin

CHANGELOG.md

@@ -30,6 +30,7 @@ This release marked heavy refactorings on internal code structure with the creat
 - Reader: Ability to read header, footer, footnotes, link, preservetext, textbreak, pagebreak, table, and list - @ivanlanin
 - Endnote: Ability to add endnotes - @ivanlanin
 - ListItem: Ability to create custom list and reset list number - @ivanlanin GH-10 GH-198
+- ODT Writer: Basic table writing support - @ivanlanin
 
 ### Bugfixes
 

src/PhpWord/Element/AbstractElement.php

@@ -81,6 +81,20 @@ abstract class AbstractElement
      */
     protected $elements = array();
 
+    /**
+     * Index of element in the elements collection (start with 1)
+     *
+     * @var integer
+     */
+    protected $elementIndex = 1;
+
+    /**
+     * Unique Id for element
+     *
+     * @var integer
+     */
+    protected $elementId;
+
     /**
      * Relation Id
      *
@@ -108,7 +122,7 @@ public function addText($text, $fontStyle = null, $paragraphStyle = null)
         $text = String::toUTF8($text);
         $textObject = new Text($text, $fontStyle, $paragraphStyle);
         $textObject->setDocPart($this->getDocPart(), $this->getDocPartId());
-        $this->elements[] = $textObject;
+        $this->addElement($textObject);
 
         return $textObject;
     }
@@ -125,7 +139,7 @@ public function addTextRun($paragraphStyle = null)
 
         $textRun = new TextRun($paragraphStyle);
         $textRun->setDocPart($this->getDocPart(), $this->getDocPartId());
-        $this->elements[] = $textRun;
+        $this->addElement($textRun);
 
         return $textRun;
     }
@@ -148,7 +162,7 @@ public function addLink($linkSrc, $linkName = null, $fontStyle = null, $paragrap
         $link->setDocPart($this->getDocPart(), $this->getDocPartId());
         $rId = Media::addElement($elementDocPart, 'link', $linkSrc);
         $link->setRelationId($rId);
-        $this->elements[] = $link;
+        $this->addElement($link);
 
         return $link;
     }
@@ -179,7 +193,7 @@ public function addTitle($text, $depth = 1)
         $bookmarkId = $data[1];
         $title->setAnchor($anchor);
         $title->setBookmarkId($bookmarkId);
-        $this->elements[] = $title;
+        $this->addElement($title);
 
         return $title;
     }
@@ -198,7 +212,7 @@ public function addPreserveText($text, $fontStyle = null, $paragraphStyle = null
 
         $preserveText = new PreserveText(String::toUTF8($text), $fontStyle, $paragraphStyle);
         $preserveText->setDocPart($this->getDocPart(), $this->getDocPartId());
-        $this->elements[] = $preserveText;
+        $this->addElement($preserveText);
 
         return $preserveText;
     }
@@ -217,7 +231,7 @@ public function addTextBreak($count = 1, $fontStyle = null, $paragraphStyle = nu
         for ($i = 1; $i <= $count; $i++) {
             $textBreak = new TextBreak($fontStyle, $paragraphStyle);
             $textBreak->setDocPart($this->getDocPart(), $this->getDocPartId());
-            $this->elements[] = $textBreak;
+            $this->addElement($textBreak);
         }
     }
 
@@ -237,7 +251,7 @@ public function addListItem($text, $depth = 0, $fontStyle = null, $styleList = n
 
         $listItem = new ListItem(String::toUTF8($text), $depth, $fontStyle, $styleList, $paragraphStyle);
         $listItem->setDocPart($this->getDocPart(), $this->getDocPartId());
-        $this->elements[] = $listItem;
+        $this->addElement($listItem);
 
         return $listItem;
     }
@@ -253,7 +267,7 @@ public function addTable($style = null)
         $this->checkValidity('table');
 
         $table = new Table($this->getDocPart(), $this->getDocPartId(), $style);
-        $this->elements[] = $table;
+        $this->addElement($table);
 
         return $table;
     }
@@ -275,7 +289,8 @@ public function addImage($src, $style = null, $isWatermark = false)
         $image->setDocPart($this->getDocPart(), $this->getDocPartId());
         $rId = Media::addElement($elementDocPart, 'image', $src, $image);
         $image->setRelationId($rId);
-        $this->elements[] = $image;
+        $this->addElement($image);
+
         return $image;
     }
 
@@ -307,7 +322,8 @@ public function addObject($src, $style = null)
             $object->setRelationId($rId);
             $rIdimg = Media::addElement($elementDocPart, 'image', $icon, new Image($icon));
             $object->setImageRelationId($rIdimg);
-            $this->elements[] = $object;
+            $this->addElement($object);
+
             return $object;
         } else {
             throw new InvalidObjectException();
@@ -329,7 +345,7 @@ public function addFootnote($paragraphStyle = null)
 
         $footnote->setDocPart('footnote', $this->getDocPartId());
         $footnote->setRelationId($rId);
-        $this->elements[] = $footnote;
+        $this->addElement($footnote);
 
         return $footnote;
     }
@@ -349,7 +365,7 @@ public function addEndnote($paragraphStyle = null)
 
         $endnote->setDocPart('endnote', $this->getDocPartId());
         $endnote->setRelationId($rId);
-        $this->elements[] = $endnote;
+        $this->addElement($endnote);
 
         return $endnote;
     }
@@ -369,7 +385,7 @@ public function addCheckBox($name, $text, $fontStyle = null, $paragraphStyle = n
 
         $checkBox = new CheckBox(String::toUTF8($name), String::toUTF8($text), $fontStyle, $paragraphStyle);
         $checkBox->setDocPart($this->getDocPart(), $this->getDocPartId());
-        $this->elements[] = $checkBox;
+        $this->addElement($checkBox);
 
         return $checkBox;
     }
@@ -416,6 +432,16 @@ public function getDocPartId()
         return $this->docPartId;
     }
 
+    /**
+     * Set element index and unique id, and add element into elements collection
+     */
+    protected function addElement(AbstractElement $element)
+    {
+        $element->setElementIndex($this->countElements() + 1);
+        $element->setElementId();
+        $this->elements[] = $element;
+    }
+
     /**
      * Get all elements
      *
@@ -426,6 +452,54 @@ public function getElements()
         return $this->elements;
     }
 
+    /**
+     * Count elements
+     *
+     * @return integer
+     */
+    public function countElements()
+    {
+        return count($this->elements);
+    }
+
+    /**
+     * Get element index
+     *
+     * @return int
+     */
+    public function getElementIndex()
+    {
+        return $this->elementIndex;
+    }
+
+    /**
+     * Set element index
+     *
+     * @param int $value
+     */
+    public function setElementIndex($value)
+    {
+        $this->elementIndex = $value;
+    }
+
+    /**
+     * Get element unique ID
+     *
+     * @return string
+     */
+    public function getElementId()
+    {
+        return $this->elementId;
+    }
+
+    /**
+     * Set element unique ID from 6 first digit of md5
+     */
+    public function setElementId()
+    {
+        $this->elementId = substr(md5(rand()), 0, 6);
+    }
+
     /**
      * Get relation Id
      *

src/PhpWord/Element/Table.php

@@ -35,7 +35,7 @@ class Table extends AbstractElement
     /**
      * Table width
      *
-     * @var int
+     * @var integer
      */
     private $width = null;
 
@@ -44,7 +44,7 @@ class Table extends AbstractElement
      * Create a new table
      *
      * @param string $docPart
-     * @param int $docPartId
+     * @param integer $docPartId
      * @param mixed $style
      */
     public function __construct($docPart, $docPartId, $style = null)
@@ -56,7 +56,7 @@ public function __construct($docPart, $docPartId, $style = null)
     /**
      * Add a row
      *
-     * @param int $height
+     * @param integer $height
      * @param mixed $style
      */
     public function addRow($height = null, $style = null)
@@ -69,7 +69,7 @@ public function addRow($height = null, $style = null)
     /**
      * Add a cell
      *
-     * @param int $width
+     * @param integer $width
      * @param mixed $style
      * @return Cell
      */
@@ -103,7 +103,7 @@ public function getStyle()
     /**
      * Set table width
      *
-     * @param int $width
+     * @param integer $width
      */
     public function setWidth($width)
     {
@@ -113,10 +113,31 @@ public function setWidth($width)
     /**
      * Get table width
      *
-     * @return int
+     * @return integer
      */
     public function getWidth()
     {
         return $this->width;
     }
+
+    /**
+     * Get column count
+     *
+     * @return integer
+     */
+    public function countColumns()
+    {
+        $columnCount = 0;
+        if (is_array($this->rows)) {
+            $rowCount = count($this->rows);
+            for ($i = 0; $i < $rowCount; $i++) {
+                $cellCount = count($this->rows[$i]->getCells());
+                if ($columnCount < $cellCount) {
+                    $columnCount = $cellCount;
+                }
+            }
+        }
+
+        return $columnCount;
+    }
 }