Documentation

Parser
in package

Pdf HTML parser class

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

https://www.popphp.org/license New BSD License

version
6.0.0

Table of Contents

Properties

$css  : Css|null
CSS object
$defaultStyles  : array<string|int, mixed>
Default styles
$document  : Document
PDF document
$fileDir  : string|null
HTML file directory
$html  : Child|array<string|int, mixed>|null
HTML object or array of HTML objects
$page  : Page|null
Current page object
$pageMargins  : array<string|int, mixed>
Page margins
$pageSize  : string|array<string|int, mixed>
Page size
$textWrap  : Wrap|null
Text wrap object
$x  : int
Current x-position
$y  : int
Current y-position
$yOverride  : int|null
Y-override

Methods

__construct()  : mixed
Constructor
document()  : Document
Get document (alias)
drawBox()  : void
Draw a background-filled and/or bordered box
getCss()  : Css|null
Get styles
getCurrentY()  : int
Get current Y-position
getDefaultStyle()  : string|null
Get a default style
getDefaultStyles()  : array<string|int, mixed>
Get default styles
getDocument()  : Document
Get document
getHtml()  : array<string|int, mixed>|Child|null
Get HTML nodes
getPage()  : Page|null
Get the current page
getPageBottomMargin()  : int
Get page bottom margin
getPageLeftMargin()  : int
Get page left margin
getPageMargins()  : array<string|int, mixed>
Get page margins
getPageRightMargin()  : int
Get page right margin
getPageSize()  : string|array<string|int, mixed>
Get page size
getPageTopMargin()  : int
Get page top margin
getStringLines()  : array<string|int, mixed>
Get string lines
getX()  : int
Get x-position
getY()  : int
Get y-position
newPage()  : int
Create new page
parseCss()  : Parser
Parse CSS string
parseCssFile()  : Parser
Parse CSS file
parseCssUri()  : Parser
Parse CSS URI
parseFile()  : Parser
Parse $html from file
parseHtml()  : Parser
Parse HTML string
parseHtmlFile()  : Parser
Parse HTML string from file
parseHtmlUri()  : Parser
Parse HTML string from URI
parseString()  : Parser
Parse HTML string
parseUri()  : Parser
Parse $html from URI
prepare()  : array<string|int, mixed>|Child|null
Prepare for conversion of HTML into PDF objects
prepareNodeStyles()  : array<string|int, mixed>
Prepare node styles
process()  : Document
Process conversion of HTML into PDF objects
setDefaultStyle()  : Parser
Set a default style
setDocument()  : Parser
Set document
setPageBottomMargin()  : Parser
Set page bottom margin
setPageLeftMargin()  : Parser
Set page left margin
setPageMargins()  : Parser
Set page margins
setPageRightMargin()  : Parser
Set page right margin
setPageSize()  : Parser
Set page size
setPageTopMargin()  : Parser
Set page top margin
setX()  : Parser
Set x-position
setY()  : Parser
Set y-position
setYOverride()  : Parser
Set the y-position override for the next node (mirrors the mechanism already used internally for multi-page paragraph overflow)
addNodeToDocument()  : void
Add node to document
createDefaultStyles()  : void
Create default styles
getCurrentX()  : int
Get current X-position
parseCssColorToRgbArray()  : array<string|int, mixed>
Parse a CSS color string into an RGB array, tolerating a value that Color::parse() already resolves to Color\Rgb (which has no toRgb() method to convert from itself)
resetY()  : int
Reset Y-position
toRgbColor()  : Rgb
Normalize any Color\ColorInterface value to Color\Rgb

Properties

$defaultStyles

Default styles

protected array<string|int, mixed> $defaultStyles = ['font-family' => 'Arial', 'font-size' => 10, 'font-weight' => 'normal', 'color' => [0, 0, 0], 'line-height' => 14]

$fileDir

HTML file directory

protected string|null $fileDir = null

$html

HTML object or array of HTML objects

protected Child|array<string|int, mixed>|null $html = null

$page

Current page object

protected Page|null $page = null

$pageMargins

Page margins

protected array<string|int, mixed> $pageMargins = ['top' => 80, 'right' => 60, 'bottom' => 60, 'left' => 60]

$pageSize

Page size

protected string|array<string|int, mixed> $pageSize = 'LETTER'

$textWrap

Text wrap object

protected Wrap|null $textWrap = null

$x

Current x-position

protected int $x = 0

$y

Current y-position

protected int $y = 0

$yOverride

Y-override

protected int|null $yOverride = null

Methods

__construct()

Constructor

public __construct([Document $document = new Document() ]) : mixed

Instantiate the HTML parser object

Parameters
$document : Document = new Document()

drawBox()

Draw a background-filled and/or bordered box

public drawBox(float $x, float $topY, float $width, float $height, array<string|int, mixed> $styles) : void
Parameters
$x : float
$topY : float
$width : float
$height : float
$styles : array<string|int, mixed>

getCss()

Get styles

public getCss() : Css|null
Return values
Css|null

getCurrentY()

Get current Y-position

public getCurrentY([int $marginBottom = 0 ]) : int
Parameters
$marginBottom : int = 0
Return values
int

getDefaultStyle()

Get a default style

public getDefaultStyle(string $property) : string|null
Parameters
$property : string
Return values
string|null

getDefaultStyles()

Get default styles

public getDefaultStyles() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHtml()

Get HTML nodes

public getHtml() : array<string|int, mixed>|Child|null
Return values
array<string|int, mixed>|Child|null

getPage()

Get the current page

public getPage() : Page|null
Return values
Page|null

getPageBottomMargin()

Get page bottom margin

public getPageBottomMargin() : int
Return values
int

getPageLeftMargin()

Get page left margin

