Basic RTF Reader

CHANGELOG.md

@@ -4,7 +4,7 @@ This is the changelog between releases of PHPWord. Releases are listed in revers
 
 ## 0.11.0 - Not yet released
 
-This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Three new elements were added: TextBox, ListItemRun, and Field. Relative and absolute positioning for images and textboxes were added. Writer classes were refactored into parts, elements, and styles. ODT and RTF features were enhanced. Ability to add elements to PHPWord object via HTML were implemeted.
+This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Three new elements were added: TextBox, ListItemRun, and Field. Relative and absolute positioning for images and textboxes were added. Writer classes were refactored into parts, elements, and styles. ODT and RTF features were enhanced. Ability to add elements to PHPWord object via HTML were implemeted. RTF reader were initiated.
 
 ### Features
 
@@ -30,6 +30,7 @@ This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Three
 - RTF Writer: Ability to write document properties - @ivanlanin
 - RTF Writer: Ability to write image - @ivanlanin
 - Element: New `Field` element - @basjan GH-251
+- RTF Reader: Basic RTF reader - @ivanlanin GH-72
 
 ### Bugfixes
 

docs/elements.rst

@@ -88,7 +88,7 @@ Inline style examples:
     $textrun = $section->addTextRun();
     $textrun->addText('I am bold', array('bold' => true));
     $textrun->addText('I am italic', array('italic' => true));
