Refactor writers and readers

- Create Writer abstract class
- Inherit writers class from Writer
- Inherit ODText\WriterPart from Word2007\WriterPart
- Rename AbstractReader > Reader

Author: ivanlanin

CHANGELOG.md

@@ -21,6 +21,8 @@ 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 Writer abstract class - @ivanlanin GH-160
+- Reader: Rename AbstractReader > Reader - @ivanlanin
 
 ## 0.9.1 - 27 Mar 2014
 

src/PhpWord/Reader/AbstractReader.php renamed to src/PhpWord/Reader/Reader.php

@@ -16,7 +16,7 @@
  *
  * @codeCoverageIgnore Abstract class
  */
-abstract class AbstractReader implements IReader
+abstract class Reader implements IReader
 {
     /**
      * Read data only?

src/PhpWord/Reader/Word2007.php

@@ -16,7 +16,7 @@
 /**
  * Reader for Word2007
  */
-class Word2007 extends AbstractReader implements IReader
+class Word2007 extends Reader implements IReader
 {
     /**
      * Can the current IReader read the file?

src/PhpWord/Writer/ODText.php

@@ -21,42 +21,14 @@
 /**
  * ODText writer
  */
-class ODText implements IWriter
+class ODText extends Writer implements IWriter
 {
-    /**
-     * PHPWord object
-     *
-     * @var \PhpOffice\PhpWord\PhpWord
-     */
-    private $_document;
-
-    /**
-     * Individual writers
-     *
-     * @var \PhpOffice\PhpWord\Writer\ODText\WriterPart[]
-     */
-    private $_writerParts;
-
     /**
      * Private unique PHPWord_Worksheet_BaseDrawing HashTable
      *
      * @var \PhpOffice\PhpWord\HashTable
      */
-    private $_drawingHashTable;
-
-    /**
-     * Use disk caching where possible?
-     *
-     * @var boolean
-     */
-    private $_useDiskCaching = false;
-
-    /**
-     * Disk caching directory
-     *
-     * @var string
-     */
-    private $_diskCachingDirectory;
+    private $drawingHashTable;
 
     /**
      * Create new ODText writer
@@ -67,24 +39,18 @@ public function __construct(PhpWord $phpWord = null)
         // Assign PhpWord
         $this->setPhpWord($phpWord);
 
-        // Set up disk caching location
-        $this->_diskCachingDirectory = './';
-
-        // Initialise writer parts
-        $this->_writerParts['content'] = new Content();
-        $this->_writerParts['manifest'] = new Manifest();
-        $this->_writerParts['meta'] = new Meta();
-        $this->_writerParts['mimetype'] = new Mimetype();
-        $this->_writerParts['styles'] = new Styles();
-
-
-        // Assign parent IWriter
-        foreach ($this->_writerParts as $writer) {
+        // Set writer parts
+        $this->writerParts['content'] = new Content();
+        $this->writerParts['manifest'] = new Manifest();
+        $this->writerParts['meta'] = new Meta();
+        $this->writerParts['mimetype'] = new Mimetype();
+        $this->writerParts['styles'] = new Styles();
+        foreach ($this->writerParts as $writer) {
             $writer->setParentWriter($this);
         }
 
         // Set HashTable variables
-        $this->_drawingHashTable = new HashTable();
+        $this->drawingHashTable = new HashTable();
     }
 
     /**
@@ -95,17 +61,8 @@ public function __construct(PhpWord $phpWord = null)
      */
     public function save($pFilename = null)
     {
-        if (!is_null($this->_document)) {
-            // If $pFilename is php://output or php://stdout, make it a temporary file...
-            $originalFilename = $pFilename;
-            if (strtolower($pFilename) == 'php://output' || strtolower($pFilename) == 'php://stdout') {
-                $pFilename = @tempnam(sys_get_temp_dir(), 'phpword_');
-                if ($pFilename == '') {
-                    $pFilename = $originalFilename;
-                }
-            }
-
-            // Create drawing dictionary
+        if (!is_null($this->phpWord)) {
+            $pFilename = $this->getTempFile($pFilename);
 
             // Create new ZIP file and open it for writing
             $objZip = new \ZipArchive();
@@ -119,19 +76,19 @@ public function save($pFilename = null)
 
             // Add mimetype to ZIP file
             //@todo Not in \ZipArchive::CM_STORE mode
-            $objZip->addFromString('mimetype', $this->getWriterPart('mimetype')->writeMimetype($this->_document));
+            $objZip->addFromString('mimetype', $this->getWriterPart('mimetype')->writeMimetype($this->phpWord));
 
             // Add content.xml to ZIP file
-            $objZip->addFromString('content.xml', $this->getWriterPart('content')->writeContent($this->_document));
+            $objZip->addFromString('content.xml', $this->getWriterPart('content')->writeContent($this->phpWord));
 
             // Add meta.xml to ZIP file
-            $objZip->addFromString('meta.xml', $this->getWriterPart('meta')->writeMeta($this->_document));
+            $objZip->addFromString('meta.xml', $this->getWriterPart('meta')->writeMeta($this->phpWord));
 
             // Add styles.xml to ZIP file
-            $objZip->addFromString('styles.xml', $this->getWriterPart('styles')->writeStyles($this->_document));
+            $objZip->addFromString('styles.xml', $this->getWriterPart('styles')->writeStyles($this->phpWord));
 
             // Add META-INF/manifest.xml
-            $objZip->addFromString('META-INF/manifest.xml', $this->getWriterPart('manifest')->writeManifest($this->_document));
+            $objZip->addFromString('META-INF/manifest.xml', $this->getWriterPart('manifest')->writeManifest($this->phpWord));
 
             // Add media. Has not used yet. Legacy from PHPExcel.
             // @codeCoverageIgnoreStart
@@ -173,111 +130,19 @@ public function save($pFilename = null)
                 throw new Exception("Could not close zip file $pFilename.");
             }
 
-            // If a temporary file was used, copy it to the correct file stream
-            if ($originalFilename != $pFilename) {
-                if (copy($pFilename, $originalFilename) === false) {
-                    throw new Exception("Could not copy temporary zip file $pFilename to $originalFilename.");
-                }
-                @unlink($pFilename);
-            }
-
+            $this->cleanupTempFile();
         } else {
             throw new Exception("PhpWord object unassigned.");
         }
     }
 
-    /**
-     * Get PhpWord object
-     *
-     * @return \PhpOffice\PhpWord\PhpWord
-     * @throws \PhpOffice\PhpWord\Exceptions\Exception
-     */
-    public function getPhpWord()
-    {
-        if (!is_null($this->_document)) {
-            return $this->_document;
-        } else {
-            throw new Exception("No PhpWord assigned.");
-        }
-    }
-
-    /**
-     * Set PhpWord object
-     *
-     * @param  \PhpOffice\PhpWord\PhpWord $phpWord
-     * @return \PhpOffice\PhpWord\Writer\ODText
-     */
-    public function setPhpWord(PhpWord $phpWord = null)
-    {
-        $this->_document = $phpWord;
-        return $this;
-    }
-
     /**
      * Get PHPWord_Worksheet_BaseDrawing HashTable
      *
      * @return \PhpOffice\PhpWord\HashTable
      */
     public function getDrawingHashTable()
     {
-        return $this->_drawingHashTable;
-    }
-
-    /**
-     * Get writer part
-     *
-     * @param string $pPartName Writer part name
-     * @return \PhpOffice\PhpWord\Writer\ODText\WriterPart
-     */
-    public function getWriterPart($pPartName = '')
-    {
-        if ($pPartName != '' && isset($this->_writerParts[strtolower($pPartName)])) {
-            return $this->_writerParts[strtolower($pPartName)];
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Get use disk caching where possible?
-     *
-     * @return boolean
-     */
-    public function getUseDiskCaching()
-    {
-        return $this->_useDiskCaching;
-    }
-
-    /**
-     * Set use disk caching where possible?
-     *
-     * @param boolean $pValue
-     * @param string $pDirectory Disk caching directory
-     * @throws \PhpOffice\PhpWord\Exceptions\Exception Exception when directory does not exist
-     * @return \PhpOffice\PhpWord\Writer\ODText
-     */
-    public function setUseDiskCaching($pValue = false, $pDirectory = null)
-    {
-        $this->_useDiskCaching = $pValue;
-
-        if (!is_null($pDirectory)) {
-            if (is_dir($pDirectory)) {
-                $this->_diskCachingDirectory = $pDirectory;
-            } else {
-                throw new Exception("Directory does not exist: $pDirectory");
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Get disk caching directory
-     *
-     * @return string
-     */
-    public function getDiskCachingDirectory()
-    {
-        return $this->_diskCachingDirectory;
+        return $this->drawingHashTable;
     }
 }

src/PhpWord/Writer/ODText/Content.php

@@ -41,12 +41,7 @@ class Content extends WriterPart
     public function writeContent(PhpWord $phpWord = null)
     {
         // Create XML writer
-        $xmlWriter = null;
-        if ($this->getParentWriter()->getUseDiskCaching()) {
-            $xmlWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
-        } else {
-            $xmlWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
-        }
+        $xmlWriter = $this->getXmlWriter();
 
         // XML header
         $xmlWriter->startDocument('1.0', 'UTF-8');

src/PhpWord/Writer/ODText/Manifest.php

@@ -27,12 +27,7 @@ class Manifest extends WriterPart
     public function writeManifest(PhpWord $phpWord = null)
     {
         // Create XML writer
-        $xmlWriter = null;
-        if ($this->getParentWriter()->getUseDiskCaching()) {
-            $xmlWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
-        } else {
-            $xmlWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
-        }
+        $xmlWriter = $this->getXmlWriter();
 
         // XML header
         $xmlWriter->startDocument('1.0', 'UTF-8');

src/PhpWord/Writer/ODText/Meta.php

@@ -26,12 +26,7 @@ class Meta extends WriterPart
     public function writeMeta(PhpWord $phpWord = null)
     {
         // Create XML writer
-        $xmlWriter = null;
-        if ($this->getParentWriter()->getUseDiskCaching()) {
-            $xmlWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
-        } else {
-            $xmlWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
-        }
+        $xmlWriter = $this->getXmlWriter();
 
         // XML header
         $xmlWriter->startDocument('1.0', 'UTF-8');

src/PhpWord/Writer/ODText/Styles.php

@@ -30,12 +30,7 @@ class Styles extends WriterPart
     public function writeStyles(PhpWord $phpWord = null)
     {
         // Create XML writer
-        $xmlWriter = null;
-        if ($this->getParentWriter()->getUseDiskCaching()) {
-            $xmlWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
-        } else {
-            $xmlWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
-        }
+        $xmlWriter = $this->getXmlWriter();
 
         // XML header
         $xmlWriter->startDocument('1.0', 'UTF-8');

src/PhpWord/Writer/ODText/WriterPart.php

@@ -9,43 +9,9 @@
 
 namespace PhpOffice\PhpWord\Writer\ODText;
 
-use PhpOffice\PhpWord\Exceptions\Exception;
-use PhpOffice\PhpWord\Writer\IWriter;
-
 /**
  * ODText writer part abstract
  */
-abstract class WriterPart
+abstract class WriterPart extends \PhpOffice\PhpWord\Writer\Word2007\WriterPart
 {
-    /**
-     * Parent IWriter object
-     *
-     * @var \PhpOffice\PhpWord\Writer\IWriter
-     */
-    private $_parentWriter;
-
-    /**
-     * Set parent IWriter object
-     *
-     * @param \PhpOffice\PhpWord\Writer\IWriter $pWriter
-     */
-    public function setParentWriter(IWriter $pWriter = null)
-    {
-        $this->_parentWriter = $pWriter;
-    }
-
-    /**
-     * Get parent IWriter object
-     *
-     * @return \PhpOffice\PhpWord\Writer\IWriter
-     * @throws \PhpOffice\PhpWord\Exceptions\Exception
-     */
-    public function getParentWriter()
-    {
-        if (!is_null($this->_parentWriter)) {
-            return $this->_parentWriter;
-        } else {
-            throw new Exception("No parent IWriter assigned.");
-        }
-    }
 }