Documentation

Comments extends WriterPart

Table of Contents

$parentWriter  : Xlsx
Parent Xlsx object.
__construct()  : mixed
Set parent Xlsx object.
getParentWriter()  : Xlsx
Get parent Xlsx object.
writeComments()  : string
Write comments to XML format.
writeVMLComments()  : string
Write VML comments to XML format.
writeComment()  : void
Write comment to XML format.
writeVMLComment()  : void
Write VML comment to XML format.

Properties

Methods

__construct()

Set parent Xlsx object.

public __construct(Xlsx $writer) : mixed
Parameters
$writer : Xlsx
Return values
mixed —

getParentWriter()

Get parent Xlsx object.

public getParentWriter() : Xlsx
Return values
Xlsx —

writeComments()

Write comments to XML format.

public writeComments(Worksheet $worksheet) : string
Parameters
$worksheet : Worksheet
Return values
string —

XML Output

writeVMLComments()

Write VML comments to XML format.

public writeVMLComments(Worksheet $worksheet) : string
Parameters
$worksheet : Worksheet
Return values
string —

XML Output

writeComment()

Write comment to XML format.

private writeComment(XMLWriter $objWriter, string $cellReference, Comment $comment, array<string|int, mixed> $authors) : void
Parameters
$objWriter : XMLWriter
$cellReference : string

Cell reference

$comment : Comment

Comment

$authors : array<string|int, mixed>

Array of authors

Return values
void —

writeVMLComment()

Write VML comment to XML format.

private writeVMLComment(XMLWriter $objWriter, string $cellReference, Comment $comment) : void
Parameters
$objWriter : XMLWriter
$cellReference : string

Cell reference, eg: 'A1'

$comment : Comment

Comment

Return values
void —

Search results