searchAndReplace

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

searchAndReplace

PREMIUM

TRIAL / ADVANCED

Searches and replaces shared strings and cell values in an Excel document.

Description

public searchAndReplace (string $source, string $target, array $data, string $scope [, array $options])

This method allows the substitution of plain strings and cell values in a XLSX document.

Parameters

source

The path to the source Excel document.

target

The path to the Excel document resulting after the text replacement.

data

The data to be replaced. Plain strings or an array with the following keys: row (row number), col (column number to replace, 1 as first position) and value (value to add).

scope

sharedStrings (text strings) or sheet (cell values).

options

The possible keys and values are:

Key	Type	Description
sheetName	string	Sheet name to replace the value when using sheet as scope. All if null.
sheetNumber	int	Sheet number to replace the value when using sheet as scope. All if null.

Code samples

Example #1

require_once 'classes/XLSXUtilities.php';

$newXLSX = new XLSXUtilities();

$data = array('A1' => 'First cell', 'B3' => 'other cell', 'A1 B1 merged Sheet 2' => 'Merged cells');

$newXLSX->searchAndReplace('document.xlsx', 'output.xlsx', $data, 'sharedStrings');

Example #2

require_once 'classes/XLSXUtilities.php';

$newXLSX = new XLSXUtilities();

$data = array(
    array(
        'row' => 2,
        'col' => 1,
        'value' => 30,
    ),
    array(
        'row' => 2,
        'col' => 2,
        'value' => 10,
    ),
    array(
        'row' => 2,
        'col' => 3,
        'value' => 5,
    ),
    array(
        'row' => 4,
        'col' => 2,
        'value' => 3,
    ),
);

$newXLSX->searchAndReplace('document.xlsx', 'output.xlsx', $data, 'sheet', array('sheetName' => 'Chart'));

Release notes

phpdocx 12.5:
- replace parts of string contents.

phpdocx 8.5:
- new method.