Clientbase
/
PHPWord
mirror of https://github.com/basemaster/PHPWord.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#123: New drawing shapes (arc, curve, line, polyline, rect, oval)

This commit is contained in:
Ivan Lanin 2014-06-02 21:21:34 +07:00
parent b38dd82c87
commit a66f93ccdc
28 changed files with 1715 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -6,7 +6,7 @@ This is the changelog between releases of PHPWord. Releases are listed in revers
### Features
None yet.
- Element: Ability to add drawing shapes (arc, curve, line, polyline, rect, oval) using new `Shape` element - @ivanlanin GH-123
### Bugfixes

9
docs/elements.rst
View File

@ -47,6 +47,8 @@ column shows the containers while the rows lists the elements.
+-------+-----------------+-----------+----------+----------+---------+------------+------------+
| 19 | Line | v | v | v | v | v | v |
+-------+-----------------+-----------+----------+----------+---------+------------+------------+
| 20 | Shapes | v | v | v | v | v | v |
+-------+-----------------+-----------+----------+----------+---------+------------+------------+
Legend:
@ -490,7 +492,12 @@ Fields
To be completed
Line
Lines
-----
To be completed
Shapes
------
To be completed

4
docs/intro.rst
View File

@ -99,11 +99,11 @@ Writers
+---------------------------+----------------------+--------+-------+-------+--------+-------+
| | Endnote | ✓ | | | ✓ | |
+---------------------------+----------------------+--------+-------+-------+--------+-------+
| **Graphs** | 2D basic graphs | | | | | |
| **Graphs** | 2D basic graphs | ✓ | | | | |
+---------------------------+----------------------+--------+-------+-------+--------+-------+
| | 2D advanced graphs | | | | | |
+---------------------------+----------------------+--------+-------+-------+--------+-------+
| | 3D graphs | | | | | |
| | 3D graphs | ✓ | | | | |
+---------------------------+----------------------+--------+-------+-------+--------+-------+
| **Math** | OMML support | | | | | |
+---------------------------+----------------------+--------+-------+-------+--------+-------+

10
docs/src/documentation.md
View File

