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

Merge branch 'develop' into fieldstyle

This commit is contained in:
troosan 2019-12-09 22:56:08 +01:00 committed by GitHub
parent 9b5483a1e0 733f845f8f
commit 8b2e21b634
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 162 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/elements.rst
View File

@ -359,17 +359,17 @@ The footnote numbering can be controlled by setting the FootnoteProperties on th
.. code-block:: php
$fp = new PhpWord\SimpleType\FootnoteProperties();
$fp = new \PhpOffice\PhpWord\ComplexType\FootnoteProperties();
//sets the position of the footnote (pageBottom (default), beneathText, sectEnd, docEnd)
$fp->setPos(FootnoteProperties::POSITION_DOC_END);
$fp->setPos(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::POSITION_BENEATH_TEXT);
//set the number format to use (decimal (default), upperRoman, upperLetter, ...)
$fp->setNumFmt(FootnoteProperties::NUMBER_FORMAT_LOWER_ROMAN);
$fp->setNumFmt(\PhpOffice\PhpWord\SimpleType\NumberFormat::LOWER_ROMAN);
//force starting at other than 1
$fp->setNumStart(2);
//when to restart counting (continuous (default), eachSect, eachPage)
$fp->setNumRestart(FootnoteProperties::RESTART_NUMBER_EACH_PAGE);
$fp->setNumRestart(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::RESTART_NUMBER_EACH_PAGE);
//And finaly, set it on the Section
$section->setFootnoteProperties($properties);
$section->setFootnoteProperties($fp);
Checkboxes
----------

6
docs/styles.rst
View File

@ -75,8 +75,10 @@ Available Paragraph style options:
- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values.
- ``basedOn``. Parent style.
- ``hanging``. Hanging in *twip*.
- ``indent``. Indent in *twip*.
- ``hanging``. Hanging indentation in *half inches*.
- ``indent``. Indent (left indentation) in *half inches*.
- ``indentation``. An array of indentation key => value pairs in *twip*. Supports *left*, *right*, *firstLine* and *hanging* indentation.
See ``\PhpOffice\PhpWord\Style\Indentation`` for possible identation types.
- ``keepLines``. Keep all lines on one page, *true* or *false*.
- ``keepNext``. Keep paragraph with next paragraph, *true* or *false*.
- ``lineHeight``. Text line height, e.g. *1.0*, *1.5*, etc.

17
docs/templates-processing.rst
View File

@ -244,3 +244,20 @@ See ``Sample_40_TemplateSetComplexValue.php`` for examples.
$table->addCell(150)->addText('Cell B2');
$table->addCell(150)->addText('Cell B3');
$templateProcessor->setComplexBlock('table', $table);
save
"""""""""
Saves the loaded template within the current directory. Returns the file path.
.. code-block:: php
$filepath = $templateProcessor->save();
saveAs
"""""""""
Saves a copy of the loaded template in the indicated path.
.. code-block:: php
$pathToSave = 'path/to/save/file.ext';
$templateProcessor->saveAs($pathToSave);

12
src/PhpWord/Element/Section.php
View File

