Ability to add Endnotes

Author: ivanlanin

CHANGELOG.md

@@ -4,7 +4,7 @@ This is the changelog between releases of PHPWord. Releases are listed in revers
 
 ## 0.9.2 - Not yet released
 
-This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. `Element` subnamespace is introduced in this release to replace `Section`.
+This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. `Element` subnamespace is introduced in this release to replace `Section`. Word2007 reader capability is greatly enhanced. Endnote is introduced.
 
 ### Features
 
@@ -28,6 +28,7 @@ This release marked heavy refactorings on internal code structure with the creat
 - Media: Add `Media::resetElements()` to reset all media data - @juzi GH-19
 - General: Add `Style::resetStyles()`, `Footnote::resetElements()`, and `TOC::resetTitles()` - @ivanlanin GH-187
 - Reader: Ability to read header, footer, footnotes, link, preservetext, textbreak, pagebreak, table - @ivanlanin
+- Endnote: Ability to add endnotes - @ivanlanin
 
 ### Bugfixes
 
@@ -59,6 +60,7 @@ This release marked heavy refactorings on internal code structure with the creat
 - General: Give `Abstract` prefix and `Interface` suffix for all abstract classes and interfaces as per [PHP-FIG recommendation](https://github.com/php-fig/fig-standards/blob/master/bylaws/002-psr-naming-conventions.md) - @ivanlanin GH-187
 - Style: New `Style\AbstractStyle` abstract class - @ivanlanin GH-187
 - Writer: New 'ODText\Base` class - @ivanlanin GH-187
+- General: Rename `Footnote` to `Footnotes` to reflect the nature of collection - @ivanlanin
 
 ## 0.9.1 - 27 Mar 2014
 

README.md

@@ -25,6 +25,7 @@ With PHPWord, you can create DOCX, ODT, or RTF documents dynamically using your
 * Insert and format table with customized properties for each rows (e.g. repeat as header row) and cells (e.g. background color, rowspan, colspan)
 * Insert list items as bulleted, numbered, or multilevel
 * Insert hyperlinks
+* Insert footnotes and endnotes
 * Create document from templates
 * Use XSL 1.0 style sheets to transform main document part of OOXML template
 * ... and many more features on progress

docs/elements.rst

@@ -37,7 +37,9 @@ the containers while the rows lists the elements.
 +-----+---------------+---------+--------+--------+------+----------+----------+
 | 14  | Footnote      |   v     |   \-   |   \-   | v\*\*|   v\*\*  |   \-     |
 +-----+---------------+---------+--------+--------+------+----------+----------+
-| 15  | CheckBox      |   v     |   v    |   v    |  v   |   ?      |   ?      |
+| 15  | Endnote       |   v     |   \-   |   \-   | v\*\*|   v\*\*  |   \-     |
++-----+---------------+---------+--------+--------+------+----------+----------+
+| 16  | CheckBox      |   v     |   v    |   v    |  v   |   ?      |   ?      |
 +-----+---------------+---------+--------+--------+------+----------+----------+
 
 Legend:
@@ -376,12 +378,13 @@ Options for ``$tocStyle``:
    twips.
 -  ``indent`` The indent factor of the titles in twips.
 
-Footnotes
----------
+Footnotes & endnotes
+--------------------
 
-You can create footnotes in texts or textruns, but it's recommended to
-use textrun to have better layout. You can use ``addText``, ``addLink``,
-and ``addTextBreak`` on a footnote.
+You can create footnotes with ``addFootnote`` and endnotes with ``addEndnote``
+in texts or textruns, but it's recommended to use textrun to have better layout.
+You can use ``addText``, ``addLink``, ``addTextBreak``, ``addImage``,
+``addObject`` on footnotes and endnotes.
 
 On textrun:
 
@@ -396,6 +399,8 @@ On textrun:
     $footnote->addTextBreak();
     $footnote->addText('And text break.');
     $textrun->addText('Trailing text.');
+    $endnote = $textrun->addEndnote();
+    $endnote->addText('Endnote put at the end');
 
 On text:
 

docs/intro.rst

@@ -48,6 +48,7 @@ Features
    rowspan, colspan)
 -  Insert list items as bulleted, numbered, or multilevel
 -  Insert hyperlinks
+-  Insert footnotes and endnotes
 -  Create document from templates
 -  Use XSL 1.0 style sheets to transform main document part of OOXML
    template
@@ -90,8 +91,6 @@ Writers
 +                         +-----------------------+--------+-------+-------+
 |                         | Image                 | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | MemoryImage           | ✓      |       |       |