@ -36,6 +36,7 @@ Don't forget to change `code::` directive to `code-block::` in the resulting rst
- [Textboxes](#textboxes)
- [Fields](#fields)
- [Lines](#lines)
- [Shapes](#shapes)
- [Templates](#templates)
- [Writers & readers](#writers-readers)
- [OOXML](#ooxml)
@ -101,9 +102,9 @@ Below are the supported features for each file formats.
| | Footer | ✓ | | | | |
| | Footnote | ✓ | | | ✓ | |
| | Endnote | ✓ | | | ✓ | |
| **Graphs** | 2D basic graphs | | | | | |
| **Graphs** | 2D basic graphs | ✓ | | | | |
| | 2D advanced graphs | | | | | |
| | 3D graphs | | | | | |
| | 3D graphs | ✓ | | | | |
| **Math** | OMML support | | | | | |
| | MathML support | | | | | |
| **Bonus** | Encryption | | | | | |
@ -465,6 +466,7 @@ Below are the matrix of element availability in each container. The column shows
| 17 | TextBox | v | v | v | v | - | - |
| 18 | Field | v | v | v | v | v | v |
| 19 | Line | v | v | v | v | v | v |
| 20 | Shape | v | v | v | v | v | v |
Legend:
@ -850,6 +852,10 @@ To be completed.
To be completed.
## Shapes
To be completed.
# Templates
You can create a docx template with included search-patterns that can be replaced by any value you wish. Only single-line values can be replaced. To load a template file, use the `loadTemplate` method. After loading the docx template, you can use the `setValue` method to change the value of a search pattern. The search-pattern model is: `${search-pattern}`. It is not possible to add new PHPWord elements to a loaded template file.

2
phpmd.xml.dist
View File

@ -18,7 +18,7 @@
<rule ref="rulesets/design.xml/NumberOfChildren">
<!-- AbstractStyle needs more children (default: 15) -->
<properties>
<property name="minimum" value="20" />
<property name="minimum" value="30" />
</properties>
</rule>
<rule ref="rulesets/unusedcode.xml" />

82
samples/Sample_31_Shape.php Normal file
View File

@ -0,0 +1,82 @@
<?php
include_once 'Sample_Header.php';
// New Word document
echo date('H:i:s'), " Create new PhpWord object", EOL;
$phpWord = new \PhpOffice\PhpWord\PhpWord();
$phpWord->addTitleStyle(1, array('size' => 14, 'bold' => true));
$section = $phpWord->addSection();
// Arc
$section->addTitle('Arc', 1);
$section->addShape(
'arc',
array(
'points' => '-90 20',
'frame' => array('width' => 120, 'height' => 120),
'outline' => array('color' => '#333333', 'weight' => 2, 'startArrow' => 'oval', 'endArrow' => 'open'),
)
);
// Curve
$section->addTitle('Curve', 1);
$section->addShape(
'curve',
array(
'points' => '1,100 200,1 1,50 200,50', 'connector' => 'elbow',
'outline' => array('color' => '#66cc00', 'weight' => 2, 'dash' => 'dash', 'startArrow' => 'diamond', 'endArrow' => 'block'),
)
);
// Line
$section->addTitle('Line', 1);
$section->addShape(
'line',
array(
'points' => '1,1 150,30',
'outline' => array('color' => '#cc00ff', 'line' => 'thickThin', 'weight' => 3, 'startArrow' => 'oval', 'endArrow' => 'classic'),
)
);
// Polyline
$section->addTitle('Polyline', 1);
$section->addShape(
'polyline',
array(
'points' => '1,30 20,10 55,20 75,10 100,40 115,50, 120,15 200,50',
'outline' => array('color' => '#cc6666', 'weight' => 2, 'startArrow' => 'none', 'endArrow' => 'classic'),
)
);
// Rectangle
$section->addTitle('Rectangle', 1);
$section->addShape(
'rect',
array(
'roundness' => 0.2,
'frame' => array('width' => 100, 'height' => 100, 'left' => 1, 'top' => 1),
'fill' => array('color' => '#FFCC33'),
'outline' => array('color' => '#990000', 'weight' => 1),
'shadow' => array(),
)
);
// Oval
$section->addTitle('Oval', 1);
$section->addShape(
'oval',
array(
'frame' => array('width' => 100, 'height' => 70, 'left' => 1, 'top' => 1),
'fill' => array('color' => '#33CC99'),
'outline' => array('color' => '#333333', 'weight' => 2),
'extrusion' => array(),
)
);
// Save file
echo write($phpWord, basename(__FILE__, '.php'), $writers);
if (!CLI) {
include_once 'Sample_Footer.php';
}

4
src/PhpWord/Element/AbstractContainer.php
View File

@ -39,6 +39,7 @@ use PhpOffice\PhpWord\PhpWord;
* @method TextBox addTextBox($style = null)
* @method Field addField($type = null, $properties = array(), $options = array())
* @method Line addLine($lineStyle = null)
* @method Shape addObject($type, $style = null)
*
* @since 0.10.0
*/
@ -74,7 +75,7 @@ abstract class AbstractContainer extends AbstractElement
{
$elements = array('Text', 'TextRun', 'Link', 'PreserveText', 'TextBreak',
'ListItem', 'ListItemRun', 'Table', 'Image', 'Object', 'Footnote',
'Endnote', 'CheckBox', 'TextBox', 'Field', 'Line');
'Endnote', 'CheckBox', 'TextBox', 'Field', 'Line', 'Shape');
$functions = array();
for ($i = 0; $i < count($elements); $i++) {
$functions[$i] = 'add' . $elements[$i];
@ -242,6 +243,7 @@ abstract class AbstractContainer extends AbstractElement
'Object' => $allContainers,
'Field' => $allContainers,
'Line' => $allContainers,
'Shape' => $allContainers,
'TextRun' => array('Section', 'Header', 'Footer', 'Cell', 'TextBox'),
'ListItem' => array('Section', 'Header', 'Footer', 'Cell', 'TextBox'),
'ListItemRun' => array('Section', 'Header', 'Footer', 'Cell', 'TextBox'),

21
src/PhpWord/Element/AbstractElement.php
View File

@ -262,4 +262,25 @@ abstract class AbstractElement
return $style;
}
/**
* Set enum value
*
* @param mixed $value
* @param array $enum
* @param mixed $default
* @return mixed
* @throws \InvalidArgumentException
* @todo Merge with the same method in AbstractStyle
*/
protected function setEnumVal($value = null, $enum = array(), $default = null)
{
if ($value != null && trim($value) != '' && !empty($enum) && !in_array($value, $enum)) {
throw new \InvalidArgumentException("Invalid style value: {$value}");
} elseif ($value === null || trim($value) == '') {
$value = $default;
}
return $value;
}
}

88
src/PhpWord/Element/Shape.php Normal file
View File

@ -0,0 +1,88 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Element;
use PhpOffice\PhpWord\Style\Shape as ShapeStyle;
/**
* Shape element
*
* @since 0.12.0
*/
class Shape extends AbstractElement
{
/**
* Shape type arc|curve|line|polyline|rect|oval
*
* @var string
*/
private $type;
/**
* Shape style
*
* @var \PhpOffice\PhpWord\Style\Shape
*/
private $style;
/**
* Create new instance
*
* @param string $type
* @param mixed $style
*/
public function __construct($type, $style = null)
{
$this->setType($type);
$this->style = $this->setStyle(new ShapeStyle(), $style);
}
/**
* Get type
*
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* Set pattern
*
* @param string $value
* @return self
*/
public function setType($value = null)
{
$enum = array('arc', 'curve', 'line', 'polyline', 'rect', 'oval');
$this->type = $this->setEnumVal($value, $enum, null);
return $this;
}
/**
* Get shape style
*
* @return \PhpOffice\PhpWord\Style\Shape
*/
public function getStyle()
{
return $this->style;
}
}

2
src/PhpWord/Style/AbstractStyle.php
View File

@ -264,7 +264,7 @@ abstract class AbstractStyle
protected function setEnumVal($value = null, $enum = array(), $default = null)
{
if ($value != null && trim($value) != '' && !empty($enum) && !in_array($value, $enum)) {
throw new \InvalidArgumentException('Invalid style value.');
throw new \InvalidArgumentException("Invalid style value: {$value}");
} elseif ($value === null || trim($value) == '') {
$value = $default;
}

106
src/PhpWord/Style/Extrusion.php Normal file
View File

@ -0,0 +1,106 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Style;
/**
* 3D extrusion style
*
* @link http://www.schemacentral.com/sc/ooxml/t-o_CT_Extrusion.html
* @since 0.12.0
*/
class Extrusion extends AbstractStyle
{
/**
* Type constants
*
* @const string
*/
const EXTRUSION_PARALLEL = 'parallel';
const EXTRUSION_PERSPECTIVE = 'perspective';
/**
* Type: parallel|perspective
*
* @var string
*/
private $type;
/**
* Color
*
* @var string
*/
private $color;
/**
* Create a new instance
*
* @param array $style
*/
public function __construct($style = array())
{
$this->setStyleByArray($style);
}
/**
* Get type
*
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* Set pattern
*
* @param string $value
* @return self
*/
public function setType($value = null)
{
$enum = array(self::EXTRUSION_PARALLEL, self::EXTRUSION_PERSPECTIVE);
$this->type = $this->setEnumVal($value, $enum, null);
return $this;
}
/**
* Get color
*
* @return string
*/
public function getColor()
{
return $this->color;
}
/**
* Set color
*
* @param string $value
* @return self
*/
public function setColor($value = null)
{
$this->color = $value;
return $this;
}
}

69
src/PhpWord/Style/Fill.php Normal file
View File

@ -0,0 +1,69 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Style;
/**
* Fill style
*
* There are still lot of interesting things for this style that can be added, including gradient. See @link.
*
* @link http://www.schemacentral.com/sc/ooxml/t-v_CT_Fill.html
* @since 0.12.0
*/
class Fill extends AbstractStyle
{
/**
* Color
*
* @var string
*/
private $color;
/**
* Create a new instance
*
* @param array $style
*/
public function __construct($style = array())
{
$this->setStyleByArray($style);
}
/**
* Get color
*
* @return string
*/
public function getColor()
{
return $this->color;
}
/**
* Set color
*
* @param string $value
* @return self
*/
public function setColor($value = null)
{
$this->color = $value;
return $this;
}
}

159
src/PhpWord/Style/Frame.php Normal file
View File

@ -0,0 +1,159 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Style;
/**
* Frame defines the size and position of an object
*
* Width, height, left/hpos, top/vpos, hrel, vrel, wrap, zindex
*
* @since 0.12.0
* @todo Make existing style (image, textbox, etc) use this style
*/
class Frame extends AbstractStyle
{
/**
* Width
*
* @var int|float
*/
private $width;
/**
* Height
*
* @var int|float
*/
private $height;
/**
* Leftmost (horizontal) position
*
* @var int|float
*/
private $left = 0;
/**
* Topmost (vertical) position
*
* @var int|float
*/
private $top = 0;
/**
* Create a new instance
*
* @param array $style
*/
public function __construct($style = array())
{
$this->setStyleByArray($style);
}
/**
* Get width
*
* @return int|float
*/
public function getWidth()
{
return $this->width;
}
/**
* Set width
*
* @param int|float $value
* @return self
*/
public function setWidth($value = null)
{
$this->width = $this->setNumericVal($value, null);
return $this;
}
/**
* Get height
*
* @return int|float
*/
public function getHeight()
{
return $this->height;
}
/**
* Set height
*
* @param int|float $value
* @return self
*/
public function setHeight($value = null)
{
$this->height = $this->setNumericVal($value, null);
return $this;
}
/**
* Get left
*
* @return int|float
*/
public function getLeft()
{
return $this->left;
}
/**
* Set left
*
* @param int|float $value
* @return self
*/
public function setLeft($value = 0)
{
$this->left = $this->setNumericVal($value, 0);
return $this;
}
/**
* Get topmost position
*
* @return int|float
*/
public function getTop()
{
return $this->top;
}
/**
* Set topmost position
*
* @param int|float $value
* @return self
*/
public function setTop($value = 0)
{
$this->top = $this->setNumericVal($value, 0);
return $this;
}
}

248
src/PhpWord/Style/Outline.php Normal file
View File

@ -0,0 +1,248 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Style;
/**
* Outline defines the line/border of the object
*
* @link http://www.schemacentral.com/sc/ooxml/t-v_CT_Stroke.html
* @since 0.12.0
*/
class Outline extends AbstractStyle
{
/**
* Line style constants
*
* @link http://www.schemacentral.com/sc/ooxml/t-v_ST_StrokeLineStyle.html
* @const string
*/
const LINE_SINGLE = 'single';
const LINE_THIN_THIN = 'thinThin';
const LINE_THIN_THICK = 'thinThick';
const LINE_THICK_THIN = 'thickThin';
const LINE_THICK_BETWEEN_THIN = 'thickBetweenThin';
/**
* Arrowhead type constants
*
* @link http://www.schemacentral.com/sc/ooxml/t-v_ST_StrokeArrowType.html
* @const string
*/
const ARROW_NONE = 'none';
const ARROW_BLOCK = 'block';
const ARROW_CLASSIC = 'classic';
const ARROW_OVAL = 'oval';
const ARROW_DIAMOND = 'diamond';
const ARROW_OPEN = 'open';
/**
* Outline weight
*
* @var int|float
*/
private $weight;
/**
* Outline color
*
* @var string
*/
private $color;
/**
* Dash type
*
* @var string
*/
private $dash;
/**
* Line style
*
* @var string
*/
private $line;
/**
* Start arrow type
*
* @var string
*/
private $startArrow;
/**
* End arrow type
*
* @var string
*/
private $endArrow;
/**
* Create a new instance
*
* @param array $style
*/
public function __construct($style = array())
{
$this->setStyleByArray($style);
}
/**
* Get weight
*
* @return int|float
*/
public function getWeight()
{
return $this->weight;
}
/**
* Set weight
*
* @param int|float $value
* @return self
*/
public function setWeight($value = null)
{
$this->weight = $this->setNumericVal($value, null);
return $this;
}
/**
* Get color
*
* @return string
*/
public function getColor()
{
return $this->color;
}
/**
* Set color
*
* @param string $value
* @return self
*/
public function setColor($value = null)
{
$this->color = $value;
return $this;
}
/**
* Get dash type
*
* @return string
*/
public function getDash()
{
return $this->dash;
}
/**
* Set dash type
*
* @param string $value
* @return self
*/
public function setDash($value = null)
{
$this->dash = $value;
return $this;
}
/**
* Get line style
*
* @return string
*/
public function getLine()
{
return $this->line;
}
/**
* Set line style
*
* @param string $value
* @return self
*/
public function setLine($value = null)
{
$enum = array(self::LINE_SINGLE, self::LINE_THIN_THIN, self::LINE_THIN_THICK,
self::LINE_THICK_THIN, self::LINE_THICK_BETWEEN_THIN);
$this->line = $this->setEnumVal($value, $enum, null);
return $this;
}
/**
* Get startArrow
*
* @return string
*/
public function getStartArrow()
{
return $this->startArrow;
}
/**
* Set pattern
*
* @param string $value
* @return self
*/
public function setStartArrow($value = null)
{
$enum = array(self::ARROW_NONE, self::ARROW_BLOCK, self::ARROW_CLASSIC,
self::ARROW_OVAL, self::ARROW_DIAMOND, self::ARROW_OPEN);
$this->startArrow = $this->setEnumVal($value, $enum, null);
return $this;
}
/**
* Get endArrow
*
* @return string
*/
public function getEndArrow()
{
return $this->endArrow;
}
/**
* Set pattern
*
* @param string $value
* @return self
*/
public function setEndArrow($value = null)
{
$enum = array(self::ARROW_NONE, self::ARROW_BLOCK, self::ARROW_CLASSIC,
self::ARROW_OVAL, self::ARROW_DIAMOND, self::ARROW_OPEN);
$this->endArrow = $this->setEnumVal($value, $enum, null);
return $this;
}
}

97
src/PhpWord/Style/Shadow.php Normal file
View File

@ -0,0 +1,97 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Style;
/**
* Shadow style
*
* @link http://www.schemacentral.com/sc/ooxml/t-v_CT_Shadow.html
* @since 0.12.0
*/
class Shadow extends AbstractStyle
{
/**
* Color
*
* @var string
*/
private $color;
/**
* Offset; Format: 3pt,3pt
*
* @var string
*/
private $offset;
/**
* Create a new instance
*
* @param array $style
*/
public function __construct($style = array())
{
$this->setStyleByArray($style);
}
/**
* Get color
*
* @return string
*/
public function getColor()
{
return $this->color;
}
/**
* Set color
*
* @param string $value
* @return self
*/
public function setColor($value = null)
{
$this->color = $value;
return $this;
}
/**
* Get offset
*
* @return string
*/
public function getOffset()
{
return $this->offset;
}
/**
* Set offset
*
* @param string $value
* @return self
*/
public function setOffset($value = null)
{
$this->offset = $value;
return $this;
}
}

255
src/PhpWord/Style/Shape.php Normal file
View File

@ -0,0 +1,255 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Style;
/**
* Shape style
*
* @since 0.12.0
* @todo Skew http://www.schemacentral.com/sc/ooxml/t-o_CT_Skew.html
*/
class Shape extends AbstractStyle
{
/**
* Points
*
* - Arc: startAngle endAngle; 0 = top center, moving clockwise
* - Curve: from-x1,from-y1 to-x2,to-y2 control1-x,control1-y control2-x,control2-y
* - Line: from-x1,from-y1 to-x2,to-y2
* - Polyline: x1,y1 x2,y2 ...
* - Rect and oval: Not applicable
*
* @var string
*/
private $points;
/**
* Roundness measure of corners; 0 = straightest (rectangular); 1 = roundest (circle/oval)
*
* Only for rect
*
* @var int|float
*/
private $roundness;
/**
* Frame
*
* @var \PhpOffice\PhpWord\Style\Frame
*/
private $frame;
/**
* Fill
*
* @var \PhpOffice\PhpWord\Style\Fill
*/
private $fill;
/**
* Outline
*
* @var \PhpOffice\PhpWord\Style\Outline
*/
private $outline;
/**
* Shadow
*
* @var \PhpOffice\PhpWord\Style\Shadow
*/
private $shadow;
/**
* 3D extrusion
*
* @var \PhpOffice\PhpWord\Style\Extrusion
*/
private $extrusion;
/**
* Create a new instance
*
* @param array $style
*/
public function __construct($style = array())
{
$this->setStyleByArray($style);
}
/**
* Get points
*
* @return string
*/
public function getPoints()
{
return $this->points;
}
/**
* Set points
*
* @param string $value
* @return self
*/
public function setPoints($value = null)
{
$this->points = $value;
return $this;
}
/**
* Get roundness
*
* @return int|float
*/
public function getRoundness()
{
return $this->roundness;
}
/**
* Set roundness
*
* @param int|float $value
* @return self
*/
public function setRoundness($value = null)
{
$this->roundness = $this->setNumericVal($value, null);
return $this;
}
/**
* Get frame
*
* @return \PhpOffice\PhpWord\Style\Frame
*/
public function getFrame()
{
return $this->frame;
}
/**
* Set frame
*
* @param mixed $value
* @return self
*/
public function setFrame($value = null)
{
$this->setObjectVal($value, 'Frame', $this->frame);
return $this;
}
/**
* Get fill
*
* @return \PhpOffice\PhpWord\Style\Fill
*/
public function getFill()
{
return $this->fill;
}
/**
* Set fill
*
* @param mixed $value
* @return self
*/
public function setFill($value = null)
{
$this->setObjectVal($value, 'Fill', $this->fill);
return $this;
}
/**
* Get outline
*
* @return \PhpOffice\PhpWord\Style\Outline
*/
public function getOutline()
{
return $this->outline;
}
/**
* Set outline
*
* @param mixed $value
* @return self
*/
public function setOutline($value = null)
{
$this->setObjectVal($value, 'Outline', $this->outline);
return $this;
}
/**
* Get shadow
*
* @return \PhpOffice\PhpWord\Style\Shadow
*/
public function getShadow()
{
return $this->shadow;
}
/**
* Set shadow
*
* @param mixed $value
* @return self
*/
public function setShadow($value = null)
{
$this->setObjectVal($value, 'Shadow', $this->shadow);
return $this;
}
/**
* Get 3D extrusion
*
* @return \PhpOffice\PhpWord\Style\Extrusion
*/
public function getExtrusion()
{
return $this->extrusion;
}
/**
* Set 3D extrusion
*
* @param mixed $value
* @return self
*/
public function setExtrusion($value = null)
{
$this->setObjectVal($value, 'Extrusion', $this->extrusion);
return $this;
}
}

169
src/PhpWord/Writer/Word2007/Element/Shape.php Normal file
View File

@ -0,0 +1,169 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer\Word2007\Element;
use PhpOffice\PhpWord\Shared\XMLWriter;
use PhpOffice\PhpWord\Element\Shape as ShapeElement;
use PhpOffice\PhpWord\Style\Shape as ShapeStyle;
use PhpOffice\PhpWord\Writer\Word2007\Style\Shape as ShapeStyleWriter;
/**
* Shape element writer
*
* @since 0.12.0
* @SuppressWarnings(PHPMD.UnusedPrivateMethod)
*/
class Shape extends AbstractElement
{
/**
* Write element
*/
public function write()
{
$xmlWriter = $this->getXmlWriter();
$element = $this->getElement();
if (!$element instanceof ShapeElement) {
return;
}
$style = $element->getStyle();
$type = $element->getType();
if ($type == 'rect' && $style->getRoundness() !== null) {
$type = 'roundrect';
}
$method = "write{$type}";
if (!$this->withoutP) {
$xmlWriter->startElement('w:p');
}
$xmlWriter->startElement('w:r');
$xmlWriter->startElement('w:pict');
$xmlWriter->startElement("v:{$type}");
// Element style
if (method_exists($this, $method)) {
$this->$method($xmlWriter, $style);
}
// Child style
$styleWriter = new ShapeStyleWriter($xmlWriter, $style);
$styleWriter->write();
$xmlWriter->endElement(); // v:$type
$xmlWriter->endElement(); // w:pict
$xmlWriter->endElement(); // w:r
if (!$this->withoutP) {
$xmlWriter->endElement(); // w:p
}
}
/**
* Write arc
*
* @param \PhpOffice\PhpWord\Shared\XMLWriter $xmlWriter
* @param \PhpOffice\PhpWord\Style\Shape $style
*/
private function writeArc(XMLWriter $xmlWriter, ShapeStyle $style)
{
$points = $this->getPoints('arc', $style->getPoints());
$xmlWriter->writeAttributeIf($points['start'] !== null, 'startAngle', $points['start']);
$xmlWriter->writeAttributeIf($points['end'] !== null, 'endAngle', $points['end']);
}
/**
* Write curve
*
* @param \PhpOffice\PhpWord\Shared\XMLWriter $xmlWriter
* @param \PhpOffice\PhpWord\Style\Shape $style
*/
private function writeCurve(XMLWriter $xmlWriter, ShapeStyle $style)
{
$points = $this->getPoints('curve', $style->getPoints());
$this->writeLine($xmlWriter, $style);
$xmlWriter->writeAttributeIf($points['point1'] !== null, 'control1', $points['point1']);
$xmlWriter->writeAttributeIf($points['point2'] !== null, 'control2', $points['point2']);
}
/**
* Write line
*
* @param \PhpOffice\PhpWord\Shared\XMLWriter $xmlWriter
* @param \PhpOffice\PhpWord\Style\Shape $style
*/
private function writeLine(XMLWriter $xmlWriter, ShapeStyle $style)
{
$points = $this->getPoints('line', $style->getPoints());
$xmlWriter->writeAttributeIf($points['start'] !== null, 'from', $points['start']);
$xmlWriter->writeAttributeIf($points['end'] !== null, 'to', $points['end']);
}
/**
* Write polyline
*
* @param \PhpOffice\PhpWord\Shared\XMLWriter $xmlWriter
* @param \PhpOffice\PhpWord\Style\Shape $style
*/
private function writePolyline(XMLWriter $xmlWriter, ShapeStyle $style)
{
$xmlWriter->writeAttributeIf($style->getPoints() !== null, 'points', $style->getPoints());
}
/**
* Write rectangle
*
* @param \PhpOffice\PhpWord\Shared\XMLWriter $xmlWriter
* @param \PhpOffice\PhpWord\Style\Shape $style
*/
private function writeRoundRect(XMLWriter $xmlWriter, ShapeStyle $style)
{
$xmlWriter->writeAttribute('arcsize', $style->getRoundness());
}
/**
* Set points
*
* @param string $type
* @param array $value
* @return array
*/
private function getPoints($type, $value)
{
$points = array();
switch ($type) {
case 'arc':
case 'line':
$points = explode(' ', $value);
@list($start, $end) = $points;
$points = array('start' => $start, 'end' => $end);
break;
case 'curve':
$points = explode(' ', $value);
@list($start, $end, $point1, $point2) = $points;
$points = array('start' => $start, 'end' => $end, 'point1' => $point1, 'point2' => $point2);
break;
}
return $points;
}
}

36
src/PhpWord/Writer/Word2007/Style/AbstractStyle.php
View File

@ -102,4 +102,40 @@ abstract class AbstractStyle
return $value * $factor;
}
/**
* Write child style
*
* @param \PhpOffice\PhpWord\Shared\XMLWriter $xmlWriter
* @param string $name
* @param mixed $value
*/
protected function writeChildStyle(XMLWriter $xmlWriter, $name, $value)
{
if ($value !== null) {
$class = "PhpOffice\\PhpWord\\Writer\\Word2007\\Style\\" . $name;
/** @var \PhpOffice\PhpWord\Writer\Word2007\Style\AbstractStyle $writer */
$writer = new $class($xmlWriter, $value);
$writer->write();
}
}
/**
* Assemble style array into style string
*
* @param array $styles
* @return string
*/
protected function assembleStyle($styles = array())
{
$style = '';
foreach ($styles as $key => $value) {
if (!is_null($value) && $value != '') {
$style .= "{$key}:{$value}; ";
}
}
return trim($style);
}
}

44
src/PhpWord/Writer/Word2007/Style/Extrusion.php Normal file
View File

@ -0,0 +1,44 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer\Word2007\Style;
/**
* 3D extrusion style writer
*
* @since 0.12.0
*/
class Extrusion extends AbstractStyle
{
/**
* Write style
*/
public function write()
{
$style = $this->getStyle();
if (!$style instanceof \PhpOffice\PhpWord\Style\Extrusion) {
return;
}
$xmlWriter = $this->getXmlWriter();
$xmlWriter->startElement("o:extrusion");
$xmlWriter->writeAttribute('on', 't');
$xmlWriter->writeAttributeIf($style->getType() !== null, 'type', $style->getType());
$xmlWriter->writeAttributeIf($style->getColor() !== null, 'color', $style->getColor());
$xmlWriter->endElement();
}
}

41
src/PhpWord/Writer/Word2007/Style/Fill.php Normal file
View File

@ -0,0 +1,41 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer\Word2007\Style;
/**
* Fill style writer
*
* @since 0.12.0
*/
class Fill extends AbstractStyle
{
/**
* Write style
*/
public function write()
{
$style = $this->getStyle();
if (!$style instanceof \PhpOffice\PhpWord\Style\Fill) {
return;
}
$xmlWriter = $this->getXmlWriter();
$xmlWriter->writeAttribute('on', 't');
$xmlWriter->writeAttributeIf($style->getColor() !== null, 'fillcolor', $style->getColor());
}
}

56
src/PhpWord/Writer/Word2007/Style/Frame.php Normal file
View File

@ -0,0 +1,56 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer\Word2007\Style;
/**
* Frame style writer
*
* @since 0.12.0
*/
class Frame extends AbstractStyle
{
/**
* Write style
*/
public function write()
{
$style = $this->getStyle();
if (!$style instanceof \PhpOffice\PhpWord\Style\Frame) {
return;
}
$xmlWriter = $this->getXmlWriter();
$styles = array();
$properties = array(
'left' => 'margin-left',
'top' => 'margin-top',
'width' => 'width',
'height' => 'height',
);
foreach ($properties as $key => $property) {
$method = "get{$key}";
$value = $style->$method();
if ($value !== null) {
$styles[$property] = $style->$method() . 'pt';
}
}
$xmlWriter->writeAttribute('style', $this->assembleStyle($styles));
}
}

18
src/PhpWord/Writer/Word2007/Style/Image.php
View File

@ -152,22 +152,4 @@ class Image extends AbstractStyle
return $styles;
}
/**
* Assemble style array into style string
*
* @param array $styles
* @return string
*/
protected function assembleStyle($styles = array())
{
$style = '';
foreach ($styles as $key => $value) {
if (!is_null($value) && $value != '') {
$style .= "{$key}:{$value}; ";
}
}
return trim($style);
}
}

48
src/PhpWord/Writer/Word2007/Style/Outline.php Normal file
View File

@ -0,0 +1,48 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer\Word2007\Style;
/**
* Outline style writer
*
* @since 0.12.0
*/
class Outline extends AbstractStyle
{
/**
* Write style
*/
public function write()
{
$style = $this->getStyle();
if (!$style instanceof \PhpOffice\PhpWord\Style\Outline) {
return;
}
$xmlWriter = $this->getXmlWriter();
$xmlWriter->startElement("v:stroke");
$xmlWriter->writeAttribute('on', 't');
$xmlWriter->writeAttributeIf($style->getColor() !== null, 'color', $style->getColor());
$xmlWriter->writeAttributeIf($style->getWeight() !== null, 'weight', $style->getWeight() . 'pt');
$xmlWriter->writeAttributeIf($style->getDash() !== null, 'dashstyle', $style->getDash());
$xmlWriter->writeAttributeIf($style->getLine() !== null, 'linestyle', $style->getLine());
$xmlWriter->writeAttributeIf($style->getStartArrow() !== null, 'startarrow', $style->getStartArrow());
$xmlWriter->writeAttributeIf($style->getEndArrow() !== null, 'endarrow', $style->getEndArrow());
$xmlWriter->endElement();
}
}

18
src/PhpWord/Writer/Word2007/Style/Paragraph.php
View File

@ -110,24 +110,6 @@ class Paragraph extends AbstractStyle
}
}
/**
* Write child style
*
* @param \PhpOffice\PhpWord\Shared\XMLWriter $xmlWriter
* @param string $name
* @param mixed $value
*/
private function writeChildStyle(XMLWriter $xmlWriter, $name, $value)
{
if ($value !== null) {
$class = "PhpOffice\\PhpWord\\Writer\\Word2007\\Style\\" . $name;
/** @var \PhpOffice\PhpWord\Writer\Word2007\Style\AbstractStyle $writer */
$writer = new $class($xmlWriter, $value);
$writer->write();
}
}
/**
* Write tabs
*

44
src/PhpWord/Writer/Word2007/Style/Shadow.php Normal file
View File

@ -0,0 +1,44 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer\Word2007\Style;
/**
* Shadow style writer
*
* @since 0.12.0
*/
class Shadow extends AbstractStyle
{
/**
* Write style
*/
public function write()
{
$style = $this->getStyle();
if (!$style instanceof \PhpOffice\PhpWord\Style\Shadow) {
return;
}
$xmlWriter = $this->getXmlWriter();
$xmlWriter->startElement("v:shadow");
$xmlWriter->writeAttribute('on', 't');
$xmlWriter->writeAttributeIf($style->getColor() !== null, 'color', $style->getColor());
$xmlWriter->writeAttributeIf($style->getOffset() !== null, 'offset', $style->getOffset());
$xmlWriter->endElement();
}
}

45
src/PhpWord/Writer/Word2007/Style/Shape.php Normal file
View File

@ -0,0 +1,45 @@
<?php
/**
* This file is part of PHPWord - A pure PHP library for reading and writing
* word processing documents.
*
* PHPWord is free software distributed under the terms of the GNU Lesser
* General Public License version 3 as published by the Free Software Foundation.
*
* For the full copyright and license information, please read the LICENSE
* file that was distributed with this source code. For the full list of
* contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
*
* @link https://github.com/PHPOffice/PHPWord
* @copyright 2010-2014 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer\Word2007\Style;
/**
* Shape style writer
*
* @since 0.12.0
*/
class Shape extends AbstractStyle
{
/**
* Write style
*/
public function write()
{
$style = $this->getStyle();
if (!$style instanceof \PhpOffice\PhpWord\Style\Shape) {
return;
}
$xmlWriter = $this->getXmlWriter();
$childStyles = array('Frame', 'Fill', 'Outline', 'Shadow', 'Extrusion');
foreach ($childStyles as $childStyle) {
$method = "get{$childStyle}";
$this->writeChildStyle($xmlWriter, $childStyle, $style->$method());
}
}
}

83
tests/PhpWord/Tests/Writer/Word2007/ElementTest.php
View File

@ -41,7 +41,7 @@ class ElementTest extends \PHPUnit_Framework_TestCase
$elements = array(
'CheckBox', 'Container', 'Footnote', 'Image', 'Link', 'ListItem', 'ListItemRun',
'Object', 'PreserveText', 'Table', 'Text', 'TextBox', 'TextBreak', 'Title', 'TOC',
'Field', 'Line'
'Field', 'Line', 'Shape'
);
foreach ($elements as $element) {
$objectClass = 'PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\' . $element;
@ -61,10 +61,91 @@ class ElementTest extends \PHPUnit_Framework_TestCase
{
$phpWord = new PhpWord();
$section = $phpWord->addSection();
$section->addLine(array('width' => 1000, 'height' => 1000, 'positioning' => 'absolute', 'flip' => true));
$doc = TestHelperDOCX::getDocument($phpWord);
$element = "/w:document/w:body/w:p/w:r/w:pict/v:shapetype";
$this->assertTrue($doc->elementExists($element));
}
/**
* Test shape elements
*/
public function testShapeElements()
{
$phpWord = new PhpWord();
$section = $phpWord->addSection();
// Arc
$section->addShape(
'arc',
array(
'points' => '-90 20',
'frame' => array('width' => 120, 'height' => 120),
'outline' => array('color' => '#333333', 'weight' => 2, 'startArrow' => 'oval', 'endArrow' => 'open'),
)
);
// Curve
$section->addShape(
'curve',
array(
'points' => '1,100 200,1 1,50 200,50', 'connector' => 'elbow',
'outline' => array('color' => '#66cc00', 'weight' => 2, 'dash' => 'dash',
'startArrow' => 'diamond', 'endArrow' => 'block'),
)
);
// Line
$section->addShape(
'line',
array(
'points' => '1,1 150,30',
'outline' => array('color' => '#cc00ff', 'line' => 'thickThin', 'weight' => 3,
'startArrow' => 'oval', 'endArrow' => 'classic'),
)
);
// Polyline
$section->addShape(
'polyline',
array(
'points' => '1,30 20,10 55,20 75,10 100,40 115,50, 120,15 200,50',
'outline' => array('color' => '#cc6666', 'weight' => 2,
'startArrow' => 'none', 'endArrow' => 'classic'),
)
);
// Rectangle
$section->addShape(
'rect',
array(
'roundness' => 0.2,
'frame' => array('width' => 100, 'height' => 100, 'left' => 1, 'top' => 1),
'fill' => array('color' => '#FFCC33'),
'outline' => array('color' => '#990000', 'weight' => 1),
'shadow' => array('color' => '#EEEEEE', 'offset' => '3pt,3pt'),
)
);
// Oval
$section->addShape(
'oval',
array(
'frame' => array('width' => 100, 'height' => 70, 'left' => 1, 'top' => 1),
'fill' => array('color' => '#33CC99'),
'outline' => array('color' => '#333333', 'weight' => 2),
'extrusion' => array('type' => 'perspective', 'color' => '#EEEEEE'),
)
);
$doc = TestHelperDOCX::getDocument($phpWord);
$elements = array('arc', 'curve', 'line', 'polyline', 'roundrect', 'oval');
foreach ($elements as $element) {
$path = "/w:document/w:body/w:p/w:r/w:pict/v:{$element}";
$this->assertTrue($doc->elementExists($path));
}
}
}

2
tests/PhpWord/Tests/Writer/Word2007/StyleTest.php
View File

@ -31,7 +31,7 @@ class StyleTest extends \PHPUnit_Framework_TestCase
$styles = array(
'Alignment', 'Cell', 'Font', 'Image', 'Indentation', 'LineNumbering',
'Paragraph', 'Row', 'Section', 'Shading', 'Spacing', 'Tab', 'Table',
'TextBox', 'Line'
'TextBox', 'Line', 'Shape', 'Frame', 'Outline', 'Fill', 'Shadow', 'Extrusion',
);
foreach ($styles as $style) {
$objectClass = 'PhpOffice\\PhpWord\\Writer\\Word2007\\Style\\' . $style;