@ -146,6 +146,18 @@ class Section extends AbstractContainer
*
* @return FootnoteProperties
*/
public function getFootnoteProperties()
{
return $this->footnoteProperties;
}
/**
* Get the footnote properties
*
* @deprecated Use the `getFootnoteProperties` method instead
*
* @return FootnoteProperties
*/
public function getFootnotePropoperties()
{
return $this->footnoteProperties;

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

@ -198,7 +198,7 @@ class Paragraph extends Border
{
$key = Text::removeUnderscorePrefix($key);
if ('indent' == $key || 'hanging' == $key) {
$value = $value * 720;
$value = $value * 720; // 720 twips is 0.5 inch
}
return parent::setStyleValue($key, $value);

43
src/PhpWord/Writer/HTML/Element/ListItemRun.php Normal file
View File

@ -0,0 +1,43 @@
<?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.
*
* @see https://github.com/PHPOffice/PHPWord
* @copyright 2010-2018 PHPWord contributors
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
*/
namespace PhpOffice\PhpWord\Writer\HTML\Element;
/**
* ListItem element HTML writer
*
* @since 0.10.0
*/
class ListItemRun extends TextRun
{
/**
* Write list item
*
* @return string
*/
public function write()
{
if (!$this->element instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
return '';
}
$writer = new Container($this->parentWriter, $this->element);
$content = $writer->write() . PHP_EOL;
return $content;
}
}

20
src/PhpWord/Writer/Word2007/Part/Document.php
View File

@ -126,27 +126,27 @@ class Document extends AbstractPart
$xmlWriter->endElement();
}
//footnote properties
if ($section->getFootnotePropoperties() !== null) {
// Footnote properties
if ($section->getFootnoteProperties() !== null) {
$xmlWriter->startElement('w:footnotePr');
if ($section->getFootnotePropoperties()->getPos() != null) {
if ($section->getFootnoteProperties()->getPos() != null) {
$xmlWriter->startElement('w:pos');
$xmlWriter->writeAttribute('w:val', $section->getFootnotePropoperties()->getPos());
$xmlWriter->writeAttribute('w:val', $section->getFootnoteProperties()->getPos());
$xmlWriter->endElement();
}
if ($section->getFootnotePropoperties()->getNumFmt() != null) {
if ($section->getFootnoteProperties()->getNumFmt() != null) {
$xmlWriter->startElement('w:numFmt');
$xmlWriter->writeAttribute('w:val', $section->getFootnotePropoperties()->getNumFmt());
$xmlWriter->writeAttribute('w:val', $section->getFootnoteProperties()->getNumFmt());
$xmlWriter->endElement();
}
if ($section->getFootnotePropoperties()->getNumStart() != null) {
if ($section->getFootnoteProperties()->getNumStart() != null) {
$xmlWriter->startElement('w:numStart');
$xmlWriter->writeAttribute('w:val', $section->getFootnotePropoperties()->getNumStart());
$xmlWriter->writeAttribute('w:val', $section->getFootnoteProperties()->getNumStart());
$xmlWriter->endElement();
}
if ($section->getFootnotePropoperties()->getNumRestart() != null) {
if ($section->getFootnoteProperties()->getNumRestart() != null) {
$xmlWriter->startElement('w:numRestart');
$xmlWriter->writeAttribute('w:val', $section->getFootnotePropoperties()->getNumRestart());
$xmlWriter->writeAttribute('w:val', $section->getFootnoteProperties()->getNumRestart());
$xmlWriter->endElement();
}
$xmlWriter->endElement();

16
tests/PhpWord/MediaTest.php
View File

@ -34,6 +34,22 @@ class MediaTest extends AbstractWebServerEmbeddedTest
$this->assertEquals(array(), Media::getElements('section'));
}
/**
* Get header media elements
*/
public function testGetHeaderMediaElementsWithNull()
{
$this->assertEquals(array(), Media::getElements('header'));
}
/**
* Get footer media elements
*/
public function testGetFooterMediaElementsWithNull()
{
$this->assertEquals(array(), Media::getElements('footer'));
}
/**
* Count section media elements
*/

9
tests/PhpWord/PhpWordTest.php
View File

@ -225,4 +225,13 @@ class PhpWordTest extends \PHPUnit\Framework\TestCase
$this->assertEquals(2, $phpWord->getSection(0)->countElements());
$this->assertEquals(1, $phpWord->getSection(1)->countElements());
}
/**
* @covers \PhpOffice\PhpWord\PhpWord::getSettings
*/
public function testGetSettings()
{
$phpWord = new PhpWord();
$this->assertInstanceOf('PhpOffice\\PhpWord\\Metadata\\Settings', $phpWord->getSettings());
}
}

18
tests/PhpWord/StyleTest.php
View File

@ -33,6 +33,7 @@ class StyleTest extends \PHPUnit\Framework\TestCase
* @covers ::addParagraphStyle
* @covers ::addFontStyle
* @covers ::addLinkStyle
* @covers ::addNumberingStyle
* @covers ::addTitleStyle
* @covers ::addTableStyle
* @covers ::setDefaultParagraphStyle
@ -47,6 +48,20 @@ class StyleTest extends \PHPUnit\Framework\TestCase
$paragraph = array('alignment' => Jc::CENTER);
$font = array('italic' => true, '_bold' => true);
$table = array('bgColor' => 'CCCCCC');
$numbering = array(
'type' => 'multilevel',
'levels' => array(
array(
'start' => 1,
'format' => 'decimal',
'restart' => 1,
'suffix' => 'space',
'text' => '%1.',
'alignment' => Jc::START,
),
),
);
$styles = array(
'Paragraph' => 'Paragraph',
'Font' => 'Font',
@ -54,12 +69,13 @@ class StyleTest extends \PHPUnit\Framework\TestCase
'Table' => 'Table',
'Heading_1' => 'Font',
'Normal' => 'Paragraph',
'Numbering' => 'Numbering',
);
Style::addParagraphStyle('Paragraph', $paragraph);
Style::addFontStyle('Font', $font);
Style::addLinkStyle('Link', $font);
// @todo Style::addNumberingStyle
Style::addNumberingStyle('Numbering', $numbering);
Style::addTitleStyle(1, $font);
Style::addTableStyle('Table', $table);
Style::setDefaultParagraphStyle($paragraph);

27
tests/PhpWord/Writer/HTML/ElementTest.php
View File

@ -34,7 +34,7 @@ class ElementTest extends \PHPUnit\Framework\TestCase
*/
public function testUnmatchedElements()
{
$elements = array('Container', 'Footnote', 'Image', 'Link', 'ListItem', 'Table', 'Title', 'Bookmark');
$elements = array('Container', 'Footnote', 'Image', 'Link', 'ListItem', 'ListItemRun', 'Table', 'Title', 'Bookmark');
foreach ($elements as $element) {
$objectClass = 'PhpOffice\\PhpWord\\Writer\\HTML\\Element\\' . $element;
$parentWriter = new HTML();
@ -163,6 +163,31 @@ class ElementTest extends \PHPUnit\Framework\TestCase
$this->assertContains($expected, $content);
}
/**
* Test write element ListItemRun
*/
public function testListItemRun()
{
$expected1 = 'List item run 1';
$expected2 = 'List item run 1 in bold';
$phpWord = new PhpWord();
$section = $phpWord->addSection();
$listItemRun = $section->addListItemRun(0, null, 'MyParagraphStyle');
$listItemRun->addText($expected1);
$listItemRun->addText($expected2, array('bold' => true));
$htmlWriter = new HTML($phpWord);
$content = $htmlWriter->getContent();
$dom = new \DOMDocument();
$dom->loadHTML($content);
$this->assertEquals($expected1, $dom->getElementsByTagName('p')->item(0)->textContent);
$this->assertEquals($expected2, $dom->getElementsByTagName('p')->item(1)->textContent);
}
/**
* Tests writing table with layout
*/

1
tests/PhpWord/_includes/AbstractWebServerEmbeddedTest.php
View File

@ -27,6 +27,7 @@ abstract class AbstractWebServerEmbeddedTest extends \PHPUnit\Framework\TestCase
{
if (self::isBuiltinServerSupported()) {
$commandLine = 'php -S localhost:8080 -t tests/PhpWord/_files';
/*
* Make sure to invoke \Symfony\Component\Process\Process correctly
* regardless of PHP version used.