public getPageLeftMargin() : int
Return values
int

getPageMargins()

Get page margins

public getPageMargins() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPageRightMargin()

Get page right margin

public getPageRightMargin() : int
Return values
int

getPageSize()

Get page size

public getPageSize() : string|array<string|int, mixed>
Return values
string|array<string|int, mixed>

getPageTopMargin()

Get page top margin

public getPageTopMargin() : int
Return values
int

getStringLines()

Get string lines

public getStringLines(string $string, int $fontSize, int $wrapLength, Font $fontObject) : array<string|int, mixed>
Parameters
$string : string
$fontSize : int
$wrapLength : int
$fontObject : Font
Return values
array<string|int, mixed>

getX()

Get x-position

public getX() : int
Return values
int

getY()

Get y-position

public getY() : int
Return values
int

newPage()

Create new page

public newPage() : int
Return values
int

parseCss()

Parse CSS string

public parseCss(string $cssString) : Parser
Parameters
$cssString : string
Return values
Parser

parseCssFile()

Parse CSS file

public parseCssFile(string $cssFile) : Parser
Parameters
$cssFile : string
Tags
throws
Exception
Return values
Parser

parseCssUri()

Parse CSS URI

public parseCssUri(string $cssUri) : Parser
Parameters
$cssUri : string
Return values
Parser

parseFile()

Parse $html from file

public static parseFile(string $htmlFile[, Document $document = new Document() ]) : Parser
Parameters
$htmlFile : string
$document : Document = new Document()
Tags
throws
Exception
Return values
Parser

parseHtml()

Parse HTML string

public parseHtml(string $htmlString[, string|null $basePath = null ]) : Parser
Parameters
$htmlString : string
$basePath : string|null = null
Return values
Parser

parseHtmlFile()

Parse HTML string from file

public parseHtmlFile(string $htmlFile) : Parser
Parameters
$htmlFile : string
Tags
throws
Exception
Return values
Parser

parseHtmlUri()

Parse HTML string from URI

public parseHtmlUri(string $htmlUri) : Parser
Parameters
$htmlUri : string
Return values
Parser

parseString()

Parse HTML string

public static parseString(string $htmlString[, Document $document = new Document() ]) : Parser
Parameters
$htmlString : string
$document : Document = new Document()
Return values
Parser

parseUri()

Parse $html from URI

public static parseUri(string $htmlUri[, Document $document = new Document() ]) : Parser
Parameters
$htmlUri : string
$document : Document = new Document()
Return values
Parser

prepare()

Prepare for conversion of HTML into PDF objects

public prepare() : array<string|int, mixed>|Child|null
Return values
array<string|int, mixed>|Child|null

prepareNodeStyles()

Prepare node styles

public prepareNodeStyles(string $name[, array<string|int, mixed> $attribs = [] ][, array<string|int, mixed> $currentStyles = [] ]) : array<string|int, mixed>
Parameters
$name : string
$attribs : array<string|int, mixed> = []
$currentStyles : array<string|int, mixed> = []
Tags
throws
Exception
Return values
array<string|int, mixed>

setDefaultStyle()

Set a default style

public setDefaultStyle(string $property, string $value) : Parser
Parameters
$property : string
$value : string
Return values
Parser

setPageBottomMargin()

Set page bottom margin

public setPageBottomMargin(int $margin) : Parser
Parameters
$margin : int
Return values
Parser

setPageLeftMargin()

Set page left margin

public setPageLeftMargin(int $margin) : Parser
Parameters
$margin : int
Return values
Parser

setPageMargins()

Set page margins

public setPageMargins(int $top, int $right, int $bottom, int $left) : Parser
Parameters
$top : int
$right : int
$bottom : int
$left : int
Return values
Parser

setPageRightMargin()

Set page right margin

public setPageRightMargin(int $margin) : Parser
Parameters
$margin : int
Return values
Parser

setPageSize()

Set page size

public setPageSize(mixed $size[, mixed $height = null ]) : Parser
Parameters
$size : mixed
$height : mixed = null
Return values
Parser

setPageTopMargin()

Set page top margin

public setPageTopMargin(int $margin) : Parser
Parameters
$margin : int
Return values
Parser

setX()

Set x-position

public setX(int $x) : Parser
Parameters
$x : int
Return values
Parser

setY()

Set y-position

public setY(int $y) : Parser
Parameters
$y : int
Return values
Parser

setYOverride()

Set the y-position override for the next node (mirrors the mechanism already used internally for multi-page paragraph overflow)

public setYOverride(int|null $y) : Parser
Parameters
$y : int|null
Return values
Parser

addNodeToDocument()

Add node to document

protected addNodeToDocument(Child $child[, int $i = 0 ]) : void
Parameters
$child : Child
$i : int = 0
Tags
throws
Exception|Exception

createDefaultStyles()

Create default styles

protected createDefaultStyles() : void

getCurrentX()

Get current X-position

protected getCurrentX() : int
Return values
int

parseCssColorToRgbArray()

Parse a CSS color string into an RGB array, tolerating a value that Color::parse() already resolves to Color\Rgb (which has no toRgb() method to convert from itself)

protected parseCssColorToRgbArray(string $colorString) : array<string|int, mixed>
Parameters
$colorString : string
Return values
array<string|int, mixed>

resetY()

Reset Y-position

protected resetY() : int
Return values
int

toRgbColor()

Normalize any Color\ColorInterface value to Color\Rgb

protected toRgbColor(ColorInterface $color) : Rgb

ColorInterface doesn't declare toRgb() (Color\Rgb has no such method to convert from itself), so every other concrete color type it might resolve to is matched explicitly here.

Parameters
$color : ColorInterface
Return values
Rgb 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results