class PNG extends ImageRenderer

Properties

protected string $format
protected string $extension from  Renderer
protected array $options from  Renderer

Methods

__construct(string $url, array $options = [])

No description

from  Renderer
ResponseInterface
fetch()

No description

from  Renderer
setOption(string $key, mixed $value)

Set option

from  Renderer
getOption(string $key, $default = null)

No description

from  Renderer
devicePixelRatio(float $pixelRatio = 1.0)

Sets the devicePixelRatio of the viewport

from  Renderer
waitUntilLoaded()

Waits until the entire document, including resources are fully loaded.

from  Renderer
waitUntiDOMContentLoaded()

Waits until the 'DOMContentLoaded' event is fired.

from  Renderer
waitUntiNetworkIdle()

Waits until there has not been any network requests for at least 500ms

from  Renderer
waitUntiNetworkSettled()

Waits until there has not been more than 2 network requests for at least 500ms

from  Renderer
timeout(int $timeout)

Maximum amount of time to wait before timing out in milliseconds. Defaults to 30000

from  Renderer
resource
stream()

No description

from  Renderer
string|null
blob()

No description

from  Renderer
Response
download(string $filename = null)

No description

from  Renderer
Response
toResponse(Request $request = null)

Retrieve the rendered content as a response

from  Renderer
string
link()

No description

from  Renderer
static Renderer
url(string $url)

Render from url external or interal

from  Renderer
static Renderer
from(HtmlString|string $html)

Render from raw markup

from  Renderer
static Renderer
view(View|string $view, Arrayable|array $data = [], array $mergeData = [])

Render from a view

from  Renderer
static Renderer
route(array|string $name = null, mixed $parameters = [], bool $absolute = true)

Render from named route.

from  Renderer
array
__debugInfo()

No description

from  Renderer
string
__toString()

No description

from  Renderer
string
jsonSerialize()

No description

from  Renderer
string
toJson(int $options = 0)

No description

from  Renderer
fullPage(bool $fullPage = true)

Screenshot the entire page, also content outside visible viewport

selector(string $selector)

Specifies a CSS selector for capturing a specific element.

clip(int $x, int $y, int $width, int $height)

Clip the screenshot

width(int $width = 1920)

Viewport width. Default 1920

height(int $height = 1080)

Viewport height. Default 1080

PNG
transparent(bool $transparent = true)

Preserves transparancy in output

Details

in Renderer at line 49
protected __construct(string $url, array $options = [])

Parameters

string $url
array $options

in Renderer at line 61
protected ResponseInterface fetch()

Return Value

ResponseInterface

in Renderer at line 82
protected Renderer setOption(string $key, mixed $value)

Set option

Parameters

string $key
mixed $value

Return Value

Renderer

in Renderer at line 97
protected getOption(string $key, $default = null)

Parameters

string $key
$default

in Renderer at line 112
Renderer devicePixelRatio(float $pixelRatio = 1.0)

Sets the devicePixelRatio of the viewport

Parameters

float $pixelRatio

Return Value

Renderer

in Renderer at line 122
Renderer waitUntilLoaded()

Waits until the entire document, including resources are fully loaded.

Return Value

Renderer

in Renderer at line 132
Renderer waitUntiDOMContentLoaded()

Waits until the 'DOMContentLoaded' event is fired.

Return Value

Renderer

in Renderer at line 142
Renderer waitUntiNetworkIdle()

Waits until there has not been any network requests for at least 500ms

Return Value

Renderer

in Renderer at line 152
Renderer waitUntiNetworkSettled()

Waits until there has not been more than 2 network requests for at least 500ms

Return Value

Renderer

in Renderer at line 163
Renderer timeout(int $timeout)

Maximum amount of time to wait before timing out in milliseconds. Defaults to 30000

Parameters

int $timeout

Return Value

Renderer

in Renderer at line 173
resource stream()

Return Value

resource

in Renderer at line 186
string|null blob()

Return Value

string|null

in Renderer at line 201
Response download(string $filename = null)

Parameters

string $filename

Return Value

Response

in Renderer at line 226
Response toResponse(Request $request = null)

Retrieve the rendered content as a response

Parameters

Request $request

Return Value

Response

Return Value

string

in Renderer at line 262
static Renderer url(string $url)

Render from url external or interal

Parameters

string $url

Return Value

Renderer

in Renderer at line 277
static Renderer from(HtmlString|string $html)

Render from raw markup

Parameters

HtmlString|string $html

Return Value

Renderer

in Renderer at line 294
static Renderer view(View|string $view, Arrayable|array $data = [], array $mergeData = [])

Render from a view

Parameters

View|string $view
Arrayable|array $data
array $mergeData

Return Value

Renderer

in Renderer at line 311
static Renderer route(array|string $name = null, mixed $parameters = [], bool $absolute = true)

Render from named route.

Parameters

array|string $name
mixed $parameters
bool $absolute

Return Value

Renderer

in Renderer at line 319
array __debugInfo()

Return Value

array

in Renderer at line 327
string __toString()

Return Value

string

in Renderer at line 335
string jsonSerialize()

Return Value

string

in Renderer at line 344
string toJson(int $options = 0)

Parameters

int $options

Return Value

string

in ImageRenderer at line 15
ImageRenderer fullPage(bool $fullPage = true)

Screenshot the entire page, also content outside visible viewport

Parameters

bool $fullPage

Return Value

ImageRenderer

in ImageRenderer at line 30
ImageRenderer selector(string $selector)

Specifies a CSS selector for capturing a specific element.

Parameters

string $selector

Return Value

ImageRenderer

in ImageRenderer at line 44
ImageRenderer clip(int $x, int $y, int $width, int $height)

Clip the screenshot

Parameters

int $x
int $y
int $width
int $height

Return Value

ImageRenderer

in ImageRenderer at line 64
ImageRenderer width(int $width = 1920)

Viewport width. Default 1920

Parameters

int $width

Return Value

ImageRenderer

in ImageRenderer at line 75
ImageRenderer height(int $height = 1080)

Viewport height. Default 1080

Parameters

int $height

Return Value

ImageRenderer

at line 18
PNG transparent(bool $transparent = true)

Preserves transparancy in output

Parameters

bool $transparent

Return Value

PNG