Documentation

Comment implements IComparable

Interfaces, Classes and Traits

IComparable

Table of Contents

$alignment  : string
Alignment.
$author  : string
Author.
$backgroundImage  : Drawing
Background image in comment.
$fillColor  : Color
Comment fill color.
$height  : string
Comment height (CSS style, i.e. XXpx or YYpt).
$marginLeft  : string
Left margin (CSS style, i.e. XXpx or YYpt).
$marginTop  : string
Top margin (CSS style, i.e. XXpx or YYpt).
$text  : RichText
Rich text comment.
$visible  : bool
Visible.
$width  : string
Comment width (CSS style, i.e. XXpx or YYpt).
__clone()  : mixed
Implement PHP __clone to create a deep clone, not just a shallow copy.
__construct()  : mixed
Create a new Comment.
__toString()  : string
Convert to string.
getAlignment()  : string
Get Alignment.
getAuthor()  : string
Get Author.
getBackgroundImage()  : Drawing
Returns background image.
getFillColor()  : Color
Get fill color.
getHashCode()  : string
Get hash code.
getHeight()  : string
Get comment height (CSS style, i.e. XXpx or YYpt).
getMarginLeft()  : string
Get left margin (CSS style, i.e. XXpx or YYpt).
getMarginTop()  : string
Get top margin (CSS style, i.e. XXpx or YYpt).
getText()  : RichText
Get Rich text comment.
getVisible()  : bool
Is the comment visible by default?
getWidth()  : string
Get comment width (CSS style, i.e. XXpx or YYpt).
hasBackgroundImage()  : bool
Check is background image exists.
setAlignment()  : self
Set Alignment.
setAuthor()  : self
Set Author.
setBackgroundImage()  : self
Sets background image.
setFillColor()  : self
Set fill color.
setHeight()  : self
Set comment height (CSS style, i.e. XXpx or YYpt). Default unit is pt.
setMarginLeft()  : self
Set left margin (CSS style, i.e. XXpx or YYpt). Default unit is pt.
setMarginTop()  : self
Set top margin (CSS style, i.e. XXpx or YYpt). Default unit is pt.
setSizeAsBackgroundImage()  : self
Sets size of comment as size of background image.
setText()  : self
Set Rich text comment.
setVisible()  : self
Set comment default visibility.
setWidth()  : self
Set comment width (CSS style, i.e. XXpx or YYpt). Default unit is pt.

Properties

$alignment

Alignment.

private string $alignment

$author

Author.

private string $author

$backgroundImage

Background image in comment.

private Drawing $backgroundImage

$height

Comment height (CSS style, i.e. XXpx or YYpt).

private string $height = '55.5pt'

$marginLeft

Left margin (CSS style, i.e. XXpx or YYpt).

private string $marginLeft = '59.25pt'

$marginTop

Top margin (CSS style, i.e. XXpx or YYpt).

private string $marginTop = '1.5pt'

$visible

Visible.

private bool $visible = false

$width

Comment width (CSS style, i.e. XXpx or YYpt).

private string $width = '96pt'

Methods

__clone()

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

public __clone() : mixed
Return values
mixed

__construct()

Create a new Comment.

public __construct() : mixed
Return values
mixed

__toString()

Convert to string.

public __toString() : string
Return values
string

getAlignment()

Get Alignment.

public getAlignment() : string
Return values
string

getAuthor()

Get Author.

public getAuthor() : string
Return values
string

getBackgroundImage()

Returns background image.

public getBackgroundImage() : Drawing
Return values
Drawing

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string

Hash code

getHeight()

Get comment height (CSS style, i.e. XXpx or YYpt).

public getHeight() : string
Return values
string

getMarginLeft()

Get left margin (CSS style, i.e. XXpx or YYpt).

public getMarginLeft() : string
Return values
string

getMarginTop()

Get top margin (CSS style, i.e. XXpx or YYpt).

public getMarginTop() : string
Return values
string

getVisible()

Is the comment visible by default?

public getVisible() : bool
Return values
bool

getWidth()

Get comment width (CSS style, i.e. XXpx or YYpt).

public getWidth() : string
Return values
string

hasBackgroundImage()

Check is background image exists.

public hasBackgroundImage() : bool
Return values
bool

setAlignment()

Set Alignment.

public setAlignment(string $alignment) : self
Parameters
$alignment : string
Return values
self

setAuthor()

Set Author.

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

setBackgroundImage()

Sets background image.

public setBackgroundImage(Drawing $objDrawing) : self
Parameters
$objDrawing : Drawing
Return values
self

setFillColor()

Set fill color.

public setFillColor(Color $color) : self
Parameters
$color : Color
Return values
self

setHeight()

Set comment height (CSS style, i.e. XXpx or YYpt). Default unit is pt.

public setHeight(string $height) : self
Parameters
$height : string
Return values
self

setMarginLeft()

Set left margin (CSS style, i.e. XXpx or YYpt). Default unit is pt.

public setMarginLeft(string $margin) : self
Parameters
$margin : string
Return values
self

setMarginTop()

Set top margin (CSS style, i.e. XXpx or YYpt). Default unit is pt.

public setMarginTop(string $margin) : self
Parameters
$margin : string
Return values
self

setSizeAsBackgroundImage()

Sets size of comment as size of background image.

public setSizeAsBackgroundImage() : self
Return values
self

setText()

Set Rich text comment.

public setText(RichText $text) : self
Parameters
$text : RichText
Return values
self

setVisible()

Set comment default visibility.

public setVisible(bool $visibility) : self
Parameters
$visibility : bool
Return values
self

setWidth()

Set comment width (CSS style, i.e. XXpx or YYpt). Default unit is pt.

public setWidth(string $width) : self
Parameters
$width : string
Return values
self

Search results