PHPWord/src/PhpWord/Writer/RTF.php

<?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\Writer;

use PhpOffice\PhpWord\Exception\Exception;
use PhpOffice\PhpWord\PhpWord;
use PhpOffice\PhpWord\Shared\Drawing;
use PhpOffice\PhpWord\Style;
use PhpOffice\PhpWord\Style\Font;
use PhpOffice\PhpWord\Writer\RTF\Element\Container;

/**
 * RTF writer
 *
 * @since 0.7.0
 */
class RTF extends AbstractWriter implements WriterInterface
{
    /**
     * Color register
     *
     * @var array
     */
    private $colorTable;

    /**
     * Font register
     *
     * @var array
     */
    private $fontTable;

    /**
     * Last paragraph style
     *
     * @var mixed
     */
    private $lastParagraphStyle;

    /**
     * Create new RTF writer
     * @param \PhpOffice\PhpWord\PhpWord $phpWord
     */
    public function __construct(PhpWord $phpWord = null)
    {
        $this->setPhpWord($phpWord);
    }

    /**
     * Save PhpWord to file
     *
     * @param string $filename
     * @throws \PhpOffice\PhpWord\Exception\Exception
     */
    public function save($filename = null)
    {
        $filename = $this->getTempFile($filename);
        $hFile = fopen($filename, 'w');
        if ($hFile !== false) {
            fwrite($hFile, $this->writeDocument());
            fclose($hFile);
        } else {
            throw new Exception("Can't open file");
        }
        $this->cleanupTempFile();
    }

    /**
     * Get color table
     */
    public function getColorTable()
    {
        return $this->colorTable;
    }

    /**
     * Get font table
     */
    public function getFontTable()
    {
        return $this->fontTable;
    }

    /**
     * Get last paragraph style
     */
    public function getLastParagraphStyle()
    {
        return $this->lastParagraphStyle;
    }

    /**
     * Set last paragraph style
     *
     * @param mixed $value
     */
    public function setLastParagraphStyle($value = '')
    {
        $this->lastParagraphStyle = $value;
    }

    /**
     * Get all data
     *
     * @return string
     */
    private function writeDocument()
    {
        $this->fontTable = $this->populateFontTable();
        $this->colorTable = $this->populateColorTable();

        // Set the default character set
        $content = '{\rtf1';
        $content .= '\ansi\ansicpg1252'; // Set the default font (the first one)
        $content .= '\deff0'; // Set the default tab size (720 twips)
        $content .= '\deftab720';
        $content .= PHP_EOL;

        // Set the font tbl group
        $content .= '{\fonttbl';
        foreach ($this->fontTable as $idx => $font) {
            $content .= '{\f' . $idx . '\fnil\fcharset0 ' . $font . ';}';
        }
        $content .= '}' . PHP_EOL;

        // Set the color tbl group
        $content .= '{\colortbl ';
        foreach ($this->colorTable as $color) {
            $arrColor = Drawing::htmlToRGB($color);
            $content .= ';\red' . $arrColor[0] . '\green' . $arrColor[1] . '\blue' . $arrColor[2] . '';
        }
        $content .= ';}' . PHP_EOL;

        $content .= '{\*\generator PhpWord;}' . PHP_EOL; // Set the generator
        $content .= '\viewkind4'; // Set the view mode of the document
        $content .= '\uc1'; // Set the numberof bytes that follows a unicode character
        $content .= '\pard'; // Resets to default paragraph properties.
        $content .= '\nowidctlpar'; // No widow/orphan control
        $content .= '\lang1036'; // Applies a language to a text run (1036 : French (France))
        $content .= '\kerning1'; // Point size (in half-points) above which to kern character pairs
        $content .= '\fs' . (PhpWord::DEFAULT_FONT_SIZE * 2); // Set the font size in half-points
        $content .= PHP_EOL;

        // Body
        $content .= $this->writeContent();

        $content .= '}';

        return $content;
    }

    /**
     * Get content data
     *
     * @return string
     */
    private function writeContent()
    {
        $content = '';

        $sections = $this->getPhpWord()->getSections();
        foreach ($sections as $section) {
            $writer = new Container($this, $section);
            $content .= $writer->write();
        }

        return $content;
    }

    /**
     * Get all fonts
     *
     * @return array
     */
    private function populateFontTable()
    {
        $phpWord = $this->getPhpWord();
        $fontTable = array();
        $fontTable[] = PhpWord::DEFAULT_FONT_NAME;

        // Browse styles
        $styles = Style::getStyles();
        if (count($styles) > 0) {
            foreach ($styles as $style) {
                // Font
                if ($style instanceof Font) {
                    if (in_array($style->getName(), $fontTable) == false) {
                        $fontTable[] = $style->getName();
                    }
                }
            }
        }

        // Search all fonts used
        $sections = $phpWord->getSections();
        $countSections = count($sections);
        if ($countSections > 0) {
            foreach ($sections as $section) {
                $elements = $section->getElements();
                foreach ($elements as $element) {
                    if (method_exists($element, 'getFontStyle')) {
                        $fontStyle = $element->getFontStyle();
                        if ($fontStyle instanceof Font) {
                            if (in_array($fontStyle->getName(), $fontTable) == false) {
                                $fontTable[] = $fontStyle->getName();
                            }
                        }
                    }
                }
            }
        }

        return $fontTable;
    }

    /**
     * Get all colors
     *
     * @return array
     */
    private function populateColorTable()
    {
        $phpWord = $this->getPhpWord();
        $defaultFontColor = PhpWord::DEFAULT_FONT_COLOR;
        $colorTable = array();

        // Browse styles
        $styles = Style::getStyles();
        if (count($styles) > 0) {
            foreach ($styles as $style) {
                // Font
                if ($style instanceof Font) {
                    $color = $style->getColor();
                    $fgcolor = $style->getFgColor();
                    if (!in_array($color, $colorTable) && $color != $defaultFontColor && !empty($color)) {
                        $colorTable[] = $color;
                    }
                    if (!in_array($fgcolor, $colorTable) && $fgcolor != $defaultFontColor && !empty($fgcolor)) {
                        $colorTable[] = $fgcolor;
                    }
                }
            }
        }

        // Search all fonts used
        $sections = $phpWord->getSections();
        $countSections = count($sections);
        if ($countSections > 0) {
            foreach ($sections as $section) {
                $elements = $section->getElements();
                foreach ($elements as $element) {
                    if (method_exists($element, 'getFontStyle')) {
                        $fontStyle = $element->getFontStyle();
                        if ($fontStyle instanceof Font) {
                            if (in_array($fontStyle->getColor(), $colorTable) == false) {
                                $colorTable[] = $fontStyle->getColor();
                            }
                            if (in_array($fontStyle->getFgColor(), $colorTable) == false) {
                                $colorTable[] = $fontStyle->getFgColor();
                            }
                        }
                    }
                }
            }
        }

        return $colorTable;
    }
}