1. class
  2. Netflex
  3. \
  4. Render
  5. \
  6. MJML

MJML

class MJML extends Renderer

Properties

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

Methods

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

No description

from  Renderer
ResponseInterface
fetch()

No description

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

Set option

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

No description

from  Renderer
Renderer
devicePixelRatio(float $pixelRatio = 1.0)

Sets the devicePixelRatio of the viewport

from  Renderer
Renderer
waitUntilLoaded()

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

from  Renderer
Renderer
waitUntiDOMContentLoaded()

Waits until the 'DOMContentLoaded' event is fired.

from  Renderer
Renderer
waitUntiNetworkIdle()

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

from  Renderer
Renderer
waitUntiNetworkSettled()

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

from  Renderer
Renderer
timeout(int $timeout)

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

from  Renderer
resource
stream()

Get the rendered content as a file handle (resource)

from  Renderer
string|null
blob()

Get the rendered content as a blob

Response
download(string $filename = null)

Retrieve the rendered content as a download response

from  Renderer
Response
toResponse(Request $request = null)

Retrieve the rendered content as a response

from  Renderer
string
link()

Retrieve URL to the rendered content

from  Renderer
ResponseInterface
postProcess(ResponseInterface $response)

Postprocessing stage

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

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

Render from a view

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
static 
withBlob($blob)

No description

Details

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

Parameters

string $url
array $options

in Renderer at line 62
protected ResponseInterface fetch()

Return Value

ResponseInterface

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

Set option

Parameters

string $key
mixed $value

Return Value

Renderer

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

Parameters

string $key
$default

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

Sets the devicePixelRatio of the viewport

Parameters

float $pixelRatio

Return Value

Renderer

in Renderer at line 133
Renderer waitUntilLoaded()

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

Return Value

Renderer

in Renderer at line 143
Renderer waitUntiDOMContentLoaded()

Waits until the 'DOMContentLoaded' event is fired.

Return Value

Renderer

in Renderer at line 153
Renderer waitUntiNetworkIdle()

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

Return Value

Renderer

in Renderer at line 163
Renderer waitUntiNetworkSettled()

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

Return Value

Renderer

in Renderer at line 174
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 184
resource stream()

Get the rendered content as a file handle (resource)

Return Value

resource

at line 34
string|null blob()

Get the rendered content as a blob

Return Value

string|null

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

Retrieve the rendered content as a download response

Parameters

string $filename

Return Value

Response

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

Retrieve the rendered content as a response

Parameters

Request $request

Return Value

Response

Retrieve URL to the rendered content

Return Value

string

in Renderer at line 276
protected ResponseInterface postProcess(ResponseInterface $response)

Postprocessing stage

Parameters

ResponseInterface $response

Return Value

ResponseInterface

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

Render from url external or interal

Parameters

string $url

Return Value

Renderer

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

Render from raw markup

Parameters

HtmlString|string $html

Return Value

Renderer

at line 51
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 336
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 344
array __debugInfo()

Return Value

array

in Renderer at line 352
string __toString()

Return Value

string

in Renderer at line 360
string jsonSerialize()

Return Value

string

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

Parameters

int $options

Return Value

string

at line 26
static protected withBlob($blob)

Parameters

$blob