addBibliography

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

addBibliography

ADVANCED / PREMIUM

TRIAL

Inserts a bibliography into the Word document.

Description

public addBibliography ( [array $options [, array $legend]] )

This method allows to include a bibliography in the Word document.

New contents to be displayed in a bibliography can be added using addSource and addCitation methods.

Parameters

options

The possible keys and values are:

Key	Type	Description
autoUpdate	boolean	If true it will try to update the bibliography when first opened.

legend

The possible keys and values are:

Key	Type	Description
text	string	The placeholder text that will be shown if the autoupdate option is not activated.
		Styles from addText.

Exceptions

Method not available.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$author = array(
    'Author' => array(
        array(
            'Last' => 'Doe',
            'First' => 'John',
        ),
        array(
            'Last' => 'Doe',
            'First' => 'Jane',
        ),
    ),
);
$info = array(
    'Title' => 'My book',
    'Year' => '2021',
    'City' => 'My city',
    'Publisher' => 'My publisher',
);

$docx->addSource('JDoe', 'Report', $author, $info);

$author = array(
    'Author' => array(
        array(
            'Last' => 'Eod',
            'First' => 'John',
        ),
    ),
);
$info = array(
    'Title' => 'My book 2',
    'Year' => '2022',
    'City' => 'My city 2',
    'Publisher' => 'My publisher 2',
);

$docx->addSource('JEod', 'Book', $author, $info);

$docx->addCitation('JDoe');

$docx->addText('Lorem ipsum dolor sit amet, consectetur adipisicing elit.');

$docx->addCitation('JEod', array('Author', 'City', 'Title'), array('bold' => true, 'fontSize' => 18));

$citation = new WordFragment($docx);
$citation->addCitation('JEod', array('Author', 'City'), array('bold' => true));

$text = array();
$text[] = array(
    'text' => 'Citation added as WordFragment: '
);
$text[] = $citation;
$text[] = array(
    'text' => '.'
);

$docx->addText($text);

$legend = array(
    'text' => 'Document bibliography',
    'color' => 'B70000',
    'bold' => true,
    'fontSize' => 12,
);

$docx->addBibliography(array('autoUpdate' => true), $legend);

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 12.0:
- new method.