searchAndHighlight

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

searchAndHighlight

ADVANCED / PREMIUM

TRIAL

Searches for keywords within a Word document and highlights them.

Description

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

This method allows the highlighting of plain text in a DOCX document.

This method doesn't use the template engine included in phpdocx. We recommend using replaceVariableByWordFragment to do text replacements applying styles.

Parameters

Source

The path to the source Word document.

target

The path to the Word document resulting after the text highlighting.

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

options

The possible keys and values are:

Key	Type	Description
highlightColor	string	the color used for the highlighting: black blue cyan green magenta red yellow white darkBlue darkCyan darkGreen darkMagenta darkRed darkYellow darkGray lightGray none The default value is ‘yellow’.
document	bool	If true highlights the search string in the body of the document. The default value is true.
endnotes	bool	If true highlights the search string in the document endnotes. The default value is false.
comments	bool	If true highlights the search string in the document comments. The default value is false.
headersAndFooters	bool	If true highlights the search string in headers and footers. The default value is false.
footnotes	bool	If true highlights the search string in the document footnotes. The default value is false.
headers	bool	If true highlights the search string in headers. The default value is false.
footers	bool	If true highlights 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(
    'highlightColor' => 'green',
    'document' => true,
    'endnotes' => true,
    'comments' => true,
    'headersAndFooters' => true,
    'footnotes' => true,
);

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- htmlspecialchars applied in the search value.

phpdocx 14.0:
- return DOCXStructure.

phpdocx 13.5:
- DOCXStructure and in-memory DOCX documents.
- improved when content paragraphs to be updated start with protected XML characters or not standard double quotation marks.

phpdocx 13.0:
- headers and footers scopes.

phpdocx 12.5:
- array in search parameter.