searchAndColor

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

searchAndColor

ADVANCED / PREMIUM

TRIAL

Searches for keywords within a Word document and colors them.

Description

public searchAndColor (string $source, string $target, string $search [, array $options])

This method colors plain text in a DOCX document.

Parameters

Source

The path to the source Word document.

target

The path to the Word document output.

The string of text or array that you want to color.

options

The possible keys and values are:

Key	Type	Description
color	string	FF0000, BDAD00...
document	bool	If true colors the search string in the body of the document. The default value is true.
endnotes	bool	If true colors the search string in the document endnotes. The default value is false.
comments	bool	If true colors the search string in the document comments. The default value is false.
headersAndFooters	bool	If true colors the search string in headers and footers. The default value is false.
footnotes	bool	If true colors the search string in the document footnotes. The default value is false.
headers	bool	If true colors the search string in headers. The default value is false.
footers	bool	If true colors the search string in footers. The default value is false.

Exceptions

Error while trying to open the (base) template as a zip file.

Code samples

Example #1

require_once 'classes/DocxUtilities.php';

$docx = new DocxUtilities();

$options = array(
    'color' => 'FF0000',
    'document' => true,
    'endnotes' => true,
    'comments' => true,
    'headersAndFooters' => true,
    'footnotes' => true,
);

$docx->searchAndColor('document.docx', 'output.docx', 'data', $options);

The resulting Word document looks like: