Word2007 parsing title formatting (#1297)

* Improve Title parsing
- Title should be able to contain TextRun
- Style 'Title' should be treated the same with as Heading
- Add tests for Heading/Title reader

* update the documentation and the changelog
* PHP 7.2 build should not fail anymore
* reduce dependencies versions
* fix parsing of footnotes and endnotes
* add method to remove an element from a section

Author: troosan

.scrutinizer.yml

@@ -1,3 +1,8 @@
+build:
+    nodes:
+        analysis:
+            tests:
+                override: [php-scrutinizer-run]
 filter:
     excluded_paths: [ 'vendor/*', 'tests/*', 'samples/*', 'src/PhpWord/Shared/PCLZip/*' ]
 

.travis.yml

@@ -15,12 +15,9 @@ matrix:
     include:
         - php: 5.6
           env: COVERAGE=1
-    allow_failures:
-        - php: 7.2
 
 cache:
     directories:
-        - vendor
         - $HOME/.composer/cache
         - .php-cs.cache
 
@@ -38,7 +35,7 @@ before_script:
     - if [ -z "$COVERAGE" ]; then phpenv config-rm xdebug.ini ; fi
     ## Composer
     - composer self-update
-    - composer install --prefer-source
+    - travis_wait composer install --prefer-source
     ## PHPDocumentor
     - mkdir -p build/docs
     - mkdir -p build/coverage

CHANGELOG.md

@@ -23,6 +23,7 @@ v0.15.0 (?? ??? 2018)
 - Fix parsing of `<w:br/>` tag. @troosan #1274
 - Bookmark are not writton as internal link in html writer @troosan #1263
 - It should be possible to add a Footnote in a ListItemRun @troosan #1287 #1287
+- Fix parsing of Heading and Title formating @troosan @gthomas2 #465
 
 ### Changed
 - Remove zend-stdlib dependency @Trainmaster #1284

docs/elements.rst

@@ -89,6 +89,7 @@ Titles
 
 If you want to structure your document or build table of contents, you need titles or headings.
 To add a title to the document, use the ``addTitleStyle`` and ``addTitle`` method.
+If `depth` is 0, a Title will be inserted, otherwise a Heading1, Heading2, ...
 
 .. code-block:: php
 
@@ -98,7 +99,7 @@ To add a title to the document, use the ``addTitleStyle`` and ``addTitle`` metho
 - ``depth``.
 - ``$fontStyle``. See :ref:`font-style`.
 - ``$paragraphStyle``. See :ref:`paragraph-style`.
-- ``$text``. Text to be displayed in the document.
+- ``$text``. Text to be displayed in the document. This can be `string` or a `\PhpOffice\PhpWord\Element\TextRun`
 
 It's necessary to add a title style to your document because otherwise the title won't be detected as a real title.
 

samples/Sample_17_TitleTOC.php

@@ -12,13 +12,14 @@
 // Define styles
 $fontStyle12 = array('spaceAfter' => 60, 'size' => 12);
 $fontStyle10 = array('size' => 10);
+$phpWord->addTitleStyle(null, array('size' => 22, 'bold' => true));
 $phpWord->addTitleStyle(1, array('size' => 20, 'color' => '333333', 'bold' => true));
 $phpWord->addTitleStyle(2, array('size' => 16, 'color' => '666666'));
 $phpWord->addTitleStyle(3, array('size' => 14, 'italic' => true));
 $phpWord->addTitleStyle(4, array('size' => 12));
 
 // Add text elements
-$section->addText('Table of contents 1');
+$section->addTitle('Table of contents 1', 0);
 $section->addTextBreak(2);
 
 // Add TOC #1

src/PhpWord/Collection/AbstractCollection.php

@@ -27,14 +27,14 @@ abstract class AbstractCollection
     /**
      * Items
      *
-     * @var array
+     * @var \PhpOffice\PhpWord\Element\AbstractContainer[]
      */
     private $items = array();
 
     /**
      * Get items
      *
-     * @return array
+     * @return \PhpOffice\PhpWord\Element\AbstractContainer[]
      */
     public function getItems()
     {
@@ -45,7 +45,7 @@ public function getItems()
      * Get item by index
      *
      * @param int $index
-     * @return mixed
+     * @return \PhpOffice\PhpWord\Element\AbstractContainer
      */
     public function getItem($index)
     {
@@ -60,7 +60,7 @@ public function getItem($index)
      * Set item.
      *
      * @param int $index
-     * @param mixed $item
+     * @param \PhpOffice\PhpWord\Element\AbstractContainer $item
      */
     public function setItem($index, $item)
     {
@@ -72,7 +72,7 @@ public function setItem($index, $item)
     /**
      * Add new item
      *
-     * @param mixed $item
+     * @param \PhpOffice\PhpWord\Element\AbstractContainer $item
      * @return int
      */
     public function addItem($item)

src/PhpWord/Element/AbstractContainer.php

@@ -54,7 +54,7 @@ abstract class AbstractContainer extends AbstractElement
     /**
      * Elements collection
      *
-     * @var array
+     * @var \PhpOffice\PhpWord\Element\AbstractElement[]
      */
     protected $elements = array();
 
@@ -164,6 +164,41 @@ public function getElements()
         return $this->elements;
     }
 
+    /**
+     * Returns the element at the requested position
+     *
+     * @param int $index
+     * @return \PhpOffice\PhpWord\Element\AbstractElement|null
+     */
+    public function getElement($index)
+    {
+        if (array_key_exists($index, $this->elements)) {
+            return $this->elements[$index];
+        }
+
+        return null;
+    }
+
+    /**
+     * Removes the element at requested index
+     *
+     * @param int|\PhpOffice\PhpWord\Element\AbstractElement $toRemove
+     */
+    public function removeElement($toRemove)
+    {
+        if (is_int($toRemove) && array_key_exists($toRemove, $this->elements)) {
+            unset($this->elements[$toRemove]);
+        } elseif ($toRemove instanceof \PhpOffice\PhpWord\Element\AbstractElement) {
+            foreach ($this->elements as $key => $element) {
+                if ($element->getElementId() === $toRemove->getElementId()) {
+                    unset($this->elements[$key]);
+
+                    return;
+                }
+            }
+        }
+    }
+
     /**
      * Count elements
      *

src/PhpWord/Element/Bookmark.php

@@ -43,7 +43,7 @@ class Bookmark extends AbstractElement
      *
      * @param string $name
      */
-    public function __construct($name)
+    public function __construct($name = '')
     {
         $this->name = CommonText::toUTF8($name);
     }

src/PhpWord/Element/ListItem.php

@@ -62,7 +62,7 @@ public function __construct($text, $depth = 0, $fontStyle = null, $listStyle = n
 
         // Version >= 0.10.0 will pass numbering style name. Older version will use old method
         if (!is_null($listStyle) && is_string($listStyle)) {
-            $this->style = new ListItemStyle($listStyle);
+            $this->style = new ListItemStyle($listStyle); // @codeCoverageIgnore
         } else {
             $this->style = $this->setNewStyle(new ListItemStyle(), $listStyle, true);
         }

src/PhpWord/Element/Title.php

@@ -28,7 +28,7 @@ class Title extends AbstractElement
     /**
      * Title Text content
      *
-     * @var string
+     * @var string|TextRun
      */
     private $text;
 
@@ -56,15 +56,25 @@ class Title extends AbstractElement
     /**
      * Create a new Title Element
      *
-     * @param string $text
+     * @param string|TextRun $text
      * @param int $depth
      */
     public function __construct($text, $depth = 1)
     {
-        $this->text = CommonText::toUTF8($text);
+        if (isset($text)) {
+            if (is_string($text)) {
+                $this->text = CommonText::toUTF8($text);
+            } elseif ($text instanceof TextRun) {
+                $this->text = $text;
+            } else {
+                throw new \InvalidArgumentException('Invalid text, should be a string or a TextRun');
+            }
+        }
+
         $this->depth = $depth;
-        if (array_key_exists("Heading_{$this->depth}", Style::getStyles())) {
-            $this->style = "Heading{$this->depth}";
+        $styleName = $depth === 0 ? 'Title' : "Heading_{$this->depth}";
+        if (array_key_exists($styleName, Style::getStyles())) {
+            $this->style = str_replace('_', '', $styleName);
         }
 
         return $this;