Properties

$string

$string : string

Text string value

Type

string

$stringsWithOffsets

$stringsWithOffsets : array

Text strings with offset values

Type

array

$font

$font : string

Font

Type

string

$size

$size : integer

Text font size

Type

integer

$stroke

$stroke : array

Text stroke

Type

array

$wrap

$wrap : integer

Text wrap (by number of characters)

Type

integer

$autoWrap

$autoWrap : integer

Auto text wrap (by width of characters vs width of page)

Type

integer

$wrapLeft

$wrapLeft : array

Wrap text left of a box object (image, graphic, etc.)

Type

array

$wrapRight

$wrapRight : array

Wrap text right of a box object (image, graphic, etc.)

Type

array

$lineHeight

$lineHeight : integer

Text line height

Type

integer

$textParams

$textParams : array

Text parameters

Type

array

Methods

__construct()

__construct(string  $string, string  $size, string  $font = null) 

Constructor

Instantiate a PDF text object.

Parameters

string $string
string $size
string $font

setString()

setString(string  $string) : \Pop\Pdf\Document\Page\Text

Set the text string

Parameters

string $string

Returns

\Pop\Pdf\Document\Page\Text

addStringWithOffset()

addStringWithOffset(string  $string, integer  $offset) : \Pop\Pdf\Document\Page\Text

Add a string with offset

Parameters

string $string
integer $offset

Returns

\Pop\Pdf\Document\Page\Text

setSize()

setSize(integer|float  $size) : \Pop\Pdf\Document\Page\Text

Set the text size

Parameters

integer|float $size

Returns

\Pop\Pdf\Document\Page\Text

setFont()

setFont(string  $font) : \Pop\Pdf\Document\Page\Text

Set the font

Parameters

string $font

Returns

\Pop\Pdf\Document\Page\Text

setStroke()

setStroke(integer  $width, integer  $dashLength = null, integer  $dashGap = null) : \Pop\Pdf\Document\Page\Text

Set the text stroke properties

Parameters

integer $width
integer $dashLength
integer $dashGap

Returns

\Pop\Pdf\Document\Page\Text

setWrap()

setWrap(integer  $wrap, integer  $lineHeight = null) : \Pop\Pdf\Document\Page\Text

Set the word wrap

Parameters

integer $wrap
integer $lineHeight

Returns

\Pop\Pdf\Document\Page\Text

setAutoWrap()

setAutoWrap(integer  $wrap, integer  $lineHeight = null) : \Pop\Pdf\Document\Page\Text

Set the auto-wrap boundary

Parameters

integer $wrap
integer $lineHeight

Returns

\Pop\Pdf\Document\Page\Text

setWrapLeft()

setWrapLeft(integer  $wrap, integer  $boxXEdge, integer  $boxYEdge, integer  $lineHeight = null) : \Pop\Pdf\Document\Page\Text

Set the text to wrap left

Parameters

integer $wrap
integer $boxXEdge
integer $boxYEdge
integer $lineHeight

Returns

\Pop\Pdf\Document\Page\Text

setWrapRight()

setWrapRight(integer  $wrap, integer  $boxXEdge, integer  $boxYEdge, integer  $lineHeight = null) : \Pop\Pdf\Document\Page\Text

Set the text to wrap right

Parameters

integer $wrap
integer $boxXEdge
integer $boxYEdge
integer $lineHeight

Returns

\Pop\Pdf\Document\Page\Text

setLineHeight()

setLineHeight(integer  $lineHeight) : \Pop\Pdf\Document\Page\Text

Set the word wrap

Parameters

integer $lineHeight

Returns

\Pop\Pdf\Document\Page\Text

setRotation()

setRotation(integer  $rotation) : \Pop\Pdf\Document\Page\Text

Method to set the rotation of the text

Parameters

integer $rotation

Throws

\OutOfRangeException

Returns

\Pop\Pdf\Document\Page\Text

getString()

getString() : string

Get the text string

Returns

string

getSize()

getSize() : integer|float

Get the text size

Returns

integer|float

getFont()

getFont() : string

Get the font

Returns

string

getStroke()

getStroke() : array

Get the text stroke properties

