New Style\AbstractStyle and 'ODText\Base`

Author: ivanlanin

CHANGELOG.md

@@ -4,6 +4,8 @@ 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`.
+
 ### Features
 
 - Image: Get image dimensions without EXIF extension - @andrew-kzoo GH-184
@@ -48,14 +50,16 @@ This is the changelog between releases of PHPWord. Releases are listed in revers
 ### Miscellaneous
 
 - Documentation: Simplify page level docblock - @ivanlanin GH-179
-- 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
-- Element: Create new AbstractElement abstract class - @ivanlanin GH-187
+- Writer: Refactor writer classes and create a new `Write\AbstractWriter` abstract class - @ivanlanin GH-160
+- General: Refactor folders: `Element` and `Exception` - @ivanlanin GH-187
+- General: Remove legacy `HashTable` and `Shared\ZipStreamWrapper` and all related properties/methods - @ivanlanin GH-187
+- Element: 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 - @ivanlanin GH-187
-- General: Move Section Settings to Style\Section - @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
+- Style: New `Style\AbstractStyle` abstract class - @ivanlanin GH-187
+- Writer: New 'ODText\Base` class - @ivanlanin GH-187
 
 ## 0.9.1 - 27 Mar 2014
 

src/PhpWord/Style/AbstractStyle.php

@@ -0,0 +1,43 @@
+<?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\Style;
+
+/**
+ * Abstract style class
+ *
+ * @since 0.9.2
+ */
+abstract class AbstractStyle
+{
+    /**
+     * Set style value template method
+     *
+     * Some child classes have their own specific overrides
+     *
+     * @param string $key
+     * @param string $value
+     *
+     * @todo Implement type check mechanism, e.g. boolean, integer, enum, defaults
+     */
+    public function setStyleValue($key, $value)
+    {
+        // Backward compability check for versions < 0.9.2 which use underscore
+        // prefix for their private properties
+        if (substr($key, 0, 1) == '_') {
+            $key = substr($key, 1);
+        }
+
+        // Check if the set method is exists. Throws an exception?
+        $method = 'set' . $key;
+        if (method_exists($this, $method)) {
+            $this->$method($value);
+        }
+    }
+}

src/PhpWord/Style/Cell.php

@@ -12,7 +12,7 @@
 /**
  * Table cell style
  */
