removeElement

CONTENTS

LAYOUT AND SETTINGS

TEMPLATES

SAVE

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

INDEXER

indexer

PERFORMANCE

zipStream

CRYPTO

DIGITAL SIGNATURE

sign (XLSX)

removeElement

ADVANCED / PREMIUM

BASIC

Removes elements in the spreadsheet.

Description

public removeElement (array $referenceNode)

Parameters

referenceNode

An array to get the refence node.
The possible keys and values of this array are:

key	Type	Description
type	string	cell (default value) drawing row
contains	string	Contains a text string. Cell type.
occurrence	mixed	(int) exact occurrence from 1 (array) occurrences (string) range of contents (e.g.: 2..9, 2.., ..9), first(), last()
attributes	array	Contains a specific attribute key and value.
customQuery	string	Custom XPath query, overwrites any other reference.

Exceptions

Method not available.

Code samples

Example #1

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsxFromTemplate('template.xlsx');

// remove the first cell
$referenceToBeRemoved = array(
    'type' => 'cell',
    'occurrence' => 1,
);
$xlsx->removeElement($referenceToBeRemoved);

// remove cells from 2nd position
$referenceToBeRemoved = array(
    'type' => 'cell',
    'occurrence' => '2..',
);
$xlsx->removeElement($referenceToBeRemoved);

// change the active sheet
$xlsx->setActiveSheet(array('position' => 2));

// remove cells that containt a text
$referenceToBeRemoved = array(
    'type' => 'cell',
    'contains' => 'IMAGE',
);
$xlsx->removeElement($referenceToBeRemoved);

$xlsx->saveXlsx('output');

Release notes

phpxlsx 4.5:
- new method.