Snippets

INTRODUCTION

PRACTICAL PHPDOCX

CONVERSION PLUGIN

COOKBOOK

SNIPPETS

API DOCUMENTATION

HTML API DOCUMENTATION

JAVASCRIPT API DOCUMENTATION

XML API DOCUMENTATION

CASE STUDIES

Add a footnote and other block contents as inline contents using HTML Extended

To accomplish this task, the code can use a placeholder that is replaced with a new WordFragment or the data-type attribute set as 'inline'.

The same snippets can be used when working with HTML Extended and footnotes, comments and endnotes changing the tag name and its properties if needed.

Using a placeholder that is replaced with a new WordFragment:

$html = '
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <table>
        <tbody>
        <tr>
            <td>
                Other text: $FOOTNOTE$
            </td>
        </tr>
        </tbody>
    </table>
</body>
</html>
';
$docx->embedHTML($html, array('useHTMLExtended' => true));

// generate the DOCX as in-memory document to avoid creating a file
CreateDocx::$returnDocxStructure = true;

$documentStructure = $docx->createDocx();

$docxNew = new CreateDocxFromTemplate($documentStructure);

$footnote_html = '
<phpdocx_footnote>
    Some text here and ...
    <phpdocx_footnote_textdocument data-text=" note" data-bold="false" />
    <phpdocx_footnote_textfootnote>
        <p>footnote data</p>
    </phpdocx_footnote_textfootnote>
</phpdocx_footnote>';
$footnote = new WordFragment($docxNew, 'document');
$footnote->embedHTML($footnote_html, array('useHTMLExtended' => true));

$docxNew->replaceVariableByWordFragment(array('FOOTNOTE' => $footnote), array('type' => 'inline'));

CreateDocx::$returnDocxStructure = false;

Using the data-type="inline" attribute:

// as inline contents. Comments, endnotes and footnotes are 'block' as default, set their tags as inline before transforming the HTML contents
unset(HTMLExtended::$tagsBlock['phpdocx_comment']);
unset(HTMLExtended::$tagsBlock['phpdocx_comment_textcomment']);
HTMLExtended::$tagsInline['phpdocx_comment'] = 'addComment';
HTMLExtended::$tagsInline['phpdocx_comment_textcomment'] = 'addCommentTextComment';
unset(HTMLExtended::$tagsBlock['phpdocx_endnote']);
unset(HTMLExtended::$tagsBlock['phpdocx_endnote_textendnote']);
HTMLExtended::$tagsInline['phpdocx_endnote'] = 'addEndnote';
HTMLExtended::$tagsInline['phpdocx_endnote_textendnote'] = 'addEndnoteTextEndnote';
unset(HTMLExtended::$tagsBlock['phpdocx_footnote']);
unset(HTMLExtended::$tagsBlock['phpdocx_footnote_textfootnote']);
HTMLExtended::$tagsInline['phpdocx_footnote'] = 'addFootnote';
HTMLExtended::$tagsInline['phpdocx_footnote_textfootnote'] = 'addFootnoteTextFootnote';

$html = '
    <p>Inline comments:
        <phpdocx_comment data-type="inline" data-author="phpdocx">
            <phpdocx_comment_textdocument data-text=" my comment " data-italic="true" />
            <phpdocx_comment_textcomment>Content comment</phpdocx_comment_textcomment>
        </phpdocx_comment>
        and
        <phpdocx_comment data-type="inline">
            <phpdocx_comment_textdocument data-text=" other comment " data-italic="true" />
            <phpdocx_comment_textcomment data-author="c_author 1">Other <b>comment content</b></phpdocx_comment_textcomment>
            <phpdocx_comment_textcomment data-author="c_author 2">Multiple comment in the same string</b></phpdocx_comment_textcomment>
        </phpdocx_comment>
    </p>
    <p>Inline endnotes:
        <phpdocx_endnote data-type="inline">
            <phpdocx_endnote_textdocument data-text=" my endnote " data-italic="true" />
            <phpdocx_endnote_textendnote>Content endnote</phpdocx_endnote_textendnote>
        </phpdocx_endnote>
        and
        <phpdocx_endnote data-type="inline">
            <phpdocx_endnote_textdocument data-text=" other endnote " data-italic="true" />
            <phpdocx_endnote_textendnote>Other <b>endnote content</b></phpdocx_endnote_textendnote>
            <phpdocx_endnote_textendnote>Multiple endnote in the same string</b></phpdocx_endnote_textendnote>
        </phpdocx_endnote>
    </p>
    <p>Inline footnotes:
        <phpdocx_footnote data-type="inline">
            <phpdocx_footnote_textdocument data-text=" my footnote " data-italic="true" />
            <phpdocx_footnote_textfootnote>Content footnote</phpdocx_footnote_textfootnote>
        </phpdocx_footnote>
        and
        <phpdocx_footnote data-type="inline">
            <phpdocx_footnote_textdocument data-text=" other footnote " data-italic="true" />
            <phpdocx_footnote_textfootnote>Other <b>footnote content</b></phpdocx_footnote_textfootnote>
            <phpdocx_footnote_textfootnote>Multiple footnote in the same string</b></phpdocx_footnote_textfootnote>
        </phpdocx_footnote>
    </p>
';

$docx->embedHTML($html, array('useHTMLExtended' => true));