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

Merge branch 'sdt' into develop

This commit is contained in:
Ivan Lanin 2014-06-28 11:49:11 +07:00
parent a5c857f749 b5a63c5b55
commit 2d351c9522
6 changed files with 291 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -20,6 +20,7 @@ This release added form fields (textinput, checkbox, and dropdown), drawing shap
- FormField: Ability to add textinput, checkbox, and dropdown form elements - @ivanlanin GH-266
- Setting: Ability to define document protection (readOnly, comments, trackedChanges, forms) - @ivanlanin
- Setting: Ability to remove [Compatibility Mode] text in the MS Word title bar - @ivanlanin
- SDT: Ability to add structured document tag elements (comboBox, dropDownList, date) - @ivanlanin
### Bugfixes

26
samples/Sample_34_SDT.php Normal file
View File

@ -0,0 +1,26 @@
<?php
include_once 'Sample_Header.php';
// New Word document
echo date('H:i:s'), " Create new PhpWord object", EOL;
$phpWord = new \PhpOffice\PhpWord\PhpWord();
$section = $phpWord->addSection();
$textrun = $section->addTextRun();
$textrun->addText('Combobox: ');
$textrun->addSDT('comboBox')->setListItems(array('1' => 'Choice 1', '2' => 'Choice 2'));
$textrun = $section->addTextRun();
$textrun->addText('Date: ');
$textrun->addSDT('date');
$textrun = $section->addTextRun();
$textrun->addText('Drop down list: ');
$textrun->addSDT('dropDownList')->setListItems(array('1' => 'Choice 1', '2' => 'Choice 2'));
// Save file
echo write($phpWord, basename(__FILE__, '.php'), $writers);
if (!CLI) {
include_once 'Sample_Footer.php';
}

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

