PHP Class Fireguard\Report\Exporters\AbstractExporter

Inheritance: implements Fireguard\Report\Contracts\ExporterContract
Show file Open project: fireguard/report

Protected Properties

Property Type Description
$config array
$configDefaultOptions array Config Default Options file to Exporter Format
$configValidOptions array Config Valid Options file to Exporter Format
$extension string
$fileName string
$path string Path for save file
$timeout integer Time for expire process

Public Methods

Method Description
__construct ( string $path = '', string $fileName = '', array $config = [] ) ExporterContract constructor.
compress ( $buffer ) : mixed Compress html e js removed comments e break lines
configure ( array $config ) : Fireguard\Report\Contracts\ExporterContract
generate ( Fireguard\Report\Contracts\ReportContract $report ) : string
getConfigDefaultOptions ( ) : array
getConfigValidOptions ( ) : array
getDefaultConfiguration ( )
getFileName ( ) : string
getFullPath ( ) : string
getMimeType ( ) : string
getPath ( ) : string
getTimeout ( ) : integer
response ( Fireguard\Report\Contracts\ReportContract $report, boolean $forceDownload = false ) : Response
setConfigDefaultOptions ( array $options ) : Fireguard\Report\Contracts\ExporterContract
setConfigValidOptions ( array $options ) : Fireguard\Report\Contracts\ExporterContract
setFileName ( $fileName ) : Fireguard\Report\Contracts\ExporterContract
setPath ( string $path, unix_permission $mode = 511 ) : Fireguard\Report\Contracts\ExporterContract
setTimeout ( integer $timeout ) : Fireguard\Report\Contracts\ExporterContract

Method Details

__construct() public method

ExporterContract constructor.
public __construct ( string $path = '', string $fileName = '', array $config = [] )
$path string
$fileName string
$config array

compress() public method

Compress html e js removed comments e break lines
public compress ( $buffer ) : mixed
$buffer
return mixed

configure() abstract public method

abstract public configure ( array $config ) : Fireguard\Report\Contracts\ExporterContract
$config array
return Fireguard\Report\Contracts\ExporterContract

generate() abstract public method

abstract public generate ( Fireguard\Report\Contracts\ReportContract $report ) : string
$report Fireguard\Report\Contracts\ReportContract
return string

getConfigDefaultOptions() public method

public getConfigDefaultOptions ( ) : array
return array

getConfigValidOptions() public method

public getConfigValidOptions ( ) : array
return array

getDefaultConfiguration() public method

public getDefaultConfiguration ( )

getFileName() public method

public getFileName ( ) : string
return string

getFullPath() public method

public getFullPath ( ) : string
return string

getMimeType() abstract public method

abstract public getMimeType ( ) : string
return string

getPath() public method

public getPath ( ) : string
return string

getTimeout() public method

public getTimeout ( ) : integer
return integer

response() public method

public response ( Fireguard\Report\Contracts\ReportContract $report, boolean $forceDownload = false ) : Response
$report Fireguard\Report\Contracts\ReportContract
$forceDownload boolean
return Symfony\Component\HttpFoundation\Response

setConfigDefaultOptions() public method

public setConfigDefaultOptions ( array $options ) : Fireguard\Report\Contracts\ExporterContract
$options array
return Fireguard\Report\Contracts\ExporterContract

setConfigValidOptions() public method

public setConfigValidOptions ( array $options ) : Fireguard\Report\Contracts\ExporterContract
$options array
return Fireguard\Report\Contracts\ExporterContract

setFileName() public method

public setFileName ( $fileName ) : Fireguard\Report\Contracts\ExporterContract
$fileName
return Fireguard\Report\Contracts\ExporterContract

setPath() public method

public setPath ( string $path, unix_permission $mode = 511 ) : Fireguard\Report\Contracts\ExporterContract
$path string
$mode unix_permission Permission
return Fireguard\Report\Contracts\ExporterContract

setTimeout() public method

public setTimeout ( integer $timeout ) : Fireguard\Report\Contracts\ExporterContract
$timeout integer
return Fireguard\Report\Contracts\ExporterContract

Property Details

$config protected property

protected array $config
return array

$configDefaultOptions protected property

Config Default Options file to Exporter Format
protected array $configDefaultOptions
return array

$configValidOptions protected property

Config Valid Options file to Exporter Format
protected array $configValidOptions
return array

$extension protected property

protected string $extension
return string

$fileName protected property

protected string $fileName
return string

$path protected property

Path for save file
protected string $path
return string

$timeout protected property

Time for expire process
protected int $timeout
return integer