Merge branch 'develop' into PHPOffice#140-bskrtich-pclzip

Author: ivanlanin

CHANGELOG.md

@@ -7,15 +7,22 @@ This is the changelog between releases of PHPWord. Releases are listed in revers
 ### Features
 
 - Image: Get image dimensions without EXIF extension - @andrew-kzoo GH-184
-- Table: Add tblGrid element for Libre/Open Office table sizing - @gianis6 GH-183
+- Table: Add `tblGrid` element for Libre/Open Office table sizing - @gianis6 GH-183
+- Footnote: Ability to insert textbreak in footnote `$footnote->addTextBreak()` - @ivanlanin
+- Footnote: Ability to style footnote reference mark by using `FootnoteReference` style - @ivanlanin
+- Font: Add `bgColor` to font style to define background using HEX color - @jcarignan GH-168
+- Table: Add `exactHeight` to row style to define whether row height should be exact or atLeast - @jcarignan GH-168
+- Element: New `CheckBox` element for sections and table cells - @ozilion GH-156
 
 ### Bugfixes
 
--
+- Footnote: Footnote content doesn't show footnote reference number - @ivanlanin GH-170
 
 ### 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
 

composer.json

@@ -25,6 +25,10 @@
         {
             "name": "Ivan Lanin",
             "homepage": "http://ivan.lanin.org"
+        },
+        {
+            "name": "Roman Syroeshko",
+            "homepage": "http://ru.linkedin.com/pub/roman-syroeshko/34/a53/994/"
         }
     ],
     "require": {

docs/elements.rst

@@ -67,6 +67,7 @@ Available font styles:
 -  ``strikethrough`` Strikethrough, *true* or *false*
 -  ``color`` Font color, e.g. *FF0000*
 -  ``fgColor`` Font highlight color, e.g. *yellow*, *green*, *blue*
+-  ``bgColor`` Font background color, e.g. *FF0000*
 
 Paragraph style
 ^^^^^^^^^^^^^^^
@@ -201,27 +202,28 @@ Table, row, and cell styles
 
 Table styles:
 
--  ``$width`` Table width in percent
--  ``$bgColor`` Background color, e.g. '9966CC'
--  ``$border(Top|Right|Bottom|Left)Size`` Border size in twips
--  ``$border(Top|Right|Bottom|Left)Color`` Border color, e.g. '9966CC'
--  ``$cellMargin(Top|Right|Bottom|Left)`` Cell margin in twips
+-  ``width`` Table width in percent
+-  ``bgColor`` Background color, e.g. '9966CC'
+-  ``border(Top|Right|Bottom|Left)Size`` Border size in twips
+-  ``border(Top|Right|Bottom|Left)Color`` Border color, e.g. '9966CC'
+-  ``cellMargin(Top|Right|Bottom|Left)`` Cell margin in twips
 
 Row styles:
 
 -  ``tblHeader`` Repeat table row on every new page, *true* or *false*
 -  ``cantSplit`` Table row cannot break across pages, *true* or *false*
+-  ``exactHeight`` Row height is exact or at least
 
 Cell styles:
 
--  ``$width`` Cell width in twips
--  ``$valign`` Vertical alignment, *top*, *center*, *both*, *bottom*
--  ``$textDirection`` Direction of text
--  ``$bgColor`` Background color, e.g. '9966CC'
--  ``$border(Top|Right|Bottom|Left)Size`` Border size in twips
--  ``$border(Top|Right|Bottom|Left)Color`` Border color, e.g. '9966CC'
--  ``$gridSpan`` Number of columns spanned
--  ``$vMerge`` *restart* or *continue*
+-  ``width`` Cell width in twips
+-  ``valign`` Vertical alignment, *top*, *center*, *both*, *bottom*
+-  ``textDirection`` Direction of text
+-  ``bgColor`` Background color, e.g. '9966CC'
+-  ``border(Top|Right|Bottom|Left)Size`` Border size in twips
+-  ``border(Top|Right|Bottom|Left)Color`` Border color, e.g. '9966CC'
+-  ``gridSpan`` Number of columns spanned
+-  ``vMerge`` *restart* or *continue*
 
 Cell span
 ~~~~~~~~~
@@ -326,7 +328,8 @@ Footnotes
 ---------
 
 You can create footnotes in texts or textruns, but it's recommended to
-use textrun to have better layout.
+use textrun to have better layout. You can use ``addText``, ``addLink``,
+and ``addTextBreak`` on a footnote.
 
 On textrun:
 
@@ -335,7 +338,11 @@ On textrun:
     $textrun = $section->createTextRun();
     $textrun->addText('Lead text.');
     $footnote = $textrun->createFootnote();
-    $footnote->addText('Footnote text.');
+    $footnote->addText('Footnote text can have ');
+    $footnote->addLink('http://test.com', 'links');
+    $footnote->addText('.');
+    $footnote->addTextBreak();
+    $footnote->addText('And text break.');
     $textrun->addText('Trailing text.');
 
 On text:
@@ -345,3 +352,23 @@ On text:
     $section->addText('Lead text.');
     $footnote = $section->createFootnote();
     $footnote->addText('Footnote text.');
+
+The footnote reference number will be displayed with decimal number starting
+from 1. This number use ``FooterReference`` style which you can redefine by
+``addFontStyle`` method. Default value for this style is
+``array('superScript' => true)``;
+
+Checkboxes
+----------
+
+Checkbox elements can be added to sections or table cells by using
+``addCheckBox``.
+
+.. code-block:: php
+
+    $section->addCheckBox($name, $text, [$fontStyle], [$paragraphStyle])
+
+-  ``$name`` Name of the check box.
+-  ``$text`` Text following the check box
+-  ``$fontStyle`` See "Font style" section.
+-  ``$paragraphStyle`` See "Paragraph style" section.

samples/Sample_06_Footnote.php

@@ -24,7 +24,8 @@
 $footnote->addText(' All elements are placed inside a paragraph.', 'ColoredText');
 $footnote->addText(' The best search engine: ');
 $footnote->addLink('http://www.google.com', null, 'NLink');
-$footnote->addText('. Also not bad: ');
+$footnote->addText('. Also not bad:');
+$footnote->addTextBreak();
 $footnote->addLink('http://www.bing.com', null, 'NLink');
 
 $textrun->addText('The trailing text in the paragraph.');

samples/Sample_13_Images.php

@@ -17,7 +17,7 @@
 
 $source = 'http://php.net/images/logos/php-med-trans-light.gif';
 $section->addText("Remote image from: {$source}");
-$section->addMemoryImage($source);
+$section->addImage($source);
 // End code
 
 // Save file

samples/Sample_20_BGColor.php

@@ -0,0 +1,23 @@
+<?php
+include_once 'Sample_Header.php';
+
+// New Word document
+echo date('H:i:s'), " Create new PhpWord object", \EOL;
+$phpWord = new \PhpOffice\PhpWord\PhpWord();
+$section = $phpWord->createSection();
+
+$section->addText("This is some text highlighted using fgColor (limited to 15 colors)     ", array("fgColor" => \PhpOffice\PhpWord\Style\Font::FGCOLOR_YELLOW));
+$section->addText("This one uses bgColor and is using hex value (0xfbbb10)", array("bgColor" => "fbbb10"));
+$section->addText("Compatible with font colors", array("color"=>"0000ff", "bgColor" => "fbbb10"));
+
+// Save file
+$name = basename(__FILE__, '.php');
+$writers = array('Word2007' => 'docx', 'ODText' => 'odt', 'RTF' => 'rtf');
+foreach ($writers as $writer => $extension) {
+    echo date('H:i:s'), " Write to {$writer} format", \EOL;
+    $xmlWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, $writer);
+    $xmlWriter->save("{$name}.{$extension}");
+    rename("{$name}.{$extension}", "results/{$name}.{$extension}");
+}
+
+include_once 'Sample_Footer.php';

