Merge branch 'develop' into html_br

Author: troosan

CHANGELOG.md

@@ -3,7 +3,7 @@ Change Log
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-v0.14.0 (?? ???? 2017)
+v0.14.0 (?? Dec 2017)
 ----------------------
 This release fixes several bugs and adds some new features.
 This is the last version to support PHP 5.3
@@ -21,11 +21,13 @@ This is the last version to support PHP 5.3
 - Add support for HTML <br> in addHtml - @anrikun @troosan #659
 - Allow to change cell width unit - guillaume-ro-fr #986
 - Allow to change the line height rule @troosan
+- Implement PageBreak for odt writer @cookiekiller #863 #824
+- Allow to force an update of all fields on opening a document - @troosan #951
 
 ### Fixed
 - Loosen dependency to Zend
 - Images are not being printed when generating PDF - @hubertinio #1074 #431
-- Fixed some PHP 7 warnings - @	likeuntomurphy #927
+- Fixed some PHP 7 warnings - @likeuntomurphy #927
 - Fixed Word 97 reader - @alsofronie @Benpxpx @mario-rivera #912 #920 #892
 - Fixed image loading over https - @troosan #988
 - Impossibility to set different even and odd page headers - @troosan #981
@@ -40,6 +42,9 @@ This is the last version to support PHP 5.3
 - Fix incorrect image size between windows and mac - @bskrtich #874
 - Fix adding HTML table to document - @mogilvie @arivanbastos #324
 
+###Deprecated
+- PhpWord->getProtection(), get it from the settings instead PhpWord->getSettings()->getDocumentProtection();
+
 v0.13.0 (31 July 2016)
 -------------------
 This release brings several improvements in `TemplateProcessor`, automatic output escaping feature for OOXML, ODF, HTML, and RTF (turned off, by default).

README.md

@@ -67,10 +67,18 @@ PHPWord requires the following:
 ## Installation
 
 PHPWord is installed via [Composer](https://getcomposer.org/).
-You just need to [add dependency](https://getcomposer.org/doc/04-schema.md#package-links>) on PHPWord into your package.
+To [add a dependency](https://getcomposer.org/doc/04-schema.md#package-links>) to PHPWord in your project, either
 
-Example:
+Run the following to use the latest stable version
+```sh
+    composer require phpoffice/phpword
+```
+or if you want the latest master version
+```sh
+    composer require phpoffice/phpword:dev-master
+```
 
+You can of course also manually edit your composer.json file
 ```json
 {
     "require": {

composer.json

@@ -38,7 +38,7 @@
         "php": ">=5.3.3",
         "ext-xml": "*",
         "zendframework/zend-escaper": "^2.2",
-        "zendframework/zend-stdlib": "^2.2",
+        "zendframework/zend-stdlib": "^2.2 || ^3.0",
         "phpoffice/common": "^0.2"
     },
     "require-dev": {

docs/ISSUE_TEMPLATE.md

@@ -0,0 +1,28 @@
+Issue tracker is **ONLY** used for reporting bugs. NO NEW FEATURE ACCEPTED! Use [stackoverflow](https://stackoverflow.com/questions/tagged/phpword) for supporting issues.
+
+# Expected Behavior
+
+Please describe the behavior you are expecting.
+
+# Current Behavior
+
+What is the current behavior?
+
+# Failure Information
+
+Please help provide information about the failure.
+
+## How to Reproduce
+
+Please provide a code sample that reproduces the issue.
+
+```php
+$phpWord = new \PhpOffice\PhpWord\PhpWord();
+$section = $phpWord->addSection();
+$section->...
+```
+
+## Context
+
+* PHP version:
+* PHPWord version: 0.14

docs/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
+
+Fixes # (issue)
+
+# Checklist:
+
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have run phpunit, phpcs, php-cs-fixer, phpmd
+- [ ] The new code is covered by unit tests
+- [ ] I have update the documentation to describe the changes

docs/elements.rst

@@ -297,7 +297,7 @@ Your TOC can only be generated if you have add at least one title (See "Titles")
 
 Options for ``$tocStyle``:
 
-- ``tabLeader``. Fill type between the title text and the page number. Use the defined constants in PHPWord\\Style\\TOC.
+- ``tabLeader``. Fill type between the title text and the page number. Use the defined constants in ``\PhpOffice\PhpWord\Style\TOC``.
 - ``tabPos``. The position of the tab where the page number appears in twips.
 - ``indent``. The indent factor of the titles in twips.
 

docs/general.rst

@@ -271,3 +271,12 @@ points to twips.
     $sectionStyle->setMarginLeft(\PhpOffice\PhpWord\Shared\Converter::inchToTwip(.5));
     // 2 cm right margin
     $sectionStyle->setMarginRight(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(2));
+
+Automatically Recalculate Fields on Open
+----------------------------------------
+
+To force an update of the fields present in the document, set updateFields to true
+
+.. code-block:: php
+
+    $phpWord->getSettings()->setUpdateFields(true);

phpstan.neon

@@ -0,0 +1,13 @@
+includes:
+	- vendor/phpstan/phpstan/conf/config.level1.neon
+parameters:
+	memory-limit: 200000
+	autoload_directories:
+		- tests
+	autoload_files:
+		- tests/bootstrap.php
+	excludes_analyse:
+		- */pclzip.lib.php
+		- src/PhpWord/Shared/OLERead.php
+		- src/PhpWord/Reader/MsDoc.php
+		- src/PhpWord/Writer/PDF/MPDF.php

run_tests.sh

@@ -1,14 +1,20 @@
 #!/bin/bash
+echo "Running composer update"
+composer update
 
 ## PHP_CodeSniffer
+echo "Running CodeSniffer"
 ./vendor/bin/phpcs src/ tests/ --standard=PSR2 -n --ignore=src/PhpWord/Shared/PCLZip
 
 ## PHP-CS-Fixer
+echo "Running CS Fixer"
 ./vendor/bin/php-cs-fixer fix --diff --verbose --dry-run
 
 ## PHP Mess Detector
+echo "Running Mess Detector"
 ./vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist --exclude pclzip.lib.php
 
 ## PHPUnit
-./vendor/bin/phpunit -c ./ --no-coverage
+echo "Running PHPUnit"
+./vendor/bin/phpunit -c ./
 

samples/Sample_17_TitleTOC.php

@@ -4,6 +4,7 @@
 // New Word document
 echo date('H:i:s'), ' Create new PhpWord object', EOL;
 $phpWord = new \PhpOffice\PhpWord\PhpWord();
+$phpWord->getSettings()->setUpdateFields(true);
 
 // New section
 $section = $phpWord->addSection();