PHPOffice#278: Basic chart

Author: ivanlanin

CHANGELOG.md

@@ -14,6 +14,7 @@ This release added drawing shapes (arc, curve, line, polyline, rect, oval) eleme
 - RTF Writer: Support for sections, margins, and borders - @ivanlanin GH-249
 - Section: Ability to set paper size, e.g. A4, A3, and Legal - @ivanlanin GH-249
 - General: New `PhpWord::save()` method to encapsulate `IOFactory` - @ivanlanin
+- Element: Basic 2D charts (pie, doughnut, bar, line, area, scatter, radar) - @ivanlanin GH-278
 
 ### Bugfixes
 

README.md

@@ -30,6 +30,8 @@ With PHPWord, you can create DOCX, ODT, or RTF documents dynamically using your
 - Insert list items as bulleted, numbered, or multilevel
 - Insert hyperlinks
 - Insert footnotes and endnotes
+- Insert drawing shapes (arc, curve, line, polyline, rect, oval)
+- Insert charts (pie, doughnut, bar, line, area, scatter, radar)
 - Create document from templates
 - Use XSL 1.0 style sheets to transform main document part of OOXML template
 - ... and many more features on progress

docs/elements.rst

@@ -49,6 +49,8 @@ column shows the containers while the rows lists the elements.
 +-------+-----------------+-----------+----------+----------+---------+------------+------------+
 | 20    | Shape           | v         | v        | v        | v       | v          | v          |
 +-------+-----------------+-----------+----------+----------+---------+------------+------------+
+| 21    | Chart           | v         | -        | -        | -       | -          | -          |
++-------+-----------------+-----------+----------+----------+---------+------------+------------+
 
 Legend:
 
@@ -399,3 +401,8 @@ Shapes
 ------
 
 To be completed.
+
+Charts
+------
+
+To be completed.

docs/intro.rst

@@ -45,6 +45,8 @@ Features
 -  Insert list items as bulleted, numbered, or multilevel
 -  Insert hyperlinks
 -  Insert footnotes and endnotes
+-  Insert drawing shapes (arc, curve, line, polyline, rect, oval)
+-  Insert charts (pie, doughnut, bar, line, area, scatter, radar)
 -  Create document from templates
 -  Use XSL 1.0 style sheets to transform main document part of OOXML
    template

docs/src/documentation.md

