ImageRenderer
abstract class ImageRenderer extends Renderer
Properties
| protected string | $format | from Renderer | |
| protected string | $extension | from Renderer | |
| protected array | $options | from Renderer |
Methods
Sets the devicePixelRatio of the viewport
Waits until the entire document, including resources are fully loaded.
Waits until the 'DOMContentLoaded' event is fired.
Waits until there has not been any network requests for at least 500ms
Waits until there has not been more than 2 network requests for at least 500ms
Maximum amount of time to wait before timing out in milliseconds. Defaults to 30000
Retrieve the rendered content as a download response
Retrieve the rendered content as a response
Render from a view
Render from named route.
Screenshot the entire page, also content outside visible viewport
Specifies a CSS selector for capturing a specific element.
Clip the screenshot
Viewport width. Default 1920
Viewport height. Default 1080
Details
in
Renderer at line 49
protected
__construct(string $url, array $options = [])
in
Renderer at line 61
protected ResponseInterface
fetch()
in
Renderer at line 97
protected
getOption(string $key, $default = null)
in
Renderer at line 112
Renderer
devicePixelRatio(float $pixelRatio = 1.0)
Sets the devicePixelRatio of the viewport
in
Renderer at line 122
Renderer
waitUntilLoaded()
Waits until the entire document, including resources are fully loaded.
in
Renderer at line 132
Renderer
waitUntiDOMContentLoaded()
Waits until the 'DOMContentLoaded' event is fired.
in
Renderer at line 142
Renderer
waitUntiNetworkIdle()
Waits until there has not been any network requests for at least 500ms
in
Renderer at line 152
Renderer
waitUntiNetworkSettled()
Waits until there has not been more than 2 network requests for at least 500ms
in
Renderer at line 163
Renderer
timeout(int $timeout)
Maximum amount of time to wait before timing out in milliseconds. Defaults to 30000
in
Renderer at line 173
resource
stream()
Get the rendered content as a file handle (resource)
in
Renderer at line 186
string|null
blob()
Get the rendered content as a blob
in
Renderer at line 201
Response
download(string $filename = null)
Retrieve the rendered content as a download response
in
Renderer at line 226
Response
toResponse(Request $request = null)
Retrieve the rendered content as a response
in
Renderer at line 246
string
link()
Retrieve URL to the rendered content
in
Renderer at line 294
static Renderer
view(View|string $view, Arrayable|array $data = [], array $mergeData = [])
Render from a view
in
Renderer at line 311
static Renderer
route(array|string $name = null, mixed $parameters = [], bool $absolute = true)
Render from named route.
in
Renderer at line 319
array
__debugInfo()
in
Renderer at line 327
string
__toString()
in
Renderer at line 335
string
jsonSerialize()
in
Renderer at line 344
string
toJson(int $options = 0)
at line 15
ImageRenderer
fullPage(bool $fullPage = true)
Screenshot the entire page, also content outside visible viewport
at line 30
ImageRenderer
selector(string $selector)
Specifies a CSS selector for capturing a specific element.
at line 44
ImageRenderer
clip(int $x, int $y, int $width, int $height)
Clip the screenshot
at line 64
ImageRenderer
width(int $width = 1920)
Viewport width. Default 1920
at line 75
ImageRenderer
height(int $height = 1080)
Viewport height. Default 1080