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

Merge pull request #1776 from mdupont/footnotes-typo 

Fix documentation and method name for FootnoteProperties
This commit is contained in:
troosan 2019-12-09 21:08:39 +01:00 committed by GitHub
parent dfea4e12a6 cb3e211135
commit 733f845f8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 27 additions and 15 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 .. 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) //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, ...) //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 //force starting at other than 1
$fp->setNumStart(2); $fp->setNumStart(2);
//when to restart counting (continuous (default), eachSect, eachPage) //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 //And finaly, set it on the Section
$section->setFootnoteProperties($properties); $section->setFootnoteProperties($fp);
Checkboxes Checkboxes
---------- ----------

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

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

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

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