PHP Class nwtn\RespimgCaptureRequest

Extends the normal request to pass information relevant to rendering/saving an SVG.
Author: David Newton ([email protected])
Inheritance: extends JonnyW\PhantomJs\Message\Request
Show file Open project: nwtn/php-respimg Class Usage Examples

Protected Properties

Property Type Description
$height integer Height of PNG output
$rasterFile string Path/filename of output image
$svgdata string SVG data
$width integer Width of PNG output

Public Methods

Method Description
getHeight ( ) : integer Get height.
getRasterFile ( ) : string Get the path/filename of the output PNG
getSVG ( ) : string Get SVG data.
getWidth ( ) : integer Get width.
setHeight ( integer $height ) : JonnyW\PhantomJs\Message\AbstractRequest Set height.
setRasterFile ( string $file ) : JonnyW\PhantomJs\Message\CaptureRequest Set the path/filename of the output PNG
setSVG ( string $svgdata ) : string Set SVG data
setWidth ( integer $width ) : JonnyW\PhantomJs\Message\AbstractRequest Set width.

Method Details

getHeight() public method

Get height.
public getHeight ( ) : integer
return integer

getRasterFile() public method

Get the path/filename of the output PNG
public getRasterFile ( ) : string
return string

getSVG() public method

Get SVG data.
public getSVG ( ) : string
return string

getWidth() public method

Get width.
public getWidth ( ) : integer
return integer

setHeight() public method

Set height.
public setHeight ( integer $height ) : JonnyW\PhantomJs\Message\AbstractRequest
$height integer Height
return JonnyW\PhantomJs\Message\AbstractRequest

setRasterFile() public method

Set the path/filename of the output PNG
public setRasterFile ( string $file ) : JonnyW\PhantomJs\Message\CaptureRequest
$file string The path/filename
return JonnyW\PhantomJs\Message\CaptureRequest

setSVG() public method

This sets the base64-encoded SVG data, which will be used to build a data URI.
public setSVG ( string $svgdata ) : string
$svgdata string base64-encoded SVG data
return string

setWidth() public method

Set width.
public setWidth ( integer $width ) : JonnyW\PhantomJs\Message\AbstractRequest
$width integer Width
return JonnyW\PhantomJs\Message\AbstractRequest

Property Details

$height protected property

Height of PNG output
protected int $height
return integer

$rasterFile protected property

Path/filename of output image
protected string $rasterFile
return string

$svgdata protected property

SVG data
protected string $svgdata
return string

$width protected property

Width of PNG output
protected int $width
return integer