samples/Sample_21_TableRowRules.php

@@ -0,0 +1,40 @@
+<?php
+include_once 'Sample_Header.php';
+
+// New Word document
+echo date('H:i:s'), " Create new PhpWord object", \EOL;
+$phpWord = new \PhpOffice\PhpWord\PhpWord();
+$section = $phpWord->createSection();
+
+$section->addText("By default, when you insert an image, it adds a textbreak after its content.");
+$section->addText("If we want a simple border around an image, we wrap the image inside a table->row->cell");
+$section->addText("On the image with the red border, even if we set the row height to the height of the image, the textbreak is still there:");
+
+$table1 = $section->addTable(array("cellMargin" => 0, "cellMarginRight" => 0, "cellMarginBottom" => 0, "cellMarginLeft" => 0));
+$table1->addRow(3750);
+$cell1 = $table1->addCell(null, array("valign" => "top", "borderSize" => 30, "borderColor" => "ff0000"));
+$cell1->addImage("./resources/_earth.jpg", array("width" => 250, "height" => 250, "align" => "center"));
+
+$section->addTextBreak();
+$section->addText("But if we set the rowStyle 'exactHeight' to true, the real row height is used, removing the textbreak:");
+
+$table2 = $section->addTable(array("cellMargin" => 0, "cellMarginRight" => 0, "cellMarginBottom" => 0, "cellMarginLeft" => 0));
+$table2->addRow(3750, array("exactHeight" => true));
+$cell2 = $table2->addCell(null, array("valign"  => "top", "borderSize" => 30, "borderColor" => "00ff00"));
+$cell2->addImage("./resources/_earth.jpg", array("width" => 250, "height" => 250, "align" => "center"));
+
+$section->addTextBreak();
+$section->addText("In this example, image is 250px height. Rows are calculated in twips, and 1px = 15twips.");
+$section->addText("So: $"."table2->addRow(3750, array('exactHeight'=>true));");
+
+// Save file
+$name = basename(__FILE__, '.php');
+$writers = array('Word2007' => 'docx', 'ODText' => 'odt', 'RTF' => 'rtf');
+foreach ($writers as $writer => $extension) {
+    echo date('H:i:s'), " Write to {$writer} format", \EOL;
+    $xmlWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, $writer);
+    $xmlWriter->save("{$name}.{$extension}");
+    rename("{$name}.{$extension}", "results/{$name}.{$extension}");
+}
+
+include_once 'Sample_Footer.php';

