Add Abstract- prefix and -Interface suffix for corresponding classes

Author: ivanlanin

CHANGELOG.md

@@ -39,23 +39,23 @@ This is the changelog between releases of PHPWord. Releases are listed in revers
 - `createHeader` replaced by `addHeader`
 - `createFooter` replaced by `addFooter`
 - `createSection` replaced by `addSection`
-- `Element\Footnote::getReferenceId` replaced by `Container\Container::getRelationId`
-- `Element\Footnote::setReferenceId` replaced by `Container\Container::setRelationId`
+- `Element\Footnote::getReferenceId` replaced by `Element\AbstractElement::getRelationId`
+- `Element\Footnote::setReferenceId` replaced by `Element\AbstractElement::setRelationId`
 - `Footnote::addFootnoteLinkElement` replaced by `Media::addElement`
 - `Footnote::getFootnoteLinkElements` replaced by `Media::getElements`
 - All current methods on `Media`
 
 ### Miscellaneous
 
 - Documentation: Simplify page level docblock - @ivanlanin GH-179
-- Writer: Refactor writer classes and make a new Writer abstract class - @ivanlanin GH-160
-- Reader: Rename AbstractReader > Reader - @ivanlanin
-- General: Refactor folders: Element, Container, and Exception - @ivanlanin GH-187
+- Writer: Refactor writer classes and make a new AbstractWriter abstract class - @ivanlanin GH-160
+- General: Refactor folders: Element and Exception - @ivanlanin GH-187
 - General: Remove legacy HashTable and ZipStreamWrapper and all related properties/methods - @ivanlanin GH-187
-- Container: Create new Container abstract class - @ivanlanin GH-187
-- Element: Create new Element abstract class - @ivanlanin GH-187
+- Element: Create new AbstractElement abstract class - @ivanlanin GH-187
 - Media: Refactor media class to use one method for all docPart (section, header, footer, footnote) - @ivanlanin GH-187
-- General: Remove underscore prefix from all private properties name
+- General: Remove underscore prefix from all private properties name - @ivanlanin GH-187
+- General: Move Section Settings to Style\Section - @ivanlanin GH-187
+- 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
 
 ## 0.9.1 - 27 Mar 2014
 

src/PhpWord/Element/AbstractElement.php

@@ -7,7 +7,7 @@
  * @license     http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
  */
 
-namespace PhpOffice\PhpWord\Container;
+namespace PhpOffice\PhpWord\Element;
 
 use PhpOffice\PhpWord\Exception\InvalidImageException;
 use PhpOffice\PhpWord\Exception\InvalidObjectException;
@@ -35,7 +35,7 @@
  *
  * @since 0.9.2
  */
