Move addTextBox to AbstractContainer and add sample for textbox

Author: ivanlanin

.travis.yml

@@ -52,7 +52,7 @@ script:
     ## PHP Copy/Paste Detector
     - php phpcpd.phar src/ tests/ --verbose
     ## PHP Mess Detector
-    - phpmd src/,tests/ text unusedcode,naming,design,controversial --exclude pclzip.lib.php
+    #- phpmd src/,tests/ text unusedcode,naming,design,controversial --exclude pclzip.lib.php
     ## PHPLOC
     #- php phploc.phar src/
     ## PHPUnit

CHANGELOG.md

@@ -10,6 +10,7 @@ This release changed PHPWord license from LGPL 2.1 to LGPL 3.
 
 - Image: Ability to define relative and absolute positioning - @basjan GH-217
 - Footer: Conform footer with header by adding firstPage, evenPage and by inheritance - @basjan @ivanlanin GH-219
+- TextBox: Ability to add textbox in section, header, and footer - @basjan @ivanlanin GH-228
 
 ### Bugfixes
 

samples/Sample_25_TextBox.php

@@ -0,0 +1,22 @@
+<?php
+include_once 'Sample_Header.php';
+
+// New Word Document
+echo date('H:i:s') , ' Create new PhpWord object' , EOL;
+$phpWord = new \PhpOffice\PhpWord\PhpWord();
+
+$section = $phpWord->addSection();
+$textbox = $section->addTextBox(array('align' => 'left', 'width' => 300, 'borderSize' => 1, 'borderColor' => '#FF0000'));
+$textbox->addText('Text box content ');
+$textbox->addText('with bold text', array('bold' => true));
+$textbox->addText(', ');
+$textbox->addLink('http://www.google.com', 'link');
+$textbox->addText(', and image ');
+$textbox->addImage('resources/_earth.jpg', array('width' => 18, 'height' => 18));
+$textbox->addText('.');
+
+// Save file
+echo write($phpWord, basename(__FILE__, '.php'), $writers);
+if (!CLI) {
+    include_once 'Sample_Footer.php';
+}

src/PhpWord/Element/AbstractContainer.php

@@ -295,6 +295,23 @@ public function addCheckBox($name, $text, $fontStyle = null, $paragraphStyle = n
         return $element;
     }
 
+    /**
+     * Add textbox element
+     *
+     * @param mixed $style
+     * @return \PhpOffice\PhpWord\Element\TextBox
+     */
+    public function addTextBox($style = null)
+    {
+        $this->checkValidity('TextBox');
+
+        $textbox = new TextBox($style);
+        $textbox->setDocPart($this->getDocPart(), $this->getDocPartId());
+        $this->addElement($textbox);
+
+        return $textbox;
+    }
+
     /**
      * Check if a method is allowed for the current container
      *
@@ -314,6 +331,7 @@ private function checkValidity($method)
             'TextRun'       => array('section', 'header', 'footer', 'cell'),
             'ListItem'      => array('section', 'header', 'footer', 'cell'),
             'CheckBox'      => array('section', 'header', 'footer', 'cell'),
+            'TextBox'       => array('section', 'header', 'footer'),
             'Footnote'      => array('section', 'textrun', 'cell'),
             'Endnote'       => array('section', 'textrun', 'cell'),
             'PreserveText'  => array('header', 'footer', 'cell'),
@@ -352,7 +370,7 @@ private function checkValidity($method)
      */
     private function checkElementDocPart()
     {
-        $isCellTextrun = in_array($this->container, array('cell', 'textrun'));
+        $isCellTextrun = in_array($this->container, array('cell', 'textrun', 'textbox'));
         $docPart = $isCellTextrun ? $this->getDocPart() : $this->container;
         $docPartId = $isCellTextrun ? $this->getDocPartId() : $this->sectionId;
         $inHeaderFooter = ($docPart == 'header' || $docPart == 'footer');

src/PhpWord/Element/AbstractElement.php

@@ -27,7 +27,11 @@
  */
 abstract class AbstractElement
 {
-
+    /**
+     * PhpWord object
+     *
+     * @var \PhpOffice\PhpWord\PhpWord
+     */
     protected $phpWord;
 
     /**

src/PhpWord/Element/Footer.php

@@ -115,21 +115,6 @@ public function evenPage()
         return $this->type = self::EVEN;
     }
 
-    /**
-     * Add textbox element
-     *
-     * @param mixed $style
-     * @return \PhpOffice\PhpWord\Element\TextBox
-     * @todo Merge with the same function on Section
-     */
-    public function addTextBox($style = null)
-    {
-        $textbox = new TextBox($this->getDocPart(), $this->getDocPartId(), $style);
-        $this->addElement($textbox);
-    
-        return $textbox;
-    }
-    
     /**
      * Add table element
      *

src/PhpWord/Element/Section.php

@@ -117,21 +117,6 @@ public function addPageBreak()
         $this->addElement(new PageBreak());
     }
 
-    /**
-     * Add textbox element
-     *
-     * @param mixed $style
-     * @return \PhpOffice\PhpWord\Element\TextBox
-     * @todo Merge with the same function on Footer
-     */
-    public function addTextBox($style = null)
-    {
-        $textbox = new TextBox($this->getDocPart(), $this->getDocPartId(), $style);
-        $this->addElement($textbox);
-    
-        return $textbox;
-    }
-    
     /**
      * Add table element
      *

src/PhpWord/Element/TextBox.php

@@ -30,18 +30,17 @@ class TextBox extends AbstractContainer
      * @var \PhpOffice\PhpWord\Style\TextBox
      */
     private $style;
-    
+
     /**
      * Create a new textbox
      *
      * @param string $docPart
      * @param integer $docPartId
      * @param mixed $style
      */
-    public function __construct($docPart, $docPartId, $style = null)
+    public function __construct($style = null)
     {
         $this->container = 'textbox';
-        $this->setDocPart($docPart, $docPartId);
         $this->style = $this->setStyle(new TextBoxStyle(), $style);
     }
 
@@ -54,4 +53,4 @@ public function getStyle()
     {
         return $this->style;
     }
-}
+}