Properties

$string

$string : string

Text string value

Type

string

$stringsWithOffsets

$stringsWithOffsets : array

Text strings with offset values

Type

array

$size

$size : integer

Text font size

Type

integer

$stroke

$stroke : array

Text stroke

Type

array

$charWrap

$charWrap : integer

Basic wrap based on character length

Type

integer

$leading

$leading : integer

Leading for the lines for a character wrap

Type

integer

$textParams

$textParams : array

Text parameters

Type

array

Methods

__construct()

__construct(string  $string, string  $size) 

Constructor

Instantiate a PDF text object.

Parameters

string $string
string $size

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

getStringsWithOffset()

getStringsWithOffset() : array

Get strings with offset

Returns

array

setSize()

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

Set the text size

Parameters

integer|float $size

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

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

setCharWrap()

setCharWrap(integer  $charWrap, integer  $leading = null) : \Pop\Pdf\Document\Page\Text

Method to set the character wrap

Parameters

integer $charWrap
integer $leading

Returns

\Pop\Pdf\Document\Page\Text

setLeading()

setLeading(integer  $leading) : \Pop\Pdf\Document\Page\Text

Method to set the character wrap leading

Parameters

integer $leading

Returns

\Pop\Pdf\Document\Page\Text

escape()

escape(mixed  $search = null, mixed  $replace = null) : \Pop\Pdf\Document\Page\Text

Escape string

Parameters

mixed $search
mixed $replace

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

getStroke()

getStroke() : array

Get the text stroke properties

Returns

array

getRotation()

getRotation() : integer

Get the rotation of the text

Returns

integer

getCharWrap()

getCharWrap() : integer

Get character wrap

Returns

integer

getLeading()

getLeading() : integer

Get character wrap leading

Returns

integer

hasCharWrap()

hasCharWrap() : boolean

Has character wrap

Returns

boolean

hasLeading()

hasLeading() : boolean

Has character wrap leading

Returns

boolean

hasAlignment()

hasAlignment() : boolean

Has text alignment

Returns

boolean

hasWrap()

hasWrap() : boolean

Has text wrap

Returns

boolean

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

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

getPartialStream()

getPartialStream(string  $fontReference = null) : string

Get the partial text stream

Parameters

string $fontReference

Returns

string

calculateTextMatrix()

calculateTextMatrix() : string

Calculate text matrix

Returns

string