Inheritance diagram for PHPExcel_Comment:

Collaboration diagram for PHPExcel_Comment:

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

	getAuthor ()
	Get Author. More...

	setAuthor ($pValue='')
	Set Author. More...

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

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

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

	setWidth ($value='96pt')
	Set comment width (CSS style, i.e. More...

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

	setHeight ($value='55.5pt')
	Set comment height (CSS style, i.e. More...

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

	setMarginLeft ($value='59.25pt')
	Set left margin (CSS style, i.e. More...

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

	setMarginTop ($value='1.5pt')
	Set top margin (CSS style, i.e. More...

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

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

	getFillColor ()
	Get fill color. More...

	setAlignment ($pValue=PHPExcel_Style_Alignment::HORIZONTAL_GENERAL)
	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 36 of file Comment.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Comment::__construct ( )

Create a new PHPExcel_Comment.

Exceptions

PHPExcel_Exception

Definition at line 106 of file Comment.php.

References PHPExcel_Style_Alignment\HORIZONTAL_GENERAL.

     {
         // Initialise variables
         $this->_author          = 'Author';
         $this->_text            = new PHPExcel_RichText();
         $this->_fillColor       = new PHPExcel_Style_Color('FFFFFFE1');
         $this->_alignment       = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL;
     }

Member Function Documentation

◆ __clone()

PHPExcel_Comment::__clone ( )

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

Definition at line 307 of file Comment.php.

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

◆ __toString()

PHPExcel_Comment::__toString ( )

Convert to string.

Returns: string

Definition at line 323 of file Comment.php.

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

◆ getAlignment()

PHPExcel_Comment::getAlignment ( )

Get Alignment.

Returns: string

Definition at line 280 of file Comment.php.

References $_alignment.

                                    {
         return $this->_alignment;
     }

◆ getAuthor()

PHPExcel_Comment::getAuthor ( )

Get Author.

Returns: string

Definition at line 120 of file Comment.php.

References $_author.

                                 {
         return $this->_author;
     }

◆ getFillColor()

PHPExcel_Comment::getFillColor ( )

Get fill color.

Returns: PHPExcel_Style_Color

Definition at line 260 of file Comment.php.

References $_fillColor.

                                    {
         return $this->_fillColor;
     }

◆ getHashCode()

PHPExcel_Comment::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PHPExcel_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()

PHPExcel_Comment::getHeight ( )

Get comment height (CSS style, i.e.

XXpx or YYpt)

Returns: string

Definition at line 180 of file Comment.php.

References $_height.

                                 {
         return $this->_height;
     }

◆ getMarginLeft()

PHPExcel_Comment::getMarginLeft ( )

Get left margin (CSS style, i.e.

XXpx or YYpt)

Returns: string

Definition at line 200 of file Comment.php.

References $_marginLeft.

                                     {
         return $this->_marginLeft;
     }

◆ getMarginTop()

PHPExcel_Comment::getMarginTop ( )

Get top margin (CSS style, i.e.

XXpx or YYpt)

Returns: string

Definition at line 220 of file Comment.php.

References $_marginTop.

                                    {
         return $this->_marginTop;
     }

◆ getText()

PHPExcel_Comment::getText ( )

Get Rich text comment.

Returns: PHPExcel_RichText

Definition at line 140 of file Comment.php.

References $_text.

                               {
         return $this->_text;
     }

◆ getVisible()

PHPExcel_Comment::getVisible ( )

Is the comment visible by default?

Returns: boolean

Definition at line 240 of file Comment.php.

References $_visible.

                                  {
         return $this->_visible;
     }

◆ getWidth()

PHPExcel_Comment::getWidth ( )

Get comment width (CSS style, i.e.

XXpx or YYpt)

Returns: string

Definition at line 160 of file Comment.php.

References $_width.

                                {
         return $this->_width;
     }

◆ setAlignment()

PHPExcel_Comment::setAlignment ( $pValue = PHPExcel_Style_Alignment::HORIZONTAL_GENERAL )

Set Alignment.

Parameters

string $pValue

Returns: PHPExcel_Comment

Definition at line 270 of file Comment.php.

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

◆ setAuthor()

PHPExcel_Comment::setAuthor ( $pValue = '' )

Set Author.

Parameters

string $pValue

Returns: PHPExcel_Comment

Definition at line 130 of file Comment.php.

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

◆ setHeight()

PHPExcel_Comment::setHeight ( $value = '55.5pt' )

Set comment height (CSS style, i.e.

XXpx or YYpt)

Parameters

string $value

Returns: PHPExcel_Comment

Definition at line 190 of file Comment.php.

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

◆ setMarginLeft()

PHPExcel_Comment::setMarginLeft ( $value = '59.25pt' )

Set left margin (CSS style, i.e.

XXpx or YYpt)

Parameters

string $value

Returns: PHPExcel_Comment

Definition at line 210 of file Comment.php.

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

◆ setMarginTop()

PHPExcel_Comment::setMarginTop ( $value = '1.5pt' )

Set top margin (CSS style, i.e.

XXpx or YYpt)

Parameters

string $value

Returns: PHPExcel_Comment

Definition at line 230 of file Comment.php.

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

◆ setText()

PHPExcel_Comment::setText ( PHPExcel_RichText $pValue )

Set Rich text comment.

Parameters

PHPExcel_RichText $pValue

Returns: PHPExcel_Comment

Definition at line 150 of file Comment.php.

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

◆ setVisible()

PHPExcel_Comment::setVisible ( $value = false )

Set comment default visibility.

Parameters

boolean $value

Returns: PHPExcel_Comment

Definition at line 250 of file Comment.php.

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

◆ setWidth()

PHPExcel_Comment::setWidth ( $value = '96pt' )

Set comment width (CSS style, i.e.

XXpx or YYpt)

Parameters

string $value

Returns: PHPExcel_Comment

Definition at line 170 of file Comment.php.

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

Field Documentation

◆ $_alignment

PHPExcel_Comment::$_alignment

private

Definition at line 99 of file Comment.php.

Referenced by getAlignment().

◆ $_author

PHPExcel_Comment::$_author

private

Definition at line 43 of file Comment.php.

Referenced by getAuthor().

◆ $_fillColor

PHPExcel_Comment::$_fillColor

private

Definition at line 92 of file Comment.php.

Referenced by getFillColor().

◆ $_height

PHPExcel_Comment::$_height = '55.5pt'

private

Definition at line 85 of file Comment.php.

Referenced by getHeight().

◆ $_marginLeft

PHPExcel_Comment::$_marginLeft = '59.25pt'

private

Definition at line 64 of file Comment.php.

Referenced by getMarginLeft().

◆ $_marginTop

PHPExcel_Comment::$_marginTop = '1.5pt'

private

Definition at line 71 of file Comment.php.

Referenced by getMarginTop().

◆ $_text

PHPExcel_Comment::$_text

private

Definition at line 50 of file Comment.php.

Referenced by getText().

◆ $_visible

PHPExcel_Comment::$_visible = false

private

Definition at line 78 of file Comment.php.

Referenced by getVisible().

◆ $_width

PHPExcel_Comment::$_width = '96pt'

private

Definition at line 57 of file Comment.php.

Referenced by getWidth().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/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