-    $textrun->addText('I am colored, array('color' => 'AACC00'));
+    $textrun->addText('I am colored', array('color' => 'AACC00'));
 
 Defined style examples:
 

docs/intro.rst

@@ -124,7 +124,7 @@ Readers
 +---------------------------+----------------------+--------+-------+-------+
 |                           | Custom               | ✓      |       |       |
 +---------------------------+----------------------+--------+-------+-------+
-| **Element Type**          | Text                 | ✓      | ✓     |       |
+| **Element Type**          | Text                 | ✓      | ✓     | ✓     |
 +---------------------------+----------------------+--------+-------+-------+
 |                           | Text Run             | ✓      |       |       |
 +---------------------------+----------------------+--------+-------+-------+

docs/src/documentation.md

@@ -114,7 +114,7 @@ Below are the supported features for each file formats.
 |-------------------------|--------------------|------|-----|-----|
 | **Document Properties** | Standard           | ✓    |     |     |
 |                         | Custom             | ✓    |     |     |
-| **Element Type**        | Text               | ✓    | ✓   |     |
+| **Element Type**        | Text               | ✓    | ✓   | ✓   |
 |                         | Text Run           | ✓    |     |     |
 |                         | Title              | ✓    | ✓   |     |
 |                         | Link               | ✓    |     |     |
@@ -495,7 +495,7 @@ $section->addText('I am simple paragraph', $fontStyle, $paragraphStyle);
 $textrun = $section->addTextRun();
 $textrun->addText('I am bold', array('bold' => true));
 $textrun->addText('I am italic', array('italic' => true));
-$textrun->addText('I am colored, array('color' => 'AACC00'));
+$textrun->addText('I am colored', array('color' => 'AACC00'));
 ```
 
 Defined style examples:

samples/Sample_11_ReadWord2007.php

@@ -3,7 +3,8 @@
 
 // Read contents
 $name = basename(__FILE__, '.php');
-$source = "resources/{$name}.docx";
+$source = __DIR__ . "/resources/{$name}.docx";
+
 echo date('H:i:s'), " Reading contents from `{$source}`", EOL;
 $phpWord = \PhpOffice\PhpWord\IOFactory::load($source);
 

samples/Sample_24_ReadODText.php

@@ -3,7 +3,8 @@
 
 // Read contents
 $name = basename(__FILE__, '.php');
-$source = "resources/{$name}.odt";
+$source = __DIR__ . "/resources/{$name}.odt";
+
 echo date('H:i:s'), " Reading contents from `{$source}`", EOL;
 $phpWord = \PhpOffice\PhpWord\IOFactory::load($source, 'ODText');
 

samples/Sample_28_ReadRTF.php

@@ -0,0 +1,15 @@
+<?php
+include_once 'Sample_Header.php';
+
+// Read contents
+$name = basename(__FILE__, '.php');
+$source = __DIR__ . "/resources/{$name}.rtf";
+
+echo date('H:i:s'), " Reading contents from `{$source}`", EOL;
+$phpWord = \PhpOffice\PhpWord\IOFactory::load($source, 'RTF');
+
+// Save file
+echo write($phpWord, basename(__FILE__, '.php'), $writers);
+if (!CLI) {
+    include_once 'Sample_Footer.php';
+}

samples/Sample_Header.php

@@ -63,8 +63,8 @@ function write($phpWord, $filename, $writers)
         $result .= date('H:i:s') . " Write to {$writer} format";
         if (!is_null($extension)) {
             $xmlWriter = IOFactory::createWriter($phpWord, $writer);
-            $xmlWriter->save("{$filename}.{$extension}");
-            rename("{$filename}.{$extension}", "results/{$filename}.{$extension}");
+            $xmlWriter->save(__DIR__ . "/{$filename}.{$extension}");
+            rename(__DIR__ . "/{$filename}.{$extension}", __DIR__ . "/results/{$filename}.{$extension}");
         } else {
             $result .= ' ... NOT DONE!';
         }

samples/resources/Sample_28_ReadRTF.rtf

@@ -0,0 +1,21 @@
+{\rtf1
+\ansi\ansicpg1252
+\deff0
+{\fonttbl{\f0\fnil\fcharset0 Arial;}{\f1\fnil\fcharset0 Times New Roman;}}
+{\colortbl;\red255\green0\blue0;\red14\green0\blue0}
+{\*\generator PhpWord;}
+
+{\info{\title }{\subject }{\category }{\keywords }{\comment }{\author }{\operator }{\creatim \yr2014\mo05\dy27\hr23\min36\sec45}{\revtim \yr2014\mo05\dy27\hr23\min36\sec45}{\company }{\manager }}
+\deftab720\viewkind1\uc1\pard\nowidctlpar\lang1036\kerning1\fs20
+{Welcome to PhpWord}\par
+\pard\nowidctlpar{\cf0\f0 Hello World!}\par
+\par
+\par
+\pard\nowidctlpar{\cf0\f0\fs32\b\i I am styled by a font style definition.}\par
+\pard\nowidctlpar{\cf0\f0 I am styled by a paragraph style definition.}\par
+\pard\nowidctlpar\qc\sa100{\cf0\f0\fs32\b\i I am styled by both font and paragraph style.}\par
+\pard\nowidctlpar{\cf1\f1\fs40\b\i\ul\strike\super I am inline styled.}\par
+\par
+{\field {\*\fldinst {HYPERLINK "http://www.google.com"}}{\fldrslt {Google}}}\par
+\par
+}

src/PhpWord/IOFactory.php

@@ -51,7 +51,7 @@ public static function createWriter(PhpWord $phpWord, $name = 'Word2007')
      */
     public static function createReader($name = 'Word2007')
     {
-        if (!in_array($name, array('ReaderInterface', 'Word2007', 'ODText'))) {
+        if (!in_array($name, array('ReaderInterface', 'Word2007', 'ODText', 'RTF'))) {
             throw new Exception("\"{$name}\" is not a valid reader.");
         }
 

src/PhpWord/Reader/AbstractReader.php

@@ -39,7 +39,7 @@ abstract class AbstractReader implements ReaderInterface
      *
      * @var bool|resource
      */
-    protected $fileHandle = true;
+    protected $fileHandle;
 
     /**
      * Read data only?

src/PhpWord/Reader/RTF.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * This file is part of PHPWord - A pure PHP library for reading and writing
+ * word processing documents.
+ *
+ * PHPWord is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
+ *
+ * @link        https://github.com/PHPOffice/PHPWord
+ * @copyright   2010-2014 PHPWord contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+namespace PhpOffice\PhpWord\Reader;
+
+use PhpOffice\PhpWord\PhpWord;
+use PhpOffice\PhpWord\Reader\RTF\Document;
+
+/**
+ * RTF Reader class
+ *
+ * @since 0.11.0
+ */
+class RTF extends AbstractReader implements ReaderInterface
+{
+    /**
+     * Loads PhpWord from file
+     *
+     * @param string $docFile
+     * @throws \Exception
+     * @return \PhpOffice\PhpWord\PhpWord
+     */
+    public function load($docFile)
+    {
+        $phpWord = new PhpWord();
+
+        if ($this->canRead($docFile)) {
+            $doc = new Document();
+            $doc->rtf = file_get_contents($docFile);
+            $doc->read($phpWord);
+        } else {
+            throw new \Exception("Cannot read {$docFile}.");
+        }
+
+        return $phpWord;
+    }
+}