@ -43,6 +43,7 @@ namespace PhpOffice\PhpWord\Element;
* @method Shape addObject(string $type, mixed $style = null)
* @method Chart addChart(string $type, array $categories, array $values, array $style = null)
* @method FormField addFormField(string $type, mixed $fStyle = null, mixed $pStyle = null)
* @method SDT addSDT(string $type)
*
* @since 0.10.0
*/
@ -79,7 +80,7 @@ abstract class AbstractContainer extends AbstractElement
$elements = array('Text', 'TextRun', 'Link', 'PreserveText', 'TextBreak',
'ListItem', 'ListItemRun', 'Table', 'Image', 'Object', 'Footnote',
'Endnote', 'CheckBox', 'TextBox', 'Field', 'Line', 'Shape',
'Title', 'TOC', 'PageBreak', 'Chart', 'FormField');
'Title', 'TOC', 'PageBreak', 'Chart', 'FormField', 'SDT');
$functions = array();
for ($i = 0; $i < count($elements); $i++) {
$functions[$i] = 'add' . $elements[$i];
@ -192,6 +193,7 @@ abstract class AbstractContainer extends AbstractElement
'Line' => $allContainers,
'Shape' => $allContainers,
'FormField' => $allContainers,
'SDT' => $allContainers,
'TextRun' => array('Section', 'Header', 'Footer', 'Cell', 'TextBox'),
'ListItem' => array('Section', 'Header', 'Footer', 'Cell', 'TextBox'),
'ListItemRun' => array('Section', 'Header', 'Footer', 'Cell', 'TextBox'),

130
src/PhpWord/Element/SDT.php Normal file
View File

@ -0,0 +1,130 @@
<?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;
/**
* Structured document tag (SDT) element
*
* @since 0.12.0
*/
class SDT extends Text
{
/**
* Form field type: comboBox|dropDownList|date
*
* @var string
*/
private $type;
/**
* Value
*
* @var string|bool|int
*/
private $value;
/**
* CheckBox/DropDown list entries
*
* @var array
*/
private $listItems = array();
/**
* Create new instance
*
* @param string $type
* @param mixed $fontStyle
* @param mixed $paragraphStyle
* @return self
*/
public function __construct($type, $fontStyle = null, $paragraphStyle = null)
{
$this->setType($type);
}
/**
* Get type
*
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* Set type
*
* @param string $value
* @return self
*/
public function setType($value)
{
$enum = array('comboBox', 'dropDownList', 'date');
$this->type = $this->setEnumVal($value, $enum, $this->type);
return $this;
}
/**
* Get value
*
* @return string|bool|int
*/
public function getValue()
{
return $this->value;
}
/**
* Set value
*
* @param string|bool|int $value
* @return self
*/
public function setValue($value)
{
$this->value = $value;
return $this;
}
/**
* Get listItems
*
* @return array
*/
public function getListItems()
{
return $this->listItems;
}
/**
* Set listItems
*
* @param array $value
* @return self
*/
public function setListItems($value)
{
$this->listItems = $value;
return $this;
}
}

110
src/PhpWord/Writer/Word2007/Element/SDT.php Normal file
View File

@ -0,0 +1,110 @@
<?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\Element\SDT as SDTElement;
use PhpOffice\PhpWord\Shared\XMLWriter;
/**
* Structured document tag element writer
*
* @since 0.12.0
* @link http://www.datypic.com/sc/ooxml/t-w_CT_SdtBlock.html
*/
class SDT extends Text
{
/**
* Write element
*/
public function write()
{
$xmlWriter = $this->getXmlWriter();
$element = $this->getElement();
if (!$element instanceof SDTElement) {
return;
}
$type = $element->getType();
$writeFormField = "write{$type}";
$this->startElementP();
$xmlWriter->startElement('w:sdt');
// Properties
$xmlWriter->startElement('w:sdtPr');
$xmlWriter->writeElementBlock('w:id', 'w:val', rand(100000000, 999999999));
$xmlWriter->writeElementBlock('w:lock', 'w:val', 'sdtLocked');
$this->$writeFormField($xmlWriter, $element);
$xmlWriter->endElement(); // w:sdtPr
// Content
$xmlWriter->startElement('w:sdtContent');
$xmlWriter->startElement('w:r');
$xmlWriter->startElement('w:t');
$xmlWriter->writeRaw('Pick value');
$xmlWriter->endElement(); // w:t
$xmlWriter->endElement(); // w:r
$xmlWriter->endElement(); // w:sdtContent
$xmlWriter->endElement(); // w:sdt
$this->endElementP(); // w:p
}
/**
* Write combo box
*
* @link http://www.datypic.com/sc/ooxml/t-w_CT_SdtComboBox.html
*/
private function writeComboBox(XMLWriter $xmlWriter, SDTElement $element)
{
$type = $element->getType();
$listItems = $element->getListItems();
$xmlWriter->startElement("w:{$type}");
foreach ($listItems as $key => $val) {
$xmlWriter->writeElementBlock('w:listItem', array('w:value' => $key, 'w:displayText' => $val));
}
$xmlWriter->endElement(); // w:{$type}
}
/**
* Write drop down list
*
* @link http://www.datypic.com/sc/ooxml/t-w_CT_SdtDropDownList.html
*/
private function writeDropDownList(XMLWriter $xmlWriter, SDTElement $element)
{
$this->writecomboBox($xmlWriter, $element);
}
/**
* Write date
*
* @link http://www.datypic.com/sc/ooxml/t-w_CT_SdtDate.html
*/
private function writeDate(XMLWriter $xmlWriter, SDTElement $element)
{
$xmlWriter->startElement("w:date");
$xmlWriter->writeElementBlock('w:dateFormat', 'w:val', 'd/M/yyyy');
$xmlWriter->writeElementBlock('w:lid', 'w:val', 'en-US');
$xmlWriter->writeElementBlock('w:storeMappedDataAs', 'w:val', 'dateTime');
$xmlWriter->writeElementBlock('w:calendar', 'w:val', 'gregorian');
$xmlWriter->endElement(); // w:date
}
}

22
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', 'Shape', 'Chart'
'Field', 'Line', 'Shape', 'Chart', 'FormField', 'SDT'
);
foreach ($elements as $element) {
$objectClass = 'PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\' . $element;
@ -196,4 +196,24 @@ class ElementTest extends \PHPUnit_Framework_TestCase
$this->assertTrue($doc->elementExists($path . '/w:checkBox'));
$this->assertTrue($doc->elementExists($path . '/w:ddList'));
}
/**
* Test SDT elements
*/
public function testSDTElements()
{
$phpWord = new PhpWord();
$section = $phpWord->addSection();
$section->addSDT('comboBox');
$section->addSDT('dropDownList');
$section->addSDT('date');
$doc = TestHelperDOCX::getDocument($phpWord);
$path = "/w:document/w:body/w:p/w:sdt/w:sdtPr";
$this->assertTrue($doc->elementExists($path . '/w:comboBox'));
$this->assertTrue($doc->elementExists($path . '/w:dropDownList'));
$this->assertTrue($doc->elementExists($path . '/w:date'));
}
}