Skip to content

Add elements to PHPWord object via html #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 10, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions samples/Sample_26_Html.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?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();
$html='<h1>Adding element via HTML</h1>';
$html.='<p>Some well formed HTML snippet needs to be used</p>';
$html.='<p>With for example <strong>some <em>inline</em> formatting</strong>';

\PhpOffice\PhpWord\Shared\Html::addHtml($section, $html);

// Save file
echo write($phpWord, basename(__FILE__, '.php'), $writers);
if (!CLI) {
include_once 'Sample_Footer.php';
}
15 changes: 15 additions & 0 deletions src/PhpWord/Element/TextBox.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,19 @@ public function getStyle()
{
return $this->style;
}

/**
* Add table element
*
* @param mixed $style
* @return \PhpOffice\PhpWord\Element\Table
* @todo Merge with the same function on Footer
*/
public function addTable($style = null)
{
$table = new Table($this->getDocPart(), $this->getDocPartId(), $style);
$this->addElement($table);

return $table;
}
}
228 changes: 228 additions & 0 deletions src/PhpWord/Shared/Html.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,228 @@
<?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\Shared;

/**
* Common Html functions
*/
class Html
{

/**
* add HTML parts
*
* @param $object where the parts need to be added
* @param $html the code to parse
*
*/
public static function addHtml($object, $html, $stylesheet = '')
{
/*
* @todo parse $stylesheet for default styles. Should result in an array based on id, class and element,
* which could be applied when such an element occurs in the parseNode function.
*/
$html = str_replace(array("\n","\r"), '', $html);

$dom = new \DOMDocument();
$dom->preserveWhiteSpace = true;
$dom->loadXML('<body>' . html_entity_decode($html) . '</body>');

$node = $dom->getElementsByTagName('body');

self::parseNode($node->item(0), $object);
}

/**
* parse Inline style of a node
*
* @param $node node to check on attributes and to compile a style array
* @param $style is supplied, the inline style attributes are added to the already existing style
*
*/
protected static function parseInlineStyle($node, $style = array())
{
if ($node->nodeType == XML_ELEMENT_NODE) {
$attributes = $node->attributes; // get all the attributes(eg: id, class)

foreach ($attributes as $attribute) {
switch ($attribute->name) {
case 'style':
$properties = explode(';', trim($attribute->value, " \t\n\r\0\x0B;"));
foreach ($properties as $property) {
list ($cKey, $cValue) = explode(':', $property, 2);
$cValue = trim($cValue);
switch (trim($cKey)) {
case 'text-decoration':
switch ($cValue) {
case 'underline':
$style['underline'] = 'single';
break;
case 'line-through':
$style['strikethrough'] = true;
break;
}
break;
case 'text-align':
$style['align'] = $cValue;
break;
case 'color':
$style['color'] = trim($cValue, "#");
break;
case 'background-color':
$style['bgColor'] = trim($cValue, "#");
break;
}
}
break;
}
}
}
return $style;
}

/**
* parse a node and add a corresponding element to the object
*
* @param $node node to parse
* @param $object object to add an element corresponding with the node
* @param $styles array with all styles
* @param $data array to transport data to a next level in the DOM tree, for example level of listitems
*
*/
protected static function parseNode($node, $object, $styles = array('fontStyle' => array(), 'paragraphStyle' => array(), 'listStyle' => array()), $data = array())
{
$newobject = null;
switch ($node->nodeName) {
case 'p':
$styles['paragraphStyle'] = self::parseInlineStyle($node, $styles['paragraphStyle']);
$newobject = $object->addTextRun($styles['paragraphStyle']);
break;

/*
* @todo Think of a clever way of defining header styles, now it is only based on the assumption, that
* Heading1 - Heading6 are already defined somewhere
*/
case 'h1':
$styles['paragraphStyle'] = 'Heading1';
$newobject = $object->addTextRun($styles['paragraphStyle']);
break;
case 'h2':
$styles['paragraphStyle'] = 'Heading2';
$newobject = $object->addTextRun($styles['paragraphStyle']);
break;
case 'h3':
$styles['paragraphStyle'] = 'Heading3';
$newobject = $object->addTextRun($styles['paragraphStyle']);
break;
case 'h4':
$styles['paragraphStyle'] = 'Heading4';
$newobject = $object->addTextRun($styles['paragraphStyle']);
break;
case 'h5':
$styles['paragraphStyle'] = 'Heading5';
$newobject = $object->addTextRun($styles['paragraphStyle']);
break;
case 'h6':
$styles['paragraphStyle'] = 'Heading6';
$newobject = $object->addTextRun($styles['paragraphStyle']);
break;
case '#text':
$styles['fontStyle'] = self::parseInlineStyle($node, $styles['fontStyle']);
$object->AddText($node->nodeValue, $styles['fontStyle'], $styles['paragraphStyle']);
break;
case 'strong':
$styles['fontStyle']['bold'] = true;
break;
case 'em':
$styles['fontStyle']['italic'] = true;
break;
case 'sup':
$styles['fontStyle']['superScript'] = true;
break;
case 'sub':
$styles['fontStyle']['subScript'] = true;
break;

/*
* @todo As soon as TableItem, RowItem and CellItem support relative width and height
*/
case 'table':
$styles['paragraphStyle'] = self::parseInlineStyle($node, $styles['paragraphStyle']);
$newobject = $object->addTable();
// if ($attributes->getNamedItem('width') !== null)$newobject->setWidth($attributes->getNamedItem('width')->value);
break;
case 'tr':
$styles['paragraphStyle'] = self::parseInlineStyle($node, $styles['paragraphStyle']);
$newobject = $object->addRow();
// if ($attributes->getNamedItem('height') !== null)$newobject->setHeight($attributes->getNamedItem('height')->value);
break;
case 'td':
$styles['paragraphStyle'] = self::parseInlineStyle($node, $styles['paragraphStyle']);
// if ($attributes->getNamedItem('width') !== null)$newobject=$object->addCell($width=$attributes->getNamedItem('width')->value);
// else $newobject=$object->addCell();
$newobject = $object->addCell();
break;
case 'ul':
if (isset($data['listdepth'])) {
$data['listdepth'] ++;
} else {
$data['listdepth'] = 0;
}
$styles['listStyle']['listType'] = 3; // TYPE_BULLET_FILLED = 3;
break;
case 'ol':
if (isset($data['listdepth'])) {
$data['listdepth'] ++;
} else {
$data['listdepth'] = 0;
}
$styles['listStyle']['listType'] = 7; // TYPE_NUMBER = 7;
break;

/*
* @todo As soon as ListItem inherits from AbstractContainer or TextRun delete parsing part of childNodes
*/
case 'li':
$cNodes = $node->childNodes;
if (count($cNodes) > 0) {
foreach ($cNodes as $cNode) {
if ($cNode->nodeName == '#text') {
$text = $cNode->nodeValue;
}
}
$object->addListItem($text, $data['listdepth'], $styles['fontStyle'], $styles['listStyle'], $styles['paragraphStyle']);
}
}

if ($newobject === null) {
$newobject = $object;
}

/*
* @todo As soon as ListItem inherits from AbstractContainer or TextRun delete condition
*/
if ($node->nodeName != 'li') {
$cNodes = $node->childNodes;
if (count($cNodes) > 0) {
foreach ($cNodes as $cNode) {
self::parseNode($cNode, $newobject, $styles, $data);
}
}
}
}
}
2 changes: 0 additions & 2 deletions src/PhpWord/Writer/Word2007/Element/TextBox.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,7 @@ public function write()
$margins = implode(', ', $tbxStyle->getInnerMargin());
$this->xmlWriter->writeAttribute('inset', $margins);
$this->xmlWriter->startElement('w:txbxContent');
$this->xmlWriter->startElement('w:p');
$this->parentWriter->writeContainerElements($this->xmlWriter, $this->element);
$this->xmlWriter->endElement(); // w:p
$this->xmlWriter->endElement(); // w:txbxContent
$this->xmlWriter->endElement(); // v: textbox
$styleWriter->writeW10Wrap();
Expand Down
2 changes: 1 addition & 1 deletion src/PhpWord/Writer/Word2007/Part/AbstractPart.php
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public function writeContainerElements(XMLWriter $xmlWriter, AbstractElement $co

// Loop through elements
$elements = $container->getElements();
$withoutP = in_array($containerName, array('TextRun', 'Footnote', 'Endnote', 'TextBox')) ? true : false;
$withoutP = in_array($containerName, array('TextRun', 'Footnote', 'Endnote')) ? true : false;
if (count($elements) > 0) {
foreach ($elements as $element) {
if ($element instanceof AbstractElement) {
Expand Down