@@ -37,6 +37,7 @@ Don't forget to change `code::` directive to `code-block::` in the resulting rst
     - [Fields](#fields)
     - [Lines](#lines)
     - [Shapes](#shapes)
+    - [Charts](#charts)
 - [Styles](#styles)
     - [Section](#section)
     - [Font](#font)
@@ -76,6 +77,8 @@ PHPWord is an open source project licensed under the terms of [LGPL version 3](h
 - Insert list items as bulleted, numbered, or multilevel
 - Insert hyperlinks
 - Insert footnotes and endnotes
+- Insert drawing shapes (arc, curve, line, polyline, rect, oval)
+- Insert charts (pie, doughnut, bar, line, area, scatter, radar)
 - Create document from templates
 - Use XSL 1.0 style sheets to transform main document part of OOXML template
 - ... and many more features on progress
@@ -440,6 +443,7 @@ Below are the matrix of element availability in each container. The column shows
 | 18  | Field         | v       | v      | v      | v    | v        | v        |
 | 19  | Line          | v       | v      | v      | v    | v        | v        |
 | 20  | Shape         | v       | v      | v      | v    | v        | v        |
+| 21  | Chart         | v       | -      | -      | -    | -        | -        |
 
 Legend:
 
@@ -737,6 +741,10 @@ To be completed.
 
 To be completed.
 
+## Charts
+
+To be completed.
+
 # Styles
 
 ## Section

samples/Sample_32_Chart.php

@@ -9,13 +9,23 @@
 $section = $phpWord->addSection(array('colsNum' => 2));
 $phpWord->addTitleStyle(1, array('size' => 14, 'bold' => true), array('keepNext' => true, 'spaceBefore' => 240));
 
-$charts = array('pie', 'doughnut', 'line', 'area', 'scatter', 'bar', 'radar');
-$labels = array('A', 'B', 'C', 'D', 'E');
-$data = array(1, 3, 2, 5, 4);
+$chartTypes = array('pie', 'doughnut', 'bar', 'line', 'area', 'scatter', 'radar');
+$twoSeries = array('bar', 'line', 'area', 'scatter', 'radar');
+$threeSeries = array('bar', 'line');
+$categories = array('A', 'B', 'C', 'D', 'E');
+$series1 = array(1, 3, 2, 5, 4);
+$series2 = array(3, 1, 7, 2, 6);
+$series3 = array(8, 3, 2, 5, 4);
 
-foreach ($charts as $chart) {
-    $section->addTitle(ucfirst($chart), 1);
-    $section->addChart($chart, $labels, $data);
+foreach ($chartTypes as $chartType) {
+    $section->addTitle(ucfirst($chartType), 1);
+    $chart = $section->addChart($chartType, $categories, $series1);
+    if (in_array($chartType, $twoSeries)) {
+        $chart->addSeries($categories, $series2);
+    }
+    if (in_array($chartType, $threeSeries)) {
+        $chart->addSeries($categories, $series3);
+    }
     $section->addTextBreak();
 }
 

src/PhpWord/Element/Chart.php

@@ -39,31 +39,23 @@ class Chart extends AbstractElement
     private $type = 'pie';
 
     /**
-     * Labels
+     * Series
      *
      * @var array
      */
-    private $labels = array();
-
-    /**
-     * Data
-     *
-     * @var array
-     */
-    private $data = array();
+    private $series = array();
 
     /**
      * Create new instance
      *
      * @param string $type
-     * @param array $labels
-     * @param array $data
+     * @param array $categories
+     * @param array $values
      */
-    public function __construct($type, $labels, $data)
+    public function __construct($type, $categories, $values)
     {
         $this->setType($type);
-        $this->setLabels($labels);
-        $this->setData($data);
+        $this->addSeries($categories, $values);
     }
 
     /**
@@ -88,42 +80,23 @@ public function setType($value)
     }
 
     /**
-     * Get labels
-     *
-     * @return array
-     */
-    public function getLabels()
-    {
-        return $this->labels;
-    }
-
-    /**
-     * Set labels
+     * Add series
      *
-     * @param array $value
+     * @param array $categories
+     * @param array $values
      */
-    public function setLabels($value)
+    public function addSeries($categories, $values)
     {
-        $this->labels = $value;
+        $this->series[] = array('categories' => $categories, 'values' => $values);
     }
 
     /**
-     * Get data
+     * Get series
      *
      * @return array
      */
-    public function getData()
-    {
-        return $this->data;
-    }
-
-    /**
-     * Set data
-     *
-     * @param array $value
-     */
-    public function setData($value)
+    public function getSeries()
     {
-        $this->data = $value;
+        return $this->series;
     }
 }

src/PhpWord/Shared/XMLWriter.php

@@ -150,7 +150,7 @@ public function getData()
      * @param string|array $attributes
      * @param string $value
      */
-    public function writeBlock($element, $attributes, $value = null)
+    public function writeElementBlock($element, $attributes, $value = null)
     {
         $this->xmlWriter->startElement($element);
         if (!is_array($attributes)) {

src/PhpWord/Writer/Word2007/Element/Chart.php

@@ -48,8 +48,8 @@ public function write()
         $xmlWriter->startElement('wp:inline');
 
         // EMU
-        $xmlWriter->writeBlock('wp:extent', array('cx' => '2000000', 'cy' => '2000000'));
-        $xmlWriter->writeBlock('wp:docPr', array('id' => $rId, 'name' => "Chart{$rId}"));
+        $xmlWriter->writeElementBlock('wp:extent', array('cx' => '2000000', 'cy' => '2000000'));
+        $xmlWriter->writeElementBlock('wp:docPr', array('id' => $rId, 'name' => "Chart{$rId}"));
 
         $xmlWriter->startElement('a:graphic');
         $xmlWriter->writeAttribute('xmlns:a', 'http://schemas.openxmlformats.org/drawingml/2006/main');