-+                         +-----------------------+--------+-------+-------+
 |                         | Object                | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | Watermark             | ✓      |       |       |
@@ -103,6 +102,8 @@ Writers
 |                         | Footer                | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | Footnote              | ✓      |       |       |
++                         +-----------------------+--------+-------+-------+
+|                         | Endnote               | ✓      |       |       |
 +-------------------------+-----------------------+--------+-------+-------+
 | **Graphs**              | 2D basic graphs       |        |       |       |
 +                         +-----------------------+--------+-------+-------+
@@ -126,45 +127,45 @@ Readers
 +-------------------------------------------------+--------+-------+-------+
 | Features                                        | DOCX   | ODT   | RTF   |
 +=========================+=======================+========+=======+=======+
-| **Document Properties** | Standard              |        |       |       |
+| **Document Properties** | Standard              | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | Extended              |        |       |       |
+|                         | Extended              | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | UserDefined           |        |       |       |
+|                         | UserDefined           | ✓      |       |       |
 +-------------------------+-----------------------+--------+-------+-------+
 | **Element Type**        | Text                  | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | Text Run              | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | Title                 |        |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | Link                  |        |       |       |
+|                         | Link                  | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | Preserve Text         |        |       |       |
+|                         | Preserve Text         | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | Text Break            | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | Page Break            |        |       |       |
+|                         | Page Break            | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | List                  |        |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | Table                 |        |       |       |
+|                         | Table                 | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | Image                 |        |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | MemoryImage           |        |       |       |
-+                         +-----------------------+--------+-------+-------+
 |                         | Object                |        |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | Watermark             |        |       |       |
 +                         +-----------------------+--------+-------+-------+
 |                         | Table of Contents     |        |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | Header                |        |       |       |
+|                         | Header                | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | Footer                |        |       |       |
+|                         | Footer                | ✓      |       |       |
++                         +-----------------------+--------+-------+-------+
+|                         | Footnote              | ✓      |       |       |
 +                         +-----------------------+--------+-------+-------+
-|                         | Footnote              |        |       |       |
+|                         | Endnote               | ✓      |       |       |
 +-------------------------+-----------------------+--------+-------+-------+
 | **Graphs**              | 2D basic graphs       |        |       |       |
 +                         +-----------------------+--------+-------+-------+

src/PhpWord/Element/AbstractElement.php

@@ -13,7 +13,8 @@
 use PhpOffice\PhpWord\Media;
 use PhpOffice\PhpWord\Style;
 use PhpOffice\PhpWord\TOC;
-use PhpOffice\PhpWord\Footnote as FootnoteCollection;
+use PhpOffice\PhpWord\Footnotes;
+use PhpOffice\PhpWord\Endnotes;
 use PhpOffice\PhpWord\Shared\String;
 use PhpOffice\PhpWord\Element\Element;
 use PhpOffice\PhpWord\Element\Text;
@@ -27,6 +28,7 @@
 use PhpOffice\PhpWord\Element\Image;
 use PhpOffice\PhpWord\Element\Object;
 use PhpOffice\PhpWord\Element\Footnote as FootnoteElement;
+use PhpOffice\PhpWord\Element\Endnote;
 use PhpOffice\PhpWord\Element\CheckBox;
 
 /**
@@ -37,7 +39,7 @@
 abstract class AbstractElement
 {
     /**
-     * Container type section|header|footer|cell|textrun|footnote
+     * Container type section|header|footer|cell|textrun|footnote|endnote
      *
      * @var string
      */
@@ -99,7 +101,7 @@ public function addText($text, $fontStyle = null, $paragraphStyle = null)
         $this->checkValidity('text');
 
         // Reset paragraph style for footnote and textrun. They have their own
-        if (in_array($this->container, array('footnote', 'textrun'))) {
+        if (in_array($this->container, array('textrun', 'footnote', 'endnote'))) {
             $paragraphStyle = null;
         }
 
@@ -323,7 +325,7 @@ public function addFootnote($paragraphStyle = null)
         $this->checkValidity('footnote');
 
         $footnote = new FootnoteElement($paragraphStyle);
-        $rId = FootnoteCollection::addFootnoteElement($footnote);
+        $rId = Footnotes::addElement($footnote);
 
         $footnote->setDocPart('footnote', $this->getDocPartId());
         $footnote->setRelationId($rId);
@@ -332,6 +334,26 @@ public function addFootnote($paragraphStyle = null)
         return $footnote;
     }
 
