Merge branch 'develop' into develop

Author: troosan

.scrutinizer.yml

@@ -1,3 +1,8 @@
+build:
+    nodes:
+        analysis:
+            tests:
+                override: [php-scrutinizer-run]
 filter:
     excluded_paths: [ 'vendor/*', 'tests/*', 'samples/*', 'src/PhpWord/Shared/PCLZip/*' ]
 

.travis.yml

@@ -15,12 +15,9 @@ matrix:
     include:
         - php: 5.6
           env: COVERAGE=1
-    allow_failures:
-        - php: 7.2
 
 cache:
     directories:
-        - vendor
         - $HOME/.composer/cache
         - .php-cs.cache
 
@@ -38,7 +35,7 @@ before_script:
     - if [ -z "$COVERAGE" ]; then phpenv config-rm xdebug.ini ; fi
     ## Composer
     - composer self-update
-    - composer install --prefer-source
+    - travis_wait composer install --prefer-source
     ## PHPDocumentor
     - mkdir -p build/docs
     - mkdir -p build/coverage

CHANGELOG.md

@@ -13,6 +13,12 @@ v0.15.0 (?? ??? 2018)
 - Add support for fixed Table Layout @aoloe @ekopach @troosan #841 #1276
 - Add support for Cell Spacing @dox07 @troosan #1040
 - Add parsing of formatting inside lists @atomicalnet @troosan #594
+- Added support for Vertically Raised or Lowered Text (w:position) @anrikun @troosan #640
+- Add support for MACROBUTTON field @phryneas @troosan #1021
+- Add support for Hyphenation @Trainmaster #1282 (Document: `autoHyphenation`, `consecutiveHyphenLimit`, `hyphenationZone`, `doNotHyphenateCaps`, Paragraph: `suppressAutoHyphens`)
+- Added support for Floating Table Positioning (tblpPr) @anrikun #639
+- Added support for Image text wrapping distance @troosan #1310
+- Added parsing of CSS line-height and text-indent in HTML reader @troosan #1316
 
 ### Fixed
 - Fix reading of docx default style - @troosan #1238
@@ -23,6 +29,8 @@ v0.15.0 (?? ??? 2018)
 - Bookmark are not writton as internal link in html writer @troosan #1263
 - It should be possible to add a Footnote in a ListItemRun @troosan #1287 #1287
 - Fix colspan and rowspan for tables in HTML Writer @mattbolt #1292
+- Fix parsing of Heading and Title formating @troosan @gthomas2 #465
+- Fix Dateformat typo, fix hours casing, add Month-Day-Year formats @ComputerTinker #591
 
 ### Changed
 - Remove zend-stdlib dependency @Trainmaster #1284
