Stream
in package
Pdf page text stream class
Tags
Table of Contents
- $currentX : int
- Current X
- $currentY : int
- Current Y
- $edgeX : int
- Edge X boundary
- $edgeY : int
- Edge Y boundary
- $orphanIndex : array<string|int, mixed>
- Orphan index
- $startX : int
- Start X
- $startY : int
- Start Y
- $streams : array<string|int, mixed>
- Text streams
- $styles : array<string|int, mixed>
- Text styles
- __construct() : mixed
- Constructor
- addText() : Stream
- Add text to the stream
- getColorStream() : string
- Get the partial color stream
- getCurrentX() : int
- Get current X
- getCurrentY() : int
- Get current Y
- getEdgeX() : int
- Get edge X boundary
- getEdgeY() : int
- Get edge Y boundary
- getOrphanStream() : Stream
- Resume stream from orphaned index
- getStartX() : int
- Get start X
- getStartY() : int
- Get start Y
- getStream() : string
- Get stream
- getTextStreams() : array<string|int, mixed>
- Get text stream
- hasOrphanIndex() : bool
- Check if the text stream has orphan streams due to the page bottom
- hasOrphans() : bool
- Prepare stream
- setCurrentStyle() : Stream
- Set the current style
- setCurrentX() : Stream
- Set current X
- setCurrentY() : Stream
- Set current Y
- setEdgeX() : Stream
- Set edge X boundary
- setEdgeY() : Stream
- Set edge Y boundary
- setStartX() : Stream
- Set start X
- setStartY() : Stream
- Set start Y
Properties
$currentX
Current X
protected
int
$currentX
= null
$currentY
Current Y
protected
int
$currentY
= null
$edgeX
Edge X boundary
protected
int
$edgeX
= null
$edgeY
Edge Y boundary
protected
int
$edgeY
= null
$orphanIndex
Orphan index
protected
array<string|int, mixed>
$orphanIndex
= []
$startX
Start X
protected
int
$startX
= null
$startY
Start Y
protected
int
$startY
= null
$streams
Text streams
protected
array<string|int, mixed>
$streams
= []
$styles
Text styles
protected
array<string|int, mixed>
$styles
= []
Methods
__construct()
Constructor
public
__construct(int $startX, int $startY, int $edgeX[, int $edgeY = null ]) : mixed
Instantiate a PDF text stream object.
Parameters
- $startX : int
- $startY : int
- $edgeX : int
- $edgeY : int = null
Return values
mixed —addText()
Add text to the stream
public
addText(string $string[, int $y = null ]) : Stream
Parameters
- $string : string
- $y : int = null
Return values
Stream —getColorStream()
Get the partial color stream
public
getColorStream(ColorInterface $color) : string
Parameters
- $color : ColorInterface
Return values
string —getCurrentX()
Get current X
public
getCurrentX() : int
Return values
int —getCurrentY()
Get current Y
public
getCurrentY() : int
Return values
int —getEdgeX()
Get edge X boundary
public
getEdgeX() : int
Return values
int —getEdgeY()
Get edge Y boundary
public
getEdgeY() : int
Return values
int —getOrphanStream()
Resume stream from orphaned index
public
getOrphanStream() : Stream
Return values
Stream —getStartX()
Get start X
public
getStartX() : int
Return values
int —getStartY()
Get start Y
public
getStartY() : int
Return values
int —getStream()
Get stream
public
getStream(array<string|int, mixed> $fonts, array<string|int, mixed> $fontReferences) : string
Parameters
- $fonts : array<string|int, mixed>
- $fontReferences : array<string|int, mixed>
Return values
string —getTextStreams()
Get text stream
public
getTextStreams() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasOrphanIndex()
Check if the text stream has orphan streams due to the page bottom
public
hasOrphanIndex() : bool
Return values
bool —hasOrphans()
Prepare stream
public
hasOrphans(array<string|int, mixed> $fonts) : bool
Parameters
- $fonts : array<string|int, mixed>
Return values
bool —setCurrentStyle()
Set the current style
public
setCurrentStyle(string $font, int $size[, ColorInterface $color = null ]) : Stream
Parameters
- $font : string
- $size : int
- $color : ColorInterface = null
Return values
Stream —setCurrentX()
Set current X
public
setCurrentX(int $currentX) : Stream
Parameters
- $currentX : int
Return values
Stream —setCurrentY()
Set current Y
public
setCurrentY(int $currentY) : Stream
Parameters
- $currentY : int
Return values
Stream —setEdgeX()
Set edge X boundary
public
setEdgeX(int $edgeX) : Stream
Parameters
- $edgeX : int
Return values
Stream —setEdgeY()
Set edge Y boundary
public
setEdgeY(int $edgeY) : Stream
Parameters
- $edgeY : int
Return values
Stream —setStartX()
Set start X
public
setStartX(int $startX) : Stream
Parameters
- $startX : int
Return values
Stream —setStartY()
Set start Y
public
setStartY(int $startY) : Stream
Parameters
- $startY : int