Update Header.php - Initial Commit for List support

Adds $listTable, getListTable(), writeListTable(), and registerListItem(). Also extends registerHeaderItem() to check if item is instanceof Numbering.

Most functions empty for now. Work forthcoming.

#NOTE: Changes registerFont() to registerHeader() and registerFontItem() to registerHeaderItem(). This will break pull request PHPOffice#2818, but is simply fixed.

Author: rasamassen

src/PhpWord/Writer/RTF/Part/Header.php

@@ -23,6 +23,7 @@
 use PhpOffice\PhpWord\Style;
 use PhpOffice\PhpWord\Style\Font;
 use PhpOffice\PhpWord\Style\Table;
+use PhpOffice\PhpWord\Style\Numbering;
 
 /**
  * RTF header part writer.
@@ -53,6 +54,13 @@ class Header extends AbstractPart
      */
     private $colorTable = [];
 
+    /**
+     * List table.
+     *
+     * @var array
+     */
+    private $listTable = [];
+
     /**
      * Get font table.
      *
@@ -73,21 +81,32 @@ public function getColorTable()
         return $this->colorTable;
     }
 
+    /**
+     * Get list table.
+     *
+     * @return array
+     */
+    public function getListTable()
+    {
+        return $this->listTable;
+    }
+
     /**
      * Write part.
      *
      * @return string
      */
     public function write()
     {
-        $this->registerFont();
+        $this->registerHeader();
 
         $content = '';
 
         $content .= $this->writeCharset();
         $content .= $this->writeDefaults();
         $content .= $this->writeFontTable();
         $content .= $this->writeColorTable();
+        $content .= $this->writeListTable();
         $content .= $this->writeGenerator();
         $content .= PHP_EOL;
 
@@ -166,6 +185,18 @@ private function writeColorTable()
         return $content;
     }
 
+    /**
+     * Write list table.
+     *
+     * @return string
+     */
+    private function writeListTable()
+    {
+        $content = '';
+
+        return $content;
+    }
+
     /**
      * Write.
      *
@@ -182,17 +213,17 @@ private function writeGenerator()
     }
 
     /**
-     * Register all fonts and colors in both named and inline styles to appropriate header table.
+     * Register all fonts, colors, and lists in both named and inline styles to appropriate header table.
      */
-    private function registerFont(): void
+    private function registerHeader(): void
     {
         $phpWord = $this->getParentWriter()->getPhpWord();
         $this->fontTable[] = Settings::getDefaultFontName();
 
         // Search named styles
         $styles = Style::getStyles();
         foreach ($styles as $style) {
-            $this->registerFontItems($style);
+            $this->registerHeaderItems($style);
         }
 
         // Search inline styles
@@ -203,7 +234,7 @@ private function registerFont(): void
             foreach ($elements as $element) {
                 if (method_exists($element, 'getFontStyle')) {
                     $style = $element->getFontStyle();
-                    $this->registerFontItems($style);
+                    $this->registerHeaderItems($style);
                 }
             }
         }
@@ -225,11 +256,11 @@ private function registerBorderColor($style): void
     }
 
     /**
-     * Register fonts and colors.
+     * Register fonts, colors, and lists.
      *
      * @param Style\AbstractStyle $style
      */
-    private function registerFontItems($style): void
+    private function registerHeaderItems($style): void
     {
         $defaultFont = Settings::getDefaultFontName();
         $defaultColor = Settings::DEFAULT_FONT_COLOR;
@@ -247,6 +278,9 @@ private function registerFontItems($style): void
             $this->registerTableItem($this->colorTable, $style->getBorderLeftColor(), $defaultColor);
             $this->registerTableItem($this->colorTable, $style->getBorderBottomColor(), $defaultColor);
         }
+        if ($style instanceof Numbering) {
+            $this->registerList($this->listTable, $style);
+        }
     }
 
     /**
@@ -262,4 +296,15 @@ private function registerTableItem(&$table, $value, $default = null): void
             $table[] = $value;
         }
     }
+
+    /**
+     * Register lists and fonts within lists.
+     *
+     * @param array &$table
+     * @param Style\Numbering $style
+     */
+    private function registerList(&$table, $style): void
+    {
+        $table[] = [];
+    }
 }