Documentation

Comment extends AbstractShape
in package
implements ComparableInterface

Comment shape.

Table of Contents

Interfaces

ComparableInterface
PhpOffice\PhpPresentation\ComparableInterface.

Properties

$author  : null|Author
$container  : null|ShapeContainerInterface
Container.
$dtComment  : int
$height  : int
Height.
$hyperlink  : null|Hyperlink
$name  : string
Name.
$offsetX  : int
Offset X.
$offsetY  : int
Offset Y.
$placeholder  : null|Placeholder
$rotation  : int
Rotation.
$shadow  : null|Shadow
Shadow.
$text  : string
$width  : int
Width.
$border  : Border
Border.
$fill  : null|Fill
$hashIndex  : int
Hash index.

Methods

__clone()  : mixed
Magic Method : clone.
__construct()  : mixed
Create a new self.
getAuthor()  : Author|null
getBorder()  : Border
getContainer()  : ShapeContainerInterface|null
Get Container, Slide or Group.
getDate()  : int
getFill()  : Fill|null
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getHeight()  : null|int
Comment has not height.
getHyperlink()  : Hyperlink
Get Hyperlink.
getName()  : string
Get Name.
getOffsetX()  : int
Get OffsetX.
getOffsetY()  : int
Get OffsetY.
getPlaceholder()  : Placeholder|null
getRotation()  : int
Get Rotation.
getShadow()  : Shadow|null
getText()  : string
getWidth()  : null|int
Comment has not width.
hasHyperlink()  : bool
Has Hyperlink?
isPlaceholder()  : bool
setAuthor()  : self
setContainer()  : $this
Set Container, Slide or Group.
setDate()  : Comment
setFill()  : self
setHashIndex()  : $this
Set hash index.
setHeight()  : $this
Set Height.
setHyperlink()  : self
Set Hyperlink.
setName()  : static
Set Name.
setOffsetX()  : $this
Set OffsetX.
setOffsetY()  : $this
Set OffsetY.
setPlaceHolder()  : self
setRotation()  : $this
Set Rotation.
setShadow()  : $this
setText()  : Comment
setWidth()  : self
Set Width.
setWidthAndHeight()  : self
Set width and height with proportional resize.

Properties

Methods

__construct()

Create a new self.

public __construct() : mixed

getDate()

public getDate() : int
Return values
int

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string —

Hash code

getHashIndex()

Get hash index.

public getHashIndex() : null|int

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Return values
null|int —

Hash index

getHeight()

Comment has not height.

public getHeight() : null|int
Return values
null|int

getName()

Get Name.

public getName() : string
Return values
string

getOffsetX()

Get OffsetX.

public getOffsetX() : int
Return values
int

getOffsetY()

Get OffsetY.

public getOffsetY() : int
Return values
int

getRotation()

Get Rotation.

public getRotation() : int
Return values
int

getText()

public getText() : string
Return values
string

getWidth()

Comment has not width.

public getWidth() : null|int
Return values
null|int

hasHyperlink()

Has Hyperlink?

public hasHyperlink() : bool
Return values
bool

isPlaceholder()

public isPlaceholder() : bool
Return values
bool

setAuthor()

public setAuthor(Author $author) : self
Parameters
$author : Author
Return values
self

setContainer()

Set Container, Slide or Group.

public setContainer([ShapeContainerInterface|null $pValue = null ][, bool $pOverrideOld = false ]) : $this
Parameters
$pValue : ShapeContainerInterface|null = null
$pOverrideOld : bool = false

If a Slide has already been assigned, overwrite it and remove image from old Slide?

Return values
$this

setDate()

public setDate(int $dtComment) : Comment
Parameters
$dtComment : int

timestamp of the comment

Return values
Comment

setFill()

public setFill([Fill|null $pValue = null ]) : self
Parameters
$pValue : Fill|null = null
Return values
self

setHashIndex()

Set hash index.

public setHashIndex(int $value) : $this

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Parameters
$value : int

Hash index

Return values
$this

setHeight()

Set Height.

public setHeight([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setHyperlink()

Set Hyperlink.

public setHyperlink([Hyperlink|null $pHyperlink = null ]) : self
Parameters
$pHyperlink : Hyperlink|null = null
Return values
self

setName()

Set Name.

public setName([string $pValue = '' ]) : static
Parameters
$pValue : string = ''
Return values
static

setOffsetX()

Set OffsetX.

public setOffsetX([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setOffsetY()

Set OffsetY.

public setOffsetY([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setRotation()

Set Rotation.

public setRotation([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setShadow()

public setShadow([Shadow|null $pValue = null ]) : $this
Parameters
$pValue : Shadow|null = null
Return values
$this

setText()

public setText([string $text = '' ]) : Comment
Parameters
$text : string = ''
Return values
Comment

setWidth()

Set Width.

public setWidth([int $pValue = 0 ]) : self
Parameters
$pValue : int = 0
Return values
self

setWidthAndHeight()

Set width and height with proportional resize.

public setWidthAndHeight([int $width = 0 ][, int $height = 0 ]) : self
Parameters
$width : int = 0
$height : int = 0
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results