Documentation

Renderer extends AbstractRenderer
in package

Concrete renderer

Instantiates several specific renderers in order to render any given frame.

Table of Contents

$_canvas  : Canvas
Rendering backend
$_dompdf  : Dompdf
Current dompdf instance
$_renderers  : array<string|int, AbstractRenderer>
Array of renderers for specific frame types
$_callbacks  : array<string|int, mixed>
Cache of the callbacks array
__construct()  : mixed
Class constructor
new_page()  : mixed
Advance the canvas to the next page
render()  : mixed
Render frames recursively
_apply_ratio()  : mixed
_background_image()  : mixed
Render a background image over a rectangular area
_border_dashed()  : mixed
_border_dotted()  : mixed
_border_double()  : mixed
_border_groove()  : mixed
_border_hidden()  : mixed
_border_inset()  : mixed
_border_line()  : mixed
Draws a solid, dotted, or dashed line, observing the border radius
_border_none()  : mixed
_border_outset()  : mixed
_border_ridge()  : mixed
_border_solid()  : mixed
_check_callbacks()  : mixed
Check for callbacks that need to be performed when a given event gets triggered on a frame
_debug_layout()  : mixed
_get_dash_pattern()  : array<string|int, mixed>
_render_frame()  : mixed
Render a single frame
_resize_background_image()  : array<string|int, mixed>
_set_opacity()  : mixed
_shade()  : mixed
_tint()  : mixed

Properties

$_callbacks

Cache of the callbacks array

private array<string|int, mixed> $_callbacks

Methods

__construct()

Class constructor

public __construct(Dompdf $dompdf) : mixed
Parameters
$dompdf : Dompdf

The current dompdf instance

Return values
mixed —

new_page()

Advance the canvas to the next page

public new_page() : mixed
Return values
mixed —

render()

Render frames recursively

public render(Frame $frame) : mixed
Parameters
$frame : Frame

the frame to render

Return values
mixed —

_apply_ratio()

protected _apply_ratio( $side,  $ratio,  $top,  $right,  $bottom,  $left,  &$x,  &$y,  &$length,  &$r1,  &$r2) : mixed
Parameters
$side :
$ratio :
$top :
$right :
$bottom :
$left :
$x :
$y :
$length :
$r1 :
$r2 :
Return values
mixed —

_background_image()

Render a background image over a rectangular area

protected _background_image(string $url, float $x, float $y, float $width, float $height, Style $style) : mixed
Parameters
$url : string

The background image to load

$x : float

The left edge of the rectangular area

$y : float

The top edge of the rectangular area

$width : float

The width of the rectangular area

$height : float

The height of the rectangular area

$style : Style

The associated Style object

Tags
throws
Exception
Return values
mixed —

_border_dashed()

protected _border_dashed( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_dotted()

protected _border_dotted( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_double()

protected _border_double( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_groove()

protected _border_groove( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_hidden()

protected _border_hidden( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_inset()

protected _border_inset( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_line()

Draws a solid, dotted, or dashed line, observing the border radius

protected _border_line( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ],  $pattern_name, int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$pattern_name :
$r1 : int
$r2 : int
Return values
mixed —

_border_none()

protected _border_none( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_outset()

protected _border_outset( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_ridge()

protected _border_ridge( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_border_solid()

protected _border_solid( $x,  $y,  $length,  $color,  $widths,  $side[, string $corner_style = "bevel" ], int $r1, int $r2) : mixed
Parameters
$x :
$y :
$length :
$color :
$widths :
$side :
$corner_style : string = "bevel"
$r1 : int
$r2 : int
Return values
mixed —

_check_callbacks()

Check for callbacks that need to be performed when a given event gets triggered on a frame

protected _check_callbacks(string $event, Frame $frame) : mixed
Parameters
$event : string

the type of event

$frame : Frame

the frame that event is triggered on

Return values
mixed —

_debug_layout()

protected _debug_layout( $box[, string $color = "red" ][, array<string|int, mixed> $style = [] ]) : mixed
Parameters
$box :
$color : string = "red"
$style : array<string|int, mixed> = []
Return values
mixed —

_get_dash_pattern()

protected _get_dash_pattern( $style,  $width) : array<string|int, mixed>
Parameters
$style :
$width :
Return values
array<string|int, mixed> —

_render_frame()

Render a single frame

protected _render_frame(string $type, Frame $frame) : mixed

Creates Renderer objects on demand

Parameters
$type : string

type of renderer to use

$frame : Frame

the frame to render

Return values
mixed —

_resize_background_image()

protected _resize_background_image(float $img_width, float $img_height, float $container_width, float $container_height, array<string|int, mixed>|string $bg_resize, int $dpi) : array<string|int, mixed>
Parameters
$img_width : float
$img_height : float
$container_width : float
$container_height : float
$bg_resize : array<string|int, mixed>|string
$dpi : int
Return values
array<string|int, mixed> —

_set_opacity()

protected _set_opacity( $opacity) : mixed
Parameters
$opacity :
Return values
mixed —

_shade()

protected _shade( $c) : mixed
Parameters
$c :
Return values
mixed —

_tint()

protected _tint( $c) : mixed
Parameters
$c :
Return values
mixed —

Search results