samples/Sample_22_CheckBox.php

@@ -0,0 +1,27 @@
+<?php
+include_once 'Sample_Header.php';
+
+// New Word document
+echo date('H:i:s'), " Create new PhpWord object", \EOL;
+$phpWord = new \PhpOffice\PhpWord\PhpWord();
+
+$section = $phpWord->createSection();
+$section->addText('Check box in section');
+$section->addCheckBox('chkBox1', 'Checkbox 1');
+$section->addText('Check box in table cell');
+$table = $section->addTable();
+$table->addRow();
+$cell = $table->addCell();
+$cell->addCheckBox('chkBox2', 'Checkbox 2');
+
+// Save file
+$name = basename(__FILE__, '.php');
+$writers = array('Word2007' => 'docx', 'ODText' => 'odt', 'RTF' => 'rtf');
+foreach ($writers as $writer => $extension) {
+    echo date('H:i:s'), " Write to {$writer} format", \EOL;
+    $xmlWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, $writer);
+    $xmlWriter->save("{$name}.{$extension}");
+    rename("{$name}.{$extension}", "results/{$name}.{$extension}");
+}
+
+include_once 'Sample_Footer.php';

samples/Sample_Footer.php

@@ -3,20 +3,20 @@
  * Footer file
  */
 // Do not show execution time for index
-if (!$isIndexFile) {
+if (!IS_INDEX) {
     echo date('H:i:s'), " Done writing file(s)", EOL;
     echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
 }
 // Show message when executed with CLI, show links when using browsers
 if (CLI) {
     echo 'The results are stored in the "results" subdirectory.', EOL;
 } else {
-    if (!$isIndexFile) {
+    if (!IS_INDEX) {
         $types = array('docx', 'odt', 'rtf');
         echo '<p>&nbsp;</p>';
         echo '<p>Results: ';
         foreach ($types as $type) {
-            $result = "results/{$sampleFile}.{$type}";
+            $result = 'results/' . SCRIPT_FILENAME . '.' . $type;
             if (file_exists($result)) {
                 echo "<a href='{$result}' class='btn btn-primary'>{$type}</a> ";
             }

samples/Sample_Header.php

@@ -5,6 +5,8 @@
 error_reporting(E_ALL);
 define('CLI', (PHP_SAPI == 'cli') ? true : false);
 define('EOL', CLI ? PHP_EOL : '<br />');
+define('SCRIPT_FILENAME', basename($_SERVER['SCRIPT_FILENAME'], '.php'));
+define('IS_INDEX', SCRIPT_FILENAME == 'index');
 
 require_once '../src/PhpWord/Autoloader.php';
 PhpOffice\PhpWord\Autoloader::register();
@@ -15,12 +17,10 @@
 }
 
 // Set titles and names
-$sampleFile = basename($_SERVER['SCRIPT_FILENAME'], '.php');
-$isIndexFile = ($sampleFile == 'index');
-$pageHeading = str_replace('_', ' ', $sampleFile);
-$pageTitle = $isIndexFile ? 'Welcome to ' : "{$pageHeading} - ";
+$pageHeading = str_replace('_', ' ', SCRIPT_FILENAME);
+$pageTitle = IS_INDEX ? 'Welcome to ' : "{$pageHeading} - ";
 $pageTitle .= 'PHPWord';
-$pageHeading = $isIndexFile ? '' : "<h1>{$pageHeading}</h1>";
+$pageHeading = IS_INDEX ? '' : "<h1>{$pageHeading}</h1>";
 // Populate samples
 $files = '';
 if ($handle = opendir('.')) {