Merge branch 'develop' of https://github.com/PHPOffice/PHPWord into develop_upstream

troosan · troosan · commit e02c5f74e6f6 · 2018-05-27T20:39:36.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,7 @@ v0.15.0 (?? ??? 2018)
 - Added the ability to enable gridlines and axislabels on charts @FrankMeyer #576
 - Add support for table indent (tblInd) @Trainmaster #1343
 - Added parsing of internal links in HTML reader @lalop #1336
+- Several improvements to charts @JAEK-S #1332
 
 ### Fixed
 - Fix reading of docx default style - @troosan #1238
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Latest Stable Version](https://poser.pugx.org/phpoffice/phpword/v/stable.png)](https://packagist.org/packages/phpoffice/phpword)
 [![Build Status](https://travis-ci.org/PHPOffice/PHPWord.svg?branch=master)](https://travis-ci.org/PHPOffice/PHPWord)
 [![Code Quality](https://scrutinizer-ci.com/g/PHPOffice/PHPWord/badges/quality-score.png?s=b5997ce59ac2816b4514f3a38de9900f6d492c1d)](https://scrutinizer-ci.com/g/PHPOffice/PHPWord/)
-[![Code Coverage](https://scrutinizer-ci.com/g/PHPOffice/PHPWord/badges/coverage.png?s=742a98745725c562955440edc8d2c39d7ff5ae25)](https://scrutinizer-ci.com/g/PHPOffice/PHPWord/)
+[![Coverage Status](https://coveralls.io/repos/github/PHPOffice/PHPWord/badge.svg?branch=develop)](https://coveralls.io/github/PHPOffice/PHPWord?branch=develop)
 [![Total Downloads](https://poser.pugx.org/phpoffice/phpword/downloads.png)](https://packagist.org/packages/phpoffice/phpword)
 [![License](https://poser.pugx.org/phpoffice/phpword/license.png)](https://packagist.org/packages/phpoffice/phpword)
 [![Join the chat at https://gitter.im/PHPOffice/PHPWord](https://img.shields.io/badge/GITTER-join%20chat-green.svg)](https://gitter.im/PHPOffice/PHPWord)
diff --git a/samples/Sample_07_TemplateCloneRow.php b/samples/Sample_07_TemplateCloneRow.php
@@ -56,7 +56,7 @@
 echo date('H:i:s'), ' Saving the result document...', EOL;
 $templateProcessor->saveAs('results/Sample_07_TemplateCloneRow.docx');
 
-echo getEndingNotes(array('Word2007' => 'docx'));
+echo getEndingNotes(array('Word2007' => 'docx'), 'results/Sample_07_TemplateCloneRow.docx');
 if (!CLI) {
     include_once 'Sample_Footer.php';
 }
diff --git a/samples/Sample_23_TemplateBlock.php b/samples/Sample_23_TemplateBlock.php
@@ -14,7 +14,7 @@
 echo date('H:i:s'), ' Saving the result document...', EOL;
 $templateProcessor->saveAs('results/Sample_23_TemplateBlock.docx');
 
-echo getEndingNotes(array('Word2007' => 'docx'));
+echo getEndingNotes(array('Word2007' => 'docx'), 'results/Sample_23_TemplateBlock.docx');
 if (!CLI) {
     include_once 'Sample_Footer.php';
 }
diff --git a/samples/Sample_32_Chart.php b/samples/Sample_32_Chart.php
@@ -16,8 +16,8 @@
 $section->addTitle('2D charts', 1);
 $section = $phpWord->addSection(array('colsNum' => 2, 'breakType' => 'continuous'));
 
-$chartTypes = array('pie', 'doughnut', 'bar', 'column', 'line', 'area', 'scatter', 'radar');
-$twoSeries = array('bar', 'column', 'line', 'area', 'scatter', 'radar');
+$chartTypes = array('pie', 'doughnut', 'bar', 'column', 'line', 'area', 'scatter', 'radar', 'stacked_bar', 'percent_stacked_bar', 'stacked_column', 'percent_stacked_column');
+$twoSeries = array('bar', 'column', 'line', 'area', 'scatter', 'radar', 'stacked_bar', 'percent_stacked_bar', 'stacked_column', 'percent_stacked_column');
 $threeSeries = array('bar', 'line');
 $categories = array('A', 'B', 'C', 'D', 'E');
 $series1 = array(1, 3, 2, 5, 4);
diff --git a/src/PhpWord/Element/Chart.php b/src/PhpWord/Element/Chart.php
@@ -61,11 +61,12 @@ class Chart extends AbstractElement
      * @param array $categories
      * @param array $values
      * @param array $style
+     * @param null|mixed $seriesName
      */
-    public function __construct($type, $categories, $values, $style = null)
+    public function __construct($type, $categories, $values, $style = null, $seriesName = null)
     {
         $this->setType($type);
-        $this->addSeries($categories, $values);
+        $this->addSeries($categories, $values, $seriesName);
         $this->style = $this->setNewStyle(new ChartStyle(), $style, true);
     }
 
@@ -86,7 +87,7 @@ public function getType()
      */
     public function setType($value)
     {
-        $enum = array('pie', 'doughnut', 'line', 'bar', 'column', 'area', 'radar', 'scatter');
+        $enum = array('pie', 'doughnut', 'line', 'bar', 'stacked_bar', 'percent_stacked_bar', 'column', 'stacked_column', 'percent_stacked_column', 'area', 'radar', 'scatter');
         $this->type = $this->setEnumVal($value, $enum, 'pie');
     }
 
@@ -95,10 +96,15 @@ public function setType($value)
      *
      * @param array $categories
      * @param array $values
+     * @param null|mixed $name
      */
-    public function addSeries($categories, $values)
+    public function addSeries($categories, $values, $name = null)
     {
-        $this->series[] = array('categories' => $categories, 'values' => $values);
+        $this->series[] = array(
+            'categories' => $categories,
+            'values'     => $values,
+            'name'       => $name,
+        );
     }
 
     /**
diff --git a/src/PhpWord/Reader/Word2007/AbstractPart.php b/src/PhpWord/Reader/Word2007/AbstractPart.php
@@ -588,6 +588,8 @@ private function findPossibleAttribute(XMLReader $xmlReader, \DOMElement $node,
                     return $possibleAttribute;
                 }
             }
+
+            return null;
         }
 
         return $attributes;
diff --git a/src/PhpWord/Reader/Word2007/Settings.php b/src/PhpWord/Reader/Word2007/Settings.php
@@ -109,7 +109,9 @@ protected function setDocumentProtection(XMLReader $xmlReader, PhpWord $phpWord,
         $documentProtection = $phpWord->getSettings()->getDocumentProtection();
 
         $edit = $xmlReader->getAttribute('w:edit', $node);
-        $documentProtection->setEditing($edit);
+        if ($edit !== null) {
+            $documentProtection->setEditing($edit);
+        }
     }
 
     /**
diff --git a/src/PhpWord/Style/Chart.php b/src/PhpWord/Style/Chart.php
@@ -46,6 +46,60 @@ class Chart extends AbstractStyle
     private $is3d = false;
 
     /**
+     * A list of colors to use in the chart
+     *
+     * @var array
+     */
+    private $colors = array();
+
+    /**
+     * A list of display options for data labels
+     *
+     * @var array
+     */
+    private $dataLabelOptions = array(
+        'showVal'          => true, // value
+        'showCatName'      => true, // category name
+        'showLegendKey'    => false, //show the cart legend
+        'showSerName'      => false, // series name
+        'showPercent'      => false,
+        'showLeaderLines'  => false,
+        'showBubbleSize'   => false,
+    );
+
+    /**
+     * A string that tells the writer where to write chart labels or to skip
+     * "nextTo" - sets labels next to the axis (bar graphs on the left) (default)
+     * "low" - labels on the left side of the graph
+     * "high" - labels on the right side of the graph
+     *
+     * @var string
+     */
+    private $categoryLabelPosition = 'nextTo';
+
+    /**
+     * A string that tells the writer where to write chart labels or to skip
+     * "nextTo" - sets labels next to the axis (bar graphs on the bottom) (default)
+     * "low" - labels are below the graph
+     * "high" - labels above the graph
+     *
+     * @var string
+     */
+    private $valueLabelPosition = 'nextTo';
+
+    /**
+     * @var string
+     */
+    private $categoryAxisTitle;
+
+    /**
+     * @var string
+     */
+    private $valueAxisTitle;
+
+    private $majorTickMarkPos = 'none';
+
+    /*
      * Show labels for axis
      *
      * @var bool
@@ -146,6 +200,28 @@ public function set3d($value = true)
     }
 
     /**
+     * Get the list of colors to use in a chart.
+     *
+     * @return array
+     */
+    public function getColors()
+    {
+        return $this->colors;
+    }
+
+    /**
+     * Set the colors to use in a chart.
+     *
+     * @param array $value a list of colors to use in the chart
+     */
+    public function setColors($value = array())
+    {
+        $this->colors = $value;
+
+        return $this;
+    }
+
+    /*
      * Show labels for axis
      *
      * @return bool
@@ -169,6 +245,31 @@ public function setShowAxisLabels($value = true)
     }
 
     /**
+     * get the list of options for data labels
+     *
+     * @return array
+     */
+    public function getDataLabelOptions()
+    {
+        return $this->dataLabelOptions;
+    }
+
+    /**
+     * Set values for data label options.
+     * This will only change values for options defined in $this->dataLabelOptions, and cannot create new ones.
+     *
+     * @param array $values [description]
+     */
+    public function setDataLabelOptions($values = array())
+    {
+        foreach (array_keys($this->dataLabelOptions) as $option) {
+            if (isset($values[$option])) {
+                $this->dataLabelOptions[$option] = $this->setBoolVal($values[$option], $this->dataLabelOptions[$option]);
+            }
+        }
+    }
+
+    /*
      * Show Gridlines for Y-Axis
      *
      * @return bool
@@ -192,6 +293,117 @@ public function setShowGridY($value = true)
     }
 
     /**
+     * Get the categoryLabelPosition setting
+     *
+     * @return string
+     */
+    public function getCategoryLabelPosition()
+    {
+        return $this->categoryLabelPosition;
+    }
+
+    /**
+     * Set the categoryLabelPosition setting
+     * "none" - skips writing  labels
+     * "nextTo" - sets labels next to the  (bar graphs on the left)
+     * "low" - labels on the left side of the graph
+     * "high" - labels on the right side of the graph
+     *
+     * @param mixed $labelPosition
+     * @return self
+     */
+    public function setCategoryLabelPosition($labelPosition)
+    {
+        $enum = array('nextTo', 'low', 'high');
+        $this->categoryLabelPosition = $this->setEnumVal($labelPosition, $enum, $this->categoryLabelPosition);
+
+        return $this;
+    }
+
+    /**
+     * Get the valueAxisLabelPosition setting
+     *
+     * @return string
+     */
+    public function getValueLabelPosition()
+    {
+        return $this->valueLabelPosition;
+    }
+
+    /**
+     * Set the valueLabelPosition setting
+     * "none" - skips writing labels
+     * "nextTo" - sets labels next to the value
+     * "low" - sets labels are below the graph
+     * "high" - sets labels above the graph
+     *
+     * @param string
+     * @param mixed $labelPosition
+     */
+    public function setValueLabelPosition($labelPosition)
+    {
+        $enum = array('nextTo', 'low', 'high');
+        $this->valueLabelPosition = $this->setEnumVal($labelPosition, $enum, $this->valueLabelPosition);
+
+        return $this;
+    }
+
+    /**
+     * Get the categoryAxisTitle
+     * @return string
+     */
+    public function getCategoryAxisTitle()
+    {
+        return $this->categoryAxisTitle;
+    }
+
+    /**
+     * Set the title that appears on the category side of the chart
+     * @param string $axisTitle
+     */
+    public function setCategoryAxisTitle($axisTitle)
+    {
+        $this->categoryAxisTitle = $axisTitle;
+
+        return $this;
+    }
+
+    /**
+     * Get the valueAxisTitle
+     * @return string
+     */
+    public function getValueAxisTitle()
+    {
+        return $this->valueAxisTitle;
+    }
+
+    /**
+     * Set the title that appears on the value side of the chart
+     * @param string $axisTitle
+     */
+    public function setValueAxisTitle($axisTitle)
+    {
+        $this->valueAxisTitle = $axisTitle;
+
+        return $this;
+    }
+
+    public function getMajorTickPosition()
+    {
+        return $this->majorTickMarkPos;
+    }
+
+    /**
+     * set the position for major tick marks
+     * @param string $position [description]
+     */
+    public function setMajorTickPosition($position)
+    {
+        $enum = array('in', 'out', 'cross', 'none');
+        $this->majorTickMarkPos = $this->setEnumVal($position, $enum, $this->majorTickMarkPos);
+    }
+
+    /*
      * Show Gridlines for X-Axis
      *
      * @return bool
diff --git a/src/PhpWord/Writer/Word2007/Part/Chart.php b/src/PhpWord/Writer/Word2007/Part/Chart.php
diff --git a/tests/PhpWord/Style/ChartTest.php b/tests/PhpWord/Style/ChartTest.php

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@`
`56`	`56`	`echo date('H:i:s'), ' Saving the result document...', EOL;`
`57`	`57`	`$templateProcessor->saveAs('results/Sample_07_TemplateCloneRow.docx');`
`58`	`58`
`59`		`-echo getEndingNotes(array('Word2007' => 'docx'));`
	`59`	`+echo getEndingNotes(array('Word2007' => 'docx'), 'results/Sample_07_TemplateCloneRow.docx');`
`60`	`60`	`if (!CLI) {`
`61`	`61`	`include_once 'Sample_Footer.php';`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`echo date('H:i:s'), ' Saving the result document...', EOL;`
`15`	`15`	`$templateProcessor->saveAs('results/Sample_23_TemplateBlock.docx');`
`16`	`16`
`17`		`-echo getEndingNotes(array('Word2007' => 'docx'));`
	`17`	`+echo getEndingNotes(array('Word2007' => 'docx'), 'results/Sample_23_TemplateBlock.docx');`
`18`	`18`	`if (!CLI) {`
`19`	`19`	`include_once 'Sample_Footer.php';`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,11 +61,12 @@ class Chart extends AbstractElement`
`61`	`61`	`* @param array $categories`
`62`	`62`	`* @param array $values`
`63`	`63`	`* @param array $style`
	`64`	`+ * @param null\|mixed $seriesName`
`64`	`65`	`*/`
`65`		`- public function __construct($type, $categories, $values, $style = null)`
	`66`	`+ public function __construct($type, $categories, $values, $style = null, $seriesName = null)`
`66`	`67`	`{`
`67`	`68`	`$this->setType($type);`
`68`		`- $this->addSeries($categories, $values);`
	`69`	`+ $this->addSeries($categories, $values, $seriesName);`
`69`	`70`	`$this->style = $this->setNewStyle(new ChartStyle(), $style, true);`
`70`	`71`	`}`
`71`	`72`
`@@ -86,7 +87,7 @@ public function getType()`
`86`	`87`	`*/`
`87`	`88`	`public function setType($value)`
`88`	`89`	`{`
`89`		`- $enum = array('pie', 'doughnut', 'line', 'bar', 'column', 'area', 'radar', 'scatter');`
	`90`	`+ $enum = array('pie', 'doughnut', 'line', 'bar', 'stacked_bar', 'percent_stacked_bar', 'column', 'stacked_column', 'percent_stacked_column', 'area', 'radar', 'scatter');`
`90`	`91`	`$this->type = $this->setEnumVal($value, $enum, 'pie');`
`91`	`92`	`}`
`92`	`93`
`@@ -95,10 +96,15 @@ public function setType($value)`
`95`	`96`	`*`
`96`	`97`	`* @param array $categories`
`97`	`98`	`* @param array $values`
	`99`	`+ * @param null\|mixed $name`
`98`	`100`	`*/`
`99`		`- public function addSeries($categories, $values)`
	`101`	`+ public function addSeries($categories, $values, $name = null)`
`100`	`102`	`{`
`101`		`- $this->series[] = array('categories' => $categories, 'values' => $values);`
	`103`	`+ $this->series[] = array(`
	`104`	`+ 'categories' => $categories,`
	`105`	`+ 'values' => $values,`
	`106`	`+ 'name' => $name,`
	`107`	`+ );`
`102`	`108`	`}`
`103`	`109`
`104`	`110`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -588,6 +588,8 @@ private function findPossibleAttribute(XMLReader $xmlReader, \DOMElement $node,`
`588`	`588`	`return $possibleAttribute;`
`589`	`589`	`}`
`590`	`590`	`}`
	`591`	`+`
	`592`	`+ return null;`
`591`	`593`	`}`
`592`	`594`
`593`	`595`	`return $attributes;`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,9 @@ protected function setDocumentProtection(XMLReader $xmlReader, PhpWord $phpWord,`
`109`	`109`	`$documentProtection = $phpWord->getSettings()->getDocumentProtection();`
`110`	`110`
`111`	`111`	`$edit = $xmlReader->getAttribute('w:edit', $node);`
`112`		`- $documentProtection->setEditing($edit);`
	`112`	`+ if ($edit !== null) {`
	`113`	`+ $documentProtection->setEditing($edit);`
	`114`	`+ }`
`113`	`115`	`}`
`114`	`116`
`115`	`117`	`/**`