@@ -475,4 +483,4 @@ This is the first release after a long development hiatus in [CodePlex](https://
 - Basic CI with Travis - @Progi1984
 - Added PHPWord_Exception and exception when could not copy the template - @Progi1984
 - IMPROVED: Moved examples out of Classes directory - @Progi1984
-- IMPROVED: Advanced string replace in setValue for Template - @Esmeraldo [#49](http://phpword.codeplex.com/workitem/49)
+- IMPROVED: Advanced string replace in setValue for Template - @Esmeraldo [#49](http://phpword.codeplex.com/workitem/49)

bootstrap.php

@@ -11,7 +11,7 @@
  * contributors, visit https://github.com/PHPOffice/PHPWord/contributors. test bootstrap
  *
  * @see         https://github.com/PHPOffice/PHPWord
- * @copyright   2010-2017 PHPWord contributors
+ * @copyright   2010-2018 PHPWord contributors
  * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
  */
 

composer.json

@@ -36,19 +36,19 @@
     ],
     "scripts": {
         "test": [
-            "./vendor/bin/phpunit --color=always"
+            "phpunit --color=always"
         ],
         "test-no-coverage": [
-            "./vendor/bin/phpunit --color=always --no-coverage"
+            "phpunit --color=always --no-coverage"
         ],
         "check": [
-            "./vendor/bin/php-cs-fixer fix --ansi --dry-run --diff",
-            "./vendor/bin/phpcs --report-width=200 --report-summary  --report-full samples/ src/ tests/ --ignore=src/PhpWord/Shared/PCLZip --standard=PSR2 -n",
-            "./vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist --exclude pclzip.lib.php",
+            "php-cs-fixer fix --ansi --dry-run --diff",
+            "phpcs --report-width=200 --report-summary  --report-full samples/ src/ tests/ --ignore=src/PhpWord/Shared/PCLZip --standard=PSR2 -n",
+            "phpmd src/,tests/ text ./phpmd.xml.dist --exclude pclzip.lib.php",
             "@test"
         ],
         "fix": [
-            "./vendor/bin/php-cs-fixer fix --ansi"
+            "php-cs-fixer fix --ansi"
         ]
     },
     "scripts-descriptions": {

docs/elements.rst

@@ -89,6 +89,7 @@ Titles
 
 If you want to structure your document or build table of contents, you need titles or headings.
 To add a title to the document, use the ``addTitleStyle`` and ``addTitle`` method.
+If `depth` is 0, a Title will be inserted, otherwise a Heading1, Heading2, ...
 
 .. code-block:: php
 
@@ -98,7 +99,7 @@ To add a title to the document, use the ``addTitleStyle`` and ``addTitle`` metho
 - ``depth``.
 - ``$fontStyle``. See :ref:`font-style`.
 - ``$paragraphStyle``. See :ref:`paragraph-style`.
-- ``$text``. Text to be displayed in the document.
+- ``$text``. Text to be displayed in the document. This can be `string` or a `\PhpOffice\PhpWord\Element\TextRun`
 
 It's necessary to add a title style to your document because otherwise the title won't be detected as a real title.
 
@@ -481,6 +482,7 @@ Track changes can be set on text elements. There are 2 ways to set the change in
 Either by calling the `setChangeInfo()`, or by setting the `TrackChange` instance on the element with `setTrackChange()`.
 
 .. code-block:: php
+
     $phpWord = new \PhpOffice\PhpWord\PhpWord();
 
     // New portrait section

docs/general.rst

@@ -217,10 +217,10 @@ The default language of the document can be change with the following.
 
     $phpWord->getSettings()->setThemeFontLang(new Language(Language::FR_BE));
 
-``Languge`` has 3 parameters, one for Latin languages, one for East Asian languages and one for Complex (Bi-Directional) languages.
+``Language`` has 3 parameters, one for Latin languages, one for East Asian languages and one for Complex (Bi-Directional) languages.
 A couple of language codes are provided in the ``PhpOffice\PhpWord\ComplexType\Language`` class but any valid code/ID can be used.
 
-In case you are generating an RTF document the Language need to be set differently.
+In case you are generating an RTF document the language need to be set differently.
 
 .. code-block:: php
 
@@ -290,3 +290,45 @@ To force an update of the fields present in the document, set updateFields to tr
 .. code-block:: php
 
     $phpWord->getSettings()->setUpdateFields(true);
+
+Hyphenation
+-----------
+Hyphenation describes the process of breaking words with hyphens. There are several options to control hyphenation.
+
+Auto hyphenation
+~~~~~~~~~~~~~~~~
+
+To automatically hyphenate text set ``autoHyphenation`` to ``true``.
+
+.. code-block:: php
+
+    $phpWord->getSettings()->setAutoHyphenation(true);
+
+Consecutive Hyphen Limit
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The maximum number of consecutive lines of text ending with a hyphen can be controlled by the ``consecutiveHyphenLimit`` option.
+There is no limit if the option is not set or the provided value is ``0``.
+
+.. code-block:: php
+
+    $phpWord->getSettings()->setConsecutiveHyphenLimit(2);
+
+Hyphenation Zone
+~~~~~~~~~~~~~~~~
+
+The hyphenation zone (in *twip*) is the allowed amount of whitespace before hyphenation is applied.
+The smaller the hyphenation zone the more words are hyphenated. Or in other words, the wider the hyphenation zone the less words are hyphenated.
+
+.. code-block:: php
+
+    $phpWord->getSettings()->setHyphenationZone(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(1));
+
+Hyphenate Caps
+~~~~~~~~~~~~~~
+
+To control whether or not words in all capital letters shall be hyphenated use the `doNotHyphenateCaps` option.
+
+.. code-block:: php
+
+    $phpWord->getSettings()->setDoNotHyphenateCaps(true);

docs/styles.rst

@@ -59,6 +59,7 @@ Available Font style options:
    See ``\PhpOffice\PhpWord\Style\Font::UNDERLINE_...`` constants for more values
 - ``lang``. Language, either a language code like *en-US*, *fr-BE*, etc. or an object (or as an array) if you need to set eastAsian or bidirectional languages
    See ``\PhpOffice\PhpWord\Style\Language`` class for some language codes.
+- ``position``. The text position, raised or lowered, in half points
 
 .. _paragraph-style:
 
@@ -81,6 +82,7 @@ Available Paragraph style options:
 - ``spaceAfter``. Space after paragraph in *twip*.
 - ``spacing``. Space between lines.
 - ``spacingLineRule``. Line Spacing Rule. *auto*, *exact*, *atLeast*
+- ``suppressAutoHyphens``. Hyphenation for paragraph, *true* or *false*.
 - ``tabs``. Set of custom tab stops.
 - ``widowControl``. Allow first/last line to display on a separate page, *true* or *false*.
 - ``contextualSpacing``. Ignore Spacing Above and Below When Using Identical Styles, *true* or *false*.
@@ -106,6 +108,20 @@ Available Table style options:
 - ``unit``. The unit to use for the width. One of ``\PhpOffice\PhpWord\SimpleType\TblWidth``. Defaults to *auto*.
 - ``layout``. Table layout, either *fixed* or *autofit*  See ``\PhpOffice\PhpWord\Style\Table`` for constants.
 - ``cellSpacing`` Cell spacing in *twip*
+- ``position`` Floating Table Positioning, see below for options
+
+Floating Table Positioning options:
+
+- ``leftFromText`` Distance From Left of Table to Text in *twip*
+- ``rightFromText`` Distance From Right of Table to Text in *twip*
+- ``topFromText`` Distance From Top of Table to Text in *twip*
+- ``bottomFromText`` Distance From Top of Table to Text in *twip*
+- ``vertAnchor`` Table Vertical Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::VANCHOR_*``
+- ``horzAnchor`` Table Horizontal Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::HANCHOR_*``
+- ``tblpXSpec`` Relative Horizontal Alignment From Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::XALIGN_*``
+- ``tblpX`` Absolute Horizontal Distance From Anchorin *twip*
+- ``tblpYSpec`` Relative Vertical Alignment From Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::YALIGN_*``
+- ``tblpY`` Absolute Vertical Distance From Anchorin *twip*
 
 Available Row style options:
 
@@ -138,6 +154,10 @@ Available Image style options:
 - ``marginTop``. Top margin in inches, can be negative.
 - ``width``. Width in pixels.
 - ``wrappingStyle``. Wrapping style, *inline*, *square*, *tight*, *behind*, or *infront*.
+- ``wrapDistanceTop``. Top text wrapping in pixels.
+- ``wrapDistanceBottom``. Bottom text wrapping in pixels.
+- ``wrapDistanceLeft``. Left text wrapping in pixels.
+- ``wrapDistanceRight``. Right text wrapping in pixels.
 
 .. _numbering-level-style:
 

samples/Sample_09_Tables.php

@@ -1,4 +1,7 @@
 <?php
+use PhpOffice\PhpWord\Shared\Converter;
+use PhpOffice\PhpWord\Style\TablePosition;
+
 include_once 'Sample_Header.php';
 
 // New Word Document
@@ -139,6 +142,15 @@
 $innerCell = $cell->addTable(array('alignment' => \PhpOffice\PhpWord\SimpleType\JcTable::CENTER))->addRow()->addCell();
 $innerCell->addText('Inside nested table');
 
+// 6. Table with floating position
+
+$section->addTextBreak(2);
+$section->addText('Table with floating positioning.', $header);
+
+$table = $section->addTable(array('borderSize' => 6, 'borderColor' => '999999', 'position' => array('vertAnchor' => TablePosition::VANCHOR_TEXT, 'bottomFromText' => Converter::cmToTwip(1))));
+$cell = $table->addRow()->addCell();
+$cell->addText('This is a single cell.');
+
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);
 if (!CLI) {

samples/Sample_13_Images.php

@@ -1,4 +1,7 @@
 <?php
+use PhpOffice\PhpWord\Element\Section;
+use PhpOffice\PhpWord\Shared\Converter;
+
 include_once 'Sample_Header.php';
 
 // New Word document
@@ -9,45 +12,48 @@
 $section = $phpWord->addSection();
 $section->addText('Local image without any styles:');
 $section->addImage('resources/_mars.jpg');
-$section->addTextBreak(2);
 
+printSeparator($section);
 $section->addText('Local image with styles:');
 $section->addImage('resources/_earth.jpg', array('width' => 210, 'height' => 210, 'alignment' => \PhpOffice\PhpWord\SimpleType\Jc::CENTER));
-$section->addTextBreak(2);
 
 // Remote image
+printSeparator($section);
 $source = 'http://php.net/images/logos/php-med-trans-light.gif';
 $section->addText("Remote image from: {$source}");
 $section->addImage($source);
 
 // Image from string
+printSeparator($section);
 $source = 'resources/_mars.jpg';
 $fileContent = file_get_contents($source);
 $section->addText('Image from string');
 $section->addImage($fileContent);
 
 //Wrapping style
-$text = str_repeat('Hello World! ', 15);
+printSeparator($section);
+$text = str_repeat('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. ', 2);
 $wrappingStyles = array('inline', 'behind', 'infront', 'square', 'tight');
 foreach ($wrappingStyles as $wrappingStyle) {
-    $section->addTextBreak(5);
     $section->addText("Wrapping style {$wrappingStyle}");
     $section->addImage(
         'resources/_earth.jpg',
         array(
-            'positioning'   => 'relative',
-            'marginTop'     => -1,
-            'marginLeft'    => 1,
-            'width'         => 80,
-            'height'        => 80,
-            'wrappingStyle' => $wrappingStyle,
+            'positioning'        => 'relative',
+            'marginTop'          => -1,
+            'marginLeft'         => 1,
+            'width'              => 80,
+            'height'             => 80,
+            'wrappingStyle'      => $wrappingStyle,
+            'wrapDistanceRight'  => Converter::cmToPoint(1),
+            'wrapDistanceBottom' => Converter::cmToPoint(1),
         )
     );
     $section->addText($text);
+    printSeparator($section);
 }
 
 //Absolute positioning
-$section->addTextBreak(3);
 $section->addText('Absolute positioning: see top right corner of page');
 $section->addImage(
     'resources/_mars.jpg',
@@ -64,7 +70,7 @@
 );
 
 //Relative positioning
-$section->addTextBreak(3);
+printSeparator($section);
 $section->addText('Relative positioning: Horizontal position center relative to column,');
 $section->addText('Vertical position top relative to line');
 $section->addImage(
@@ -80,6 +86,14 @@
     )
 );
 
+function printSeparator(Section $section)
+{
+    $section->addTextBreak();
+    $lineStyle = array('weight' => 0.2, 'width' => 150, 'height' => 0, 'align' => 'center');
+    $section->addLine($lineStyle);
+    $section->addTextBreak(2);
+}
+
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);
 if (!CLI) {

samples/Sample_17_TitleTOC.php

@@ -12,13 +12,14 @@
 // Define styles
 $fontStyle12 = array('spaceAfter' => 60, 'size' => 12);
 $fontStyle10 = array('size' => 10);
+$phpWord->addTitleStyle(null, array('size' => 22, 'bold' => true));
 $phpWord->addTitleStyle(1, array('size' => 20, 'color' => '333333', 'bold' => true));
 $phpWord->addTitleStyle(2, array('size' => 16, 'color' => '666666'));
 $phpWord->addTitleStyle(3, array('size' => 14, 'italic' => true));
 $phpWord->addTitleStyle(4, array('size' => 12));
 
 // Add text elements
-$section->addText('Table of contents 1');
+$section->addTitle('Table of contents 1', 0);
 $section->addTextBreak(2);
 
 // Add TOC #1

samples/Sample_26_Html.php

@@ -4,6 +4,7 @@
 // New Word Document
 echo date('H:i:s') , ' Create new PhpWord object' , EOL;
 $phpWord = new \PhpOffice\PhpWord\PhpWord();
+$phpWord->addParagraphStyle('Heading2', array('alignment' => 'center'));
 
 $section = $phpWord->addSection();
 $html = '<h1>Adding element via HTML</h1>';
@@ -17,6 +18,11 @@
 $html .= '<p style="margin-top: 240pt;">Unordered (bulleted) list:</p>';
 $html .= '<ul><li>Item 1</li><li>Item 2</li><ul><li>Item 2.1</li><li>Item 2.1</li></ul></ul>';
 
+$html .= '<p style="margin-top: 240pt;">1.5 line height with first line text indent:</p>';
+$html .= '<p style="text-align: justify; text-indent: 70.9pt; line-height: 150%;">Lorem ipsum dolor sit amet, <strong>consectetur adipiscing elit</strong>, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>';
+
+$html .= '<h2 style="align: center">centered title</h2>';
+
 $html .= '<p style="margin-top: 240pt;">Ordered (numbered) list:</p>';
 $html .= '<ol>
                 <li><p style="font-weight: bold;">List 1 item 1</p></li>