addFootnote

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

addFootnote

TRIAL / ADVANCED / PREMIUM

Inserts a footnote into the Word document.

Description

public addFootnote ( array $options )

This method allows the insertion of a footnote into the Word document.

You may fully customize the footnote content including all kind of elements like paragraphs of text with sophisticated formatting, images, links or even tables and HTML content.

If one wishes to insert a footnote within a complex paragraph one should use this method in combination with the addText method.

Parameters

options

An array with the available options.

The possible keys and values are:

Key	Type	Description
textDocument	mixed	This can be a string of text or a WordFragment that will appear in the Word document just before the footnote call or an array with the text and the formatting options (as in the addText method) or a Word fragment.
textFootnote	mixed	This is a string of text that will show up in the corresponding footnote or a WordFragment that may include a variety of elements.
textFootnotes	array	Add multiple footnotes.
footnoteMark	array	The keys of this array are: 'customMark': a special character, if any, that you would like to use for the call to the footnote content. 'font': the font family you wish to use (Arial, Calibri...). 'bold': true or false for bold text. 'bidi': true for right to left languages. 'italic': true or false to turn on italics. 'color': an hexadecimal color ('000000', 'FF0000'...). 'rtl': true for right to left languages. 'highlightColor': black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray, none. 'underline': underlines text: single. 'backgroundColor': an hexadecimal color.
referenceMark	array	The keys of this array are: 'font': the font family you wish to use (Arial, Calibri...). 'bold': true or false for bold text. 'bidi': true for right to left languages. 'italic': true or false to turn on italics. 'color': an hexadecimal color ('000000', 'FF0000'...). 'rtl': true for right to left languages. 'highlightColor': black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray, none. 'underline': underlines text: single. 'backgroundColor': an hexadecimal color.
pStyle	string	Paragraph style. Default as footnoteTextPHPDOCX.
rStyle	string	Character style. Default as footnoteReferencePHPDOCX.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$footnote = new WordFragment($docx, 'document');
$footnote->addFootnote(
    array(
        'textDocument' => 'footnote',
        'textFootnote' => 'The footnote we want to insert.',
    )
);

$text = array();
$text[] = array('text' => 'Here comes the ');
$text[] = $footnote;
$text[] = array('text' => ' and some other text.');
$docx->addText($text);
$docx->addText('Some other text.');

$docx->createDocx('output');

The resulting Word document looks like:

Example #2

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$footnote = new WordFragment($docx, 'document');

$html = new WordFragment($docx, 'footnote'); // notice the different "target"
$htmlCode = '<p>This is some HTML code with a link to <a href="http://www.2mdc.com">2mdc.com</a> and a random image:
<img src="/img/image.png" width="35" height="35" style="vertical-align: middle"></p>';
$html->embedHTML($htmlCode, array('downloadImages' => true));

$footnote->addFootnote(
    array(
        'textDocument' => 'footnote',
        'textFootnote' => $html,
        'footnoteMark' => array('customMark' => '*')
    )
);

$text = array();
$text[] = array('text' => 'Here comes the ');
$text[] = $footnote;
$text[] = array('text' => ' and some other text.');

$docx->addText($text);

$docx->addText('Some other text.');

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 14.5:
- internal IDs set using sequential unique values.

phpdocx 14.0:
- highlight, underline and backgroundColor mark options.

phpdocx 13.5:
- WordFragments in textDocument.
- pStyle and rStyle options.

phpdocx 12.5:
- multiple endnotes in the same content.

phpdocx 12.0:
- htmlspecialchars applied in textFootnote option.