Returns

array

getWrap()

getWrap() : integer

Get the word wrap

Returns

integer

getAutoWrap()

getAutoWrap() : integer

Get the word auto-wrap

Returns

integer

getWrapLeft()

getWrapLeft() : array

Get the wrap left

Returns

array

getWrapRight()

getWrapRight() : array

Get the wrap right

Returns

array

hasAutoWrap()

hasAutoWrap() : boolean

Determine if the text object has auto-wrap

Returns

boolean

hasWrapLeft()

hasWrapLeft() : boolean

Determine if the text object has wrap left

Returns

boolean

hasWrapRight()

hasWrapRight() : boolean

Determine if the text object has wrap right

Returns

boolean

getLineHeight()

getLineHeight() : integer

Get the line height

Returns

integer

getRotation()

getRotation() : integer

Get the rotation of the text

Returns

integer

setTextParams()

setTextParams(integer  $c, integer  $w, integer  $h = 100, integer  $v = 100, integer  $rot, integer  $rend) : \Pop\Pdf\Document\Page\Text

Set the text parameters for rendering text content

Parameters

integer $c

(character spacing)

integer $w

(word spacing)

integer $h

(horz stretch)

integer $v

(vert stretch)

integer $rot

(rotation, -90 - 90)

integer $rend

(render flag, 0 - 7)

Throws

\OutOfRangeException

Returns

\Pop\Pdf\Document\Page\Text

startStream()

startStream(string  $fontReference, integer  $x, integer  $y) : string

Start the text stream

Parameters

string $fontReference
integer $x
integer $y

Returns

string

getPartialStream()

getPartialStream(string  $fontReference = null, \Pop\Pdf\Document\Font  $fontObject = null, integer  $wrapLength = null) : string

Get the partial text stream

Parameters

string $fontReference
\Pop\Pdf\Document\Font $fontObject
integer $wrapLength

Returns

string

getPartialStreamWrapLeft()

getPartialStreamWrapLeft(integer  $startX, integer  $startY, integer  $wrapEdge, integer  $boxXEdge, integer  $boxYEdge, string  $fontReference = null, \Pop\Pdf\Document\Font  $fontObject = null) : string

Get the partial text stream

Parameters

integer $startX
integer $startY
integer $wrapEdge
integer $boxXEdge
integer $boxYEdge
string $fontReference
\Pop\Pdf\Document\Font $fontObject

Returns

string

getPartialStreamWrapRight()

getPartialStreamWrapRight(integer  $startX, integer  $startY, integer  $wrapEdge, integer  $boxXEdge, integer  $boxYEdge, string  $fontReference = null, \Pop\Pdf\Document\Font  $fontObject = null) : string

Get the partial text stream

Parameters

integer $startX
integer $startY
integer $wrapEdge
integer $boxXEdge
integer $boxYEdge
string $fontReference
\Pop\Pdf\Document\Font $fontObject

Returns

string

endStream()

endStream() : string

End the text stream

Returns

string

getStream()

getStream(string  $fontReference, integer  $x, integer  $y) : string

Get the text stream

Parameters

string $fontReference
integer $x
integer $y

Returns

string

getStringsForWrapLeft()

getStringsForWrapLeft(integer  $startX, integer  $startY, integer  $wrapEdge, integer  $boxXEdge, integer  $boxYEdge, \Pop\Pdf\Document\Font  $fontObject) : array

Get the strings for wrap left

Parameters

integer $startX
integer $startY
integer $wrapEdge
integer $boxXEdge
integer $boxYEdge
\Pop\Pdf\Document\Font $fontObject

Returns

array

getStringsForWrapRight()

getStringsForWrapRight(integer  $startX, integer  $startY, integer  $wrapEdge, integer  $boxXEdge, integer  $boxYEdge, \Pop\Pdf\Document\Font  $fontObject) : array

Get the strings for wrap right

Parameters

integer $startX
integer $startY
integer $wrapEdge
integer $boxXEdge
integer $boxYEdge
\Pop\Pdf\Document\Font $fontObject

Returns

array

calculateTextMatrix()

calculateTextMatrix() : string

Calculate text matrix

Returns

string