addComment

Key	Type	Description
text	string	The content to be inserted.
bold	bool	If true the content will be shown in bold characters.
color	string	Hexadecimal color value: 'FF0000', '000000'...
font	string	Font family: 'Arial', 'Calibri'...
fontSize	int	Font size in points.
italic	bool	If true displays the content in italics.
strikethrough	bool	If true displays text in strikethrough.
subscript	bool	If true displays text in subscript.
superscript	bool	If true displays text in superscript.
underline	string	Underlines text: single, double.

a multidimensional array to add rich text contents

position

Cell position in the active sheet: A1, C3, AB7...

options

Key	Type	Description
author	string	Author name.
replace	bool	If true replaces existing comment in the same position. Default as true.

Exceptions

Author doesn't exist. The author must exist in the sheet.

Code samples

Example #1

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

// if no author is set, assign the first author as the default one
$xlsx->addCell('Cell B2', 'B2');
$xlsx->addComment('New comment', 'B2');

// add a comment with an author
$xlsx->addCommentAuthor('myauthor');
$xlsx->addCell('Cell D2', 'D2');
$xlsx->addComment('My comment', 'D2', array('author' => 'myauthor'));

// add a comment with styles
$comment = array(
    'text' => 'Comment with styles',
    'bold' => true,
    'italic' => true,
    'underline' => 'single',
);
$xlsx->addCell('Cell E6', 'E6');
$xlsx->addComment($comment, 'E6', array('author' => 'phpxlsx'));

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Release notes

phpxlsx 2.5: new method.