+    /**
+     * Add endnote element
+     *
+     * @param mixed $paragraphStyle
+     * @return Endnote
+     */
+    public function addEndnote($paragraphStyle = null)
+    {
+        $this->checkValidity('endnote');
+
+        $endnote = new Endnote($paragraphStyle);
+        $rId = Endnotes::addElement($endnote);
+
+        $endnote->setDocPart('endnote', $this->getDocPartId());
+        $endnote->setRelationId($rId);
+        $this->elements[] = $endnote;
+
+        return $endnote;
+    }
+
     /**
      * Add a CheckBox Element
      *
@@ -469,7 +491,7 @@ protected function setStyle($styleObject, $styleValue = null, $returnObject = fa
     private function checkValidity($method)
     {
         // Valid containers for each element
-        $allContainers = array('section', 'header', 'footer', 'cell', 'textrun', 'footnote');
+        $allContainers = array('section', 'header', 'footer', 'cell', 'textrun', 'footnote', 'endnote');
         $validContainers = array(
             'text'          => $allContainers,
             'link'          => $allContainers,
@@ -481,6 +503,7 @@ private function checkValidity($method)
             'checkbox'      => array('section', 'header', 'footer', 'cell'),
             'table'         => array('section', 'header', 'footer'),
             'footnote'      => array('section', 'textrun', 'cell'),
+            'endnote'       => array('section', 'textrun', 'cell'),
             'preservetext'  => array('header', 'footer', 'cell'),
             'title'         => array('section'),
         );
@@ -489,6 +512,7 @@ private function checkValidity($method)
         $validContainerInContainers = array(
             'preservetext'  => array(array('cell'), array('header', 'footer')),
             'footnote'      => array(array('cell', 'textrun'), array('section')),
+            'endnote'       => array(array('cell', 'textrun'), array('section')),
         );
 
         // Check if a method is valid for current container

src/PhpWord/Element/Endnote.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * PHPWord
+ *
+ * @link        https://github.com/PHPOffice/PHPWord
+ * @copyright   2014 PHPWord
+ * @license     http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
+ */
+
+namespace PhpOffice\PhpWord\Element;
+
+use PhpOffice\PhpWord\Style\Paragraph;
+
+/**
+ * Endnote element
+ *
+ * @since 0.9.2
+ */
+class Endnote extends Footnote
+{
+    /**
+     * Create new instance
+     *
+     * @param string|array|Paragraph $paragraphStyle
+     */
+    public function __construct($paragraphStyle = null)
+    {
+        $this->container = 'endnote';
+        $this->paragraphStyle = $this->setStyle(new Paragraph(), $paragraphStyle);
+    }
+}

src/PhpWord/Element/Footnote.php

@@ -21,7 +21,7 @@ class Footnote extends AbstractElement
      *
      * @var string|Paragraph
      */
-    private $paragraphStyle;
+    protected $paragraphStyle;
 
     /**
      * Create new instance

src/PhpWord/Endnotes.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * PHPWord
+ *
+ * @link        https://github.com/PHPOffice/PHPWord
+ * @copyright   2014 PHPWord
+ * @license     http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
+ */
+
+namespace PhpOffice\PhpWord;
+
+use PhpOffice\PhpWord\Media;
+use PhpOffice\PhpWord\Element\Endnote;
+
+/**
+ * Endnote collection
+ *
+ * @since 0.9.2
+ */
+class Endnotes
+{
+    /**
+     * Elements
+     *
+     * @var array
+     */
+    private static $elements = array();
+
+    /**
+     * Add new element
+     *
+     * @param Endnote $element
+     * @return integer Reference ID
+     */
+    public static function addElement($element)
+    {
+        $rId = self::countElements() + 1;
+        self::$elements[$rId] = $element;
+
+        return $rId;
+    }
+
+    /**
+     * Set element
+     *
+     * @param integer $index
+     * @param Endnote $element
+     */
+    public static function setElement($index, $element)
+    {
+        if (array_key_exists($index, self::$elements)) {
+            self::$elements[$index] = $element;
+        }
+    }
+
+    /**
+     * Get element by index
+     *
+     * @param integer $index
+     * @return Endnote
+     */
+    public static function getElement($index)
+    {
+        if (array_key_exists($index, self::$elements)) {
+            return self::$elements[$index];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get elements
+     *
+     * @return array
+     */
+    public static function getElements()
+    {
+        return self::$elements;
+    }
+
+    /**
+     * Get element count
+     *
+     * @return integer
+     */
+    public static function countElements()
+    {
+        return count(self::$elements);
+    }
+
+    /**
+     * Reset elements
+     */
+    public static function resetElements()
+    {
+        self::$elements = array();
+    }
+}