-abstract class Container extends Element
+abstract class AbstractElement
 {
     /**
      * Container type section|header|footer|cell|textrun|footnote
@@ -51,6 +51,28 @@ abstract class Container extends Element
      */
     protected $sectionId;
 
+    /**
+     * Document part type: section|header|footer
+     *
+     * Used by textrun and cell container to determine where the element is
+     * located because it will affect the availability of other element,
+     * e.g. footnote will not be available when $docPart is header or footer.
+     *
+     * @var string
+     */
+    private $docPart = 'section';
+
+    /**
+     * Document part Id
+     *
+     * For header and footer, this will be = ($sectionId - 1) * 3 + $index
+     * because the max number of header/footer in every page is 3, i.e.
+     * AUTO, FIRST, and EVEN (AUTO = ODD)
+     *
+     * @var integer
+     */
+    private $docPartId = 1;
+
     /**
      * Elements collection
      *
@@ -340,6 +362,38 @@ public function getSectionId()
         return $this->sectionId;
     }
 
+    /**
+     * Set doc part
+     *
+     * @param string $docPart
+     * @param integer $docPartId
+     */
+    public function setDocPart($docPart, $docPartId = 1)
+    {
+        $this->docPart = $docPart;
+        $this->docPartId = $docPartId;
+    }
+
+    /**
+     * Get doc part
+     *
+     * @return string
+     */
+    public function getDocPart()
+    {
+        return $this->docPart;
+    }
+
+    /**
+     * Get doc part Id
+     *
+     * @return integer
+     */
+    public function getDocPartId()
+    {
+        return $this->docPartId;
+    }
+
     /**
      * Get all elements
      *
@@ -373,40 +427,37 @@ public function setRelationId($rId)
     }
 
     /**
-     * Add memory image element
+     * Check if element is located in section doc part (as opposed to header/footer)
      *
-     * @param string $src
-     * @param mixed $style
-     * @deprecated 0.9.0
-     * @codeCoverageIgnore
+     * @return boolean
      */
-    public function addMemoryImage($src, $style = null)
+    public function isInSection()
     {
-        return $this->addImage($src, $style);
+        return ($this->docPart == 'section');
     }
 
     /**
-     * Create textrun element
+     * Set style value
      *
-     * @param mixed $paragraphStyle
-     * @deprecated 0.9.2
-     * @codeCoverageIgnore
+     * @param mixed $styleObject Style object
+     * @param mixed $styleValue Style value
+     * @param boolean $returnObject Always return object
      */
-    public function createTextRun($paragraphStyle = null)
+    protected function setStyle($styleObject, $styleValue = null, $returnObject = false)
     {
-        return $this->addTextRun($paragraphStyle);
-    }
+        if (!is_null($styleValue) && is_array($styleValue)) {
+            foreach ($styleValue as $key => $value) {
+                if (substr($key, 0, 1) == '_') {
+                    $key = substr($key, 1);
+                }
+                $styleObject->setStyleValue($key, $value);
+            }
+            $style = $styleObject;
+        } else {
+            $style = $returnObject ? $styleObject : $styleValue;
+        }
 
-    /**
-     * Create footnote element
-     *
-     * @param mixed $paragraphStyle
-     * @deprecated 0.9.2
-     * @codeCoverageIgnore
-     */
-    public function createFootnote($paragraphStyle = null)
-    {
-        return $this->addFootnote($paragraphStyle);
+        return $style;
     }
 
     /**
@@ -417,13 +468,14 @@ public function createFootnote($paragraphStyle = null)
      */
     private function checkValidity($method)
     {
-        // Empty array means the element can be accepted by all containers
+        // Valid containers for each element
+        $allContainers = array('section', 'header', 'footer', 'cell', 'textrun', 'footnote');
         $validContainers = array(
-            'text'          => array(),
-            'link'          => array(),
-            'textbreak'     => array(),
-            'image'         => array(),
-            'object'        => array(),
+            'text'          => $allContainers,
+            'link'          => $allContainers,
+            'textbreak'     => $allContainers,
+            'image'         => $allContainers,
+            'object'        => $allContainers,
             'textrun'       => array('section', 'header', 'footer', 'cell'),
             'listitem'      => array('section', 'header', 'footer', 'cell'),
             'checkbox'      => array('section', 'header', 'footer', 'cell'),
@@ -442,10 +494,8 @@ private function checkValidity($method)
 
         // Check if a method is valid for current container
         if (array_key_exists($method, $validContainers)) {
-            if (!empty($validContainers[$method])) {
-                if (!in_array($this->container, $validContainers[$method])) {
-                    throw new \BadMethodCallException();
-                }
+            if (!in_array($this->container, $validContainers[$method])) {
+                throw new \BadMethodCallException();
             }
         }
         // Check if a method is valid for current container, located in other container
@@ -475,4 +525,41 @@ private function checkElementDocPart()
 
         return $inHeaderFooter ? $docPart . $docPartId : $docPart;
     }
+
+    /**
+     * Add memory image element
+     *
+     * @param string $src
+     * @param mixed $style
+     * @deprecated 0.9.0
+     * @codeCoverageIgnore
+     */
+    public function addMemoryImage($src, $style = null)
+    {
+        return $this->addImage($src, $style);
+    }
+
+    /**
+     * Create textrun element
+     *
+     * @param mixed $paragraphStyle
+     * @deprecated 0.9.2
+     * @codeCoverageIgnore
+     */
+    public function createTextRun($paragraphStyle = null)
+    {
+        return $this->addTextRun($paragraphStyle);
+    }
+
+    /**
+     * Create footnote element
+     *
+     * @param mixed $paragraphStyle
+     * @deprecated 0.9.2
+     * @codeCoverageIgnore
+     */
+    public function createFootnote($paragraphStyle = null)
+    {
+        return $this->addFootnote($paragraphStyle);
+    }
 }

src/PhpWord/Element/Cell.php

@@ -9,13 +9,12 @@
 
 namespace PhpOffice\PhpWord\Element;
 
-use PhpOffice\PhpWord\Container\Container;
 use PhpOffice\PhpWord\Style\Cell as CellStyle;
 
 /**
  * Table cell element
  */
-class Cell extends Container
+class Cell extends AbstractElement
 {
     /**
      * Cell width

src/PhpWord/Element/CheckBox.php

@@ -15,7 +15,7 @@
 /**
  * Check box element
  */
-class CheckBox extends Element
+class CheckBox extends AbstractElement
 {
     /**
      * Name content