-class Cell
+class Cell extends AbstractStyle
 {
     const TEXT_DIR_BTLR = 'btLr';
     const TEXT_DIR_TBRL = 'tbRl';

src/PhpWord/Style/Font.php

@@ -15,7 +15,7 @@
 /**
  * Font style
  */
-class Font
+class Font extends AbstractStyle
 {
     const UNDERLINE_NONE = 'none';
     const UNDERLINE_DASH = 'dash';
@@ -202,23 +202,6 @@ public function setArrayStyle(array $style = array())
         return $this;
     }
 
-    /**
-     * Set style value
-     *
-     * @param string $key
-     * @param mixed $value
-     */
-    public function setStyleValue($key, $value)
-    {
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
-        $method = 'set' . $key;
-        if (method_exists($this, $method)) {
-            $this->$method($value);
-        }
-    }
-
     /**
      * Get font name
      *

src/PhpWord/Style/Image.php

@@ -12,7 +12,7 @@
 /**
  * Image and memory image style
  */
-class Image
+class Image extends AbstractStyle
 {
     const WRAPPING_STYLE_INLINE = 'inline';
     const WRAPPING_STYLE_SQUARE = 'square';
@@ -41,13 +41,6 @@ class Image
      */
     private $align;
 
-    /**
-     * Wrapping style
-     *
-     * @var string
-     */
-    private $wrappingStyle;
-
     /**
      * Margin Top
      *
@@ -62,6 +55,13 @@ class Image
      */
     private $marginLeft;
 
+    /**
+     * Wrapping style
+     *
+     * @var string
+     */
+    private $wrappingStyle;
+
     /**
      * Create new image style
      */
@@ -75,20 +75,6 @@ public function __construct()
         $this->setWrappingStyle(self::WRAPPING_STYLE_INLINE);
     }
 
-    /**
-     * Set style value
-     *
-     * @param string $key
-     * @param mixed $value
-     */
-    public function setStyleValue($key, $value)
-    {
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
-        $this->$key = $value;
-    }
-
     /**
      * Get width
      */

src/PhpWord/Style/ListItem.php

@@ -12,7 +12,7 @@
 /**
  * List item style
  */
-class ListItem
+class ListItem extends AbstractStyle
 {
     const TYPE_NUMBER = 7;
     const TYPE_NUMBER_NESTED = 8;
@@ -34,20 +34,6 @@ public function __construct()
         $this->listType = self::TYPE_BULLET_FILLED;
     }
 
-    /**
-     * Set style value
-     *
-     * @param string $key
-     * @param string $value
-     */
-    public function setStyleValue($key, $value)
-    {
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
-        $this->$key = $value;
-    }
-
     /**
      * Set List Type
      *

src/PhpWord/Style/Paragraph.php

@@ -14,7 +14,7 @@
 /**
  * Paragraph style
  */
-class Paragraph
+class Paragraph extends AbstractStyle
 {
     const LINE_HEIGHT = 240;
 

src/PhpWord/Style/Row.php

@@ -12,7 +12,7 @@
 /**
  * Table row style
  */
-class Row
+class Row extends AbstractStyle
 {
     /**
      * Repeat table row on every new page
@@ -42,20 +42,6 @@ public function __construct()
     {
     }
 
-    /**
-     * Set style value
-     *
-     * @param string $key
-     * @param mixed $value
-     */
-    public function setStyleValue($key, $value)
-    {
-        if (substr($key, 0, 1) == '_') {
-            $key = substr($key, 1);
-        }
-        $this->$key = $value;
-    }
-
     /**
      * Set tblHeader
      *

src/PhpWord/Style/Section.php

@@ -12,7 +12,7 @@
 /**
  * Section settings
  */
-class Section
+class Section extends AbstractStyle
 {
     /**
      * Default Page Size Width

src/PhpWord/Style/TOC.php

@@ -12,7 +12,7 @@
 /**
  * TOC style
  */
-class TOC
+class TOC extends AbstractStyle
 {
     const TABLEADER_DOT = 'dot';
     const TABLEADER_UNDERSCORE = 'underscore';

src/PhpWord/Style/Tab.php

@@ -14,7 +14,7 @@
 /**
  * Tab style
  */
-class Tab
+class Tab extends AbstractStyle
 {
     /**
      * Tab Stop Type

src/PhpWord/Style/Table.php

@@ -12,7 +12,7 @@
 /**
  * Table style
  */
-class Table
+class Table extends AbstractStyle
 {
     /**
      * Style for first row

src/PhpWord/Style/Tabs.php

@@ -14,7 +14,7 @@
 /**
  * Tabs style
  */
-class Tabs
+class Tabs extends AbstractStyle
 {
     /**
      * Tabs

src/PhpWord/Writer/AbstractWriter.php

@@ -11,6 +11,7 @@
 
 use PhpOffice\PhpWord\Exception\Exception;
 use PhpOffice\PhpWord\PhpWord;
+use PhpOffice\PhpWord\Settings;
 
 /**
  * Abstract writer class
@@ -148,21 +149,21 @@ public function getDiskCachingDirectory()
     /**
      * Get temporary file name
      *
-     * If $pFilename is php://output or php://stdout, make it a temporary file
+     * If $filename is php://output or php://stdout, make it a temporary file
      *
-     * @param string $pFilename
+     * @param string $filename
      * @return string
      */
-    protected function getTempFile($pFilename)
+    protected function getTempFile($filename)
     {
-        $this->originalFilename = $pFilename;
-        if (strtolower($pFilename) == 'php://output' || strtolower($pFilename) == 'php://stdout') {
-            $pFilename = @tempnam(sys_get_temp_dir(), 'phpword_');
-            if ($pFilename == '') {
-                $pFilename = $this->originalFilename;
+        $this->originalFilename = $filename;
+        if (strtolower($filename) == 'php://output' || strtolower($filename) == 'php://stdout') {
+            $filename = @tempnam(sys_get_temp_dir(), 'phpword_');
+            if ($filename == '') {
+                $filename = $this->originalFilename;
             }
         }
-        $this->tempFilename = $pFilename;
+        $this->tempFilename = $filename;
 
         return $this->tempFilename;
     }
@@ -181,4 +182,37 @@ protected function cleanupTempFile()
             @unlink($this->tempFilename);
         }
     }
+
+    /**
+     * Get ZipArchive object
+     *
+     * @param string $filename
+     * @return mixed ZipArchive object
+     */
+    protected function getZipArchive($filename)
+    {
+        // Create new ZIP file and open it for writing
+        $zipClass = Settings::getZipClass();
+        $objZip = new $zipClass();
+
+        // Retrieve OVERWRITE and CREATE constants from the instantiated zip class
+        // This method of accessing constant values from a dynamic class should work with all appropriate versions of PHP
+        $ro = new \ReflectionObject($objZip);
+        $zipOverWrite = $ro->getConstant('OVERWRITE');
+        $zipCreate = $ro->getConstant('CREATE');
+
+        // Remove any existing file
+        if (file_exists($filename)) {
+            unlink($filename);
+        }
+
+        // Try opening the ZIP file
+        if ($objZip->open($filename, $zipOverWrite) !== true) {
+            if ($objZip->open($filename, $zipCreate) !== true) {
+                throw new Exception("Could not open " . $filename . " for writing.");
+            }
+        }
+
+        return $objZip;
+    }
 }