PHP Class Fireguard\Report\Exporters\AbstractPhantomExporter

Inheritance: extends AbstractExporter

Show file Open project: fireguard/report Class Usage Examples

Protected Properties

Property	Type	Description
$binaryPath		Path for executable converter html to pdf
$commandOptions		PhantomJs Params
$configValidOptions
$format	string
$htmlBodyPath
$htmlFooter
$htmlHeader
$orientation		['landscape', 'portrait']
$validFormats

Public Methods

Method	Description
addCommandOption ( string $option, string $value ) : AbstractPhantomExporter
getBinaryPath ( ) : string
getCommandOptions ( ) : array
getFooterHeight ( )
getFormat ( ) : string
getHeaderHeight ( )
getMargin ( ) : string
getOrientation ( ) : string
mountCommandOptions ( ) : string
mountScriptForExport ( ) : string
prefixOsPath ( string $path, string $operationalSystem = PHP_OS ) : string	Prefix the input path for windows versions of PhantomJS
setBinaryPath ( $binaryPath ) : AbstractPhantomExporter
setCommandOptions ( array $options ) : AbstractPhantomExporter
setFormat ( string $format ) : AbstractPhantomExporter
setMargin ( string $margin ) : AbstractPhantomExporter
setOrientation ( $orientation ) : AbstractPhantomExporter

Protected Methods

Method	Description
createHtmlFiles ( Fireguard\Report\Contracts\ReportContract $report )
getFooterScript ( )
getHeaderScript ( )
getScript ( $html, $heigth )
getViewPortHeight ( )
getViewPortWidth ( )
processInlineHtml ( $html )
saveFinishFile ( )

Method Details

addCommandOption() public method

public addCommandOption ( string $option, string $value ) : AbstractPhantomExporter
$option	string
$value	string
return	AbstractPhantomExporter

createHtmlFiles() protected method

protected createHtmlFiles ( Fireguard\Report\Contracts\ReportContract $report )
$report	Fireguard\Report\Contracts\ReportContract

getBinaryPath() public method

public getBinaryPath ( ) : string
return	string

getCommandOptions() public method

public getCommandOptions ( ) : array
return	array

getFooterHeight() public method

public getFooterHeight ( )

getFooterScript() protected method

protected getFooterScript ( )

getFormat() public method

public getFormat ( ) : string
return	string

getHeaderHeight() public method

public getHeaderHeight ( )

getHeaderScript() protected method

protected getHeaderScript ( )

getMargin() public method

public getMargin ( ) : string
return	string

getOrientation() public method

public getOrientation ( ) : string
return	string

getScript() protected method

protected getScript ( $html, $heigth )

getViewPortHeight() protected method

protected getViewPortHeight ( )

getViewPortWidth() protected method

protected getViewPortWidth ( )

mountCommandOptions() public method

public mountCommandOptions ( ) : string
return	string	Command line string

mountScriptForExport() public method

public mountScriptForExport ( ) : string
return	string	Path for generated script

prefixOsPath() public method

Prefix the input path for windows versions of PhantomJS

public prefixOsPath ( string $path, string $operationalSystem = PHP_OS ) : string
$path	string
$operationalSystem	string
return	string

processInlineHtml() protected method

protected processInlineHtml ( $html )

saveFinishFile() protected method

protected saveFinishFile ( )

setBinaryPath() public method

public setBinaryPath ( $binaryPath ) : AbstractPhantomExporter
$binaryPath
return	AbstractPhantomExporter

setCommandOptions() public method

public setCommandOptions ( array $options ) : AbstractPhantomExporter
$options	array
return	AbstractPhantomExporter

setFormat() public method

public setFormat ( string $format ) : AbstractPhantomExporter
$format	string
return	AbstractPhantomExporter

setMargin() public method

public setMargin ( string $margin ) : AbstractPhantomExporter
$margin	string
return	AbstractPhantomExporter

setOrientation() public method

public setOrientation ( $orientation ) : AbstractPhantomExporter
$orientation
return	AbstractPhantomExporter

Property Details

$binaryPath protected property

Path for executable converter html to pdf

protected $binaryPath

$commandOptions protected property

PhantomJs Params

protected $commandOptions

$configValidOptions protected property

protected $configValidOptions

$format protected property

protected string $format
return	string

$htmlBodyPath protected property

protected $htmlBodyPath

$htmlFooter protected property

protected $htmlFooter

$htmlHeader protected property

protected $htmlHeader

$orientation protected property

['landscape', 'portrait']

protected $orientation

$validFormats protected property

protected $validFormats