Inheritance diagram for PhpOffice\PhpSpreadsheet\Comment:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Comment:

Public Member Functions
	__construct ()
	Create a new Comment. More...

	getAuthor ()
	Get Author. More...

	setAuthor ($author)
	Set Author. More...

	getText ()
	Get Rich text comment. More...

	setText (RichText $pValue)
	Set Rich text comment. More...

	getWidth ()
	Get comment width (CSS style, i.e. More...

	setWidth ($width)
	Set comment width (CSS style, i.e. More...

	getHeight ()
	Get comment height (CSS style, i.e. More...

	setHeight ($value)
	Set comment height (CSS style, i.e. More...

	getMarginLeft ()
	Get left margin (CSS style, i.e. More...

	setMarginLeft ($value)
	Set left margin (CSS style, i.e. More...

	getMarginTop ()
	Get top margin (CSS style, i.e. More...

	setMarginTop ($value)
	Set top margin (CSS style, i.e. More...

	getVisible ()
	Is the comment visible by default? More...

	setVisible ($value)
	Set comment default visibility. More...

	getFillColor ()
	Get fill color. More...

	setAlignment ($alignment)
	Set Alignment. More...

	getAlignment ()
	Get Alignment. More...

	getHashCode ()
	Get hash code. More...

	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

	__toString ()
	Convert to string. More...

Private Attributes
	$author

	$text

	$width = '96pt'

	$marginLeft = '59.25pt'

	$marginTop = '1.5pt'

	$visible = false

	$height = '55.5pt'

	$fillColor

	$alignment

Detailed Description

Definition at line 7 of file Comment.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Comment::__construct ( )

Create a new Comment.

Definition at line 75 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Style\Alignment\HORIZONTAL_GENERAL.

     {
         // Initialise variables
         $this->author = 'Author';
         $this->text = new RichText();
         $this->fillColor = new Style\Color('FFFFFFE1');
         $this->alignment = Style\Alignment::HORIZONTAL_GENERAL;
     }

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Comment::__clone ( )

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 308 of file Comment.php.

References $key.

     {
         $vars = get_object_vars($this);
         foreach ($vars as $key => $value) {
             if (is_object($value)) {
                 $this->$key = clone $value;
             } else {
                 $this->$key = $value;
             }
         }
     }

◆ __toString()

PhpOffice\PhpSpreadsheet\Comment::__toString ( )

Convert to string.

Returns: string

Definition at line 325 of file Comment.php.

     {
         return $this->text->getPlainText();
     }

◆ getAlignment()

PhpOffice\PhpSpreadsheet\Comment::getAlignment ( )

Get Alignment.

Returns: string

Definition at line 279 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$alignment.

     {
         return $this->alignment;
     }

◆ getAuthor()

PhpOffice\PhpSpreadsheet\Comment::getAuthor ( )

Get Author.

Returns: string

Definition at line 89 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$author.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeComment().

     {
         return $this->author;
     }

Here is the caller graph for this function:

◆ getFillColor()

PhpOffice\PhpSpreadsheet\Comment::getFillColor ( )

Get fill color.

Returns: Style

Definition at line 255 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$fillColor.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeVMLComment().

     {
         return $this->fillColor;
     }

Here is the caller graph for this function:

◆ getHashCode()

PhpOffice\PhpSpreadsheet\Comment::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 289 of file Comment.php.

     {
         return md5(
             $this->author .
             $this->text->getHashCode() .
             $this->width .
             $this->height .
             $this->marginLeft .
             $this->marginTop .
             ($this->visible ? 1 : 0) .
             $this->fillColor->getHashCode() .
             $this->alignment .
             __CLASS__
         );
     }

◆ getHeight()

PhpOffice\PhpSpreadsheet\Comment::getHeight ( )

Get comment height (CSS style, i.e.

XXpx or YYpt).

Returns: string

Definition at line 159 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$height.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeVMLComment().

     {
         return $this->height;
     }

Here is the caller graph for this function:

◆ getMarginLeft()

PhpOffice\PhpSpreadsheet\Comment::getMarginLeft ( )

Get left margin (CSS style, i.e.

XXpx or YYpt).

Returns: string

Definition at line 183 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$marginLeft.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeVMLComment().

     {
         return $this->marginLeft;
     }

Here is the caller graph for this function:

◆ getMarginTop()

PhpOffice\PhpSpreadsheet\Comment::getMarginTop ( )

Get top margin (CSS style, i.e.

XXpx or YYpt).

Returns: string

Definition at line 207 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$marginTop.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeVMLComment().

     {
         return $this->marginTop;
     }

Here is the caller graph for this function:

◆ getText()

PhpOffice\PhpSpreadsheet\Comment::getText ( )

Get Rich text comment.

Returns: RichText

Definition at line 113 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$text.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeComment().

     {
         return $this->text;
     }

Here is the caller graph for this function:

◆ getVisible()

PhpOffice\PhpSpreadsheet\Comment::getVisible ( )

Is the comment visible by default?

Returns: bool

Definition at line 231 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$visible.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeVMLComment().

     {
         return $this->visible;
     }

Here is the caller graph for this function:

◆ getWidth()

PhpOffice\PhpSpreadsheet\Comment::getWidth ( )

Get comment width (CSS style, i.e.

XXpx or YYpt).

Returns: string

Definition at line 135 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$width.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Comments\writeVMLComment().

     {
         return $this->width;
     }

Here is the caller graph for this function:

◆ setAlignment()

PhpOffice\PhpSpreadsheet\Comment::setAlignment ( $alignment )

Set Alignment.

Parameters

string $alignment see Style::HORIZONTAL_*

Returns: $this

Definition at line 267 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$alignment.

     {
         $this->alignment = $alignment;
 
         return $this;
     }

◆ setAuthor()

PhpOffice\PhpSpreadsheet\Comment::setAuthor ( $author )

Set Author.

Parameters

string $author

Returns: $this

Definition at line 101 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$author.

     {
         $this->author = $author;
 
         return $this;
     }

◆ setHeight()

PhpOffice\PhpSpreadsheet\Comment::setHeight ( $value )

Set comment height (CSS style, i.e.

XXpx or YYpt).

Parameters

string $value

Returns: $this

Definition at line 171 of file Comment.php.

     {
         $this->height = $value;
 
         return $this;
     }

◆ setMarginLeft()

PhpOffice\PhpSpreadsheet\Comment::setMarginLeft ( $value )

Set left margin (CSS style, i.e.

XXpx or YYpt).

Parameters

string $value

Returns: $this

Definition at line 195 of file Comment.php.

     {
         $this->marginLeft = $value;
 
         return $this;
     }

◆ setMarginTop()

PhpOffice\PhpSpreadsheet\Comment::setMarginTop ( $value )

Set top margin (CSS style, i.e.

XXpx or YYpt).

Parameters

string $value

Returns: $this

Definition at line 219 of file Comment.php.

     {
         $this->marginTop = $value;
 
         return $this;
     }

◆ setText()

PhpOffice\PhpSpreadsheet\Comment::setText ( RichText $pValue )

Set Rich text comment.

Returns: $this

Definition at line 123 of file Comment.php.

     {
         $this->text = $pValue;
 
         return $this;
     }

◆ setVisible()

PhpOffice\PhpSpreadsheet\Comment::setVisible ( $value )

Set comment default visibility.

Parameters

bool $value

Returns: $this

Definition at line 243 of file Comment.php.

     {
         $this->visible = $value;
 
         return $this;
     }

◆ setWidth()

PhpOffice\PhpSpreadsheet\Comment::setWidth ( $width )

Set comment width (CSS style, i.e.

XXpx or YYpt).

Parameters

string $width

Returns: $this

Definition at line 147 of file Comment.php.

References PhpOffice\PhpSpreadsheet\Comment\$width.

     {
         $this->width = $width;
 
         return $this;
     }

Field Documentation

◆ $alignment

PhpOffice\PhpSpreadsheet\Comment::$alignment

private

Definition at line 70 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getAlignment(), and PhpOffice\PhpSpreadsheet\Comment\setAlignment().

◆ $author

PhpOffice\PhpSpreadsheet\Comment::$author

private

Definition at line 14 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getAuthor(), and PhpOffice\PhpSpreadsheet\Comment\setAuthor().

◆ $fillColor

PhpOffice\PhpSpreadsheet\Comment::$fillColor

private

Definition at line 63 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getFillColor().

◆ $height

PhpOffice\PhpSpreadsheet\Comment::$height = '55.5pt'

private

Definition at line 56 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getHeight().

◆ $marginLeft

PhpOffice\PhpSpreadsheet\Comment::$marginLeft = '59.25pt'

private

Definition at line 35 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getMarginLeft().

◆ $marginTop

PhpOffice\PhpSpreadsheet\Comment::$marginTop = '1.5pt'

private

Definition at line 42 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getMarginTop().

◆ $text

PhpOffice\PhpSpreadsheet\Comment::$text

private

Definition at line 21 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getText().

◆ $visible

PhpOffice\PhpSpreadsheet\Comment::$visible = false

private

Definition at line 49 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getVisible().

◆ $width

PhpOffice\PhpSpreadsheet\Comment::$width = '96pt'

private

Definition at line 28 of file Comment.php.

Referenced by PhpOffice\PhpSpreadsheet\Comment\getWidth(), and PhpOffice\PhpSpreadsheet\Comment\setWidth().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Comment.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ __toString()

◆ getAlignment()

◆ getAuthor()

◆ getFillColor()

◆ getHashCode()

◆ getHeight()

◆ getMarginLeft()

◆ getMarginTop()

◆ getText()

◆ getVisible()

◆ getWidth()

◆ setAlignment()

◆ setAuthor()

◆ setHeight()

◆ setMarginLeft()

◆ setMarginTop()

◆ setText()

◆ setVisible()

◆ setWidth()

Field Documentation

◆ $alignment

◆ $author

◆ $fillColor

◆ $height

◆ $marginLeft

◆ $marginTop

◆ $text

◆ $visible

◆ $width