FacturaScripts

ExportManager extends ExportManager

Class created by Core/Base/PluginManager

Table of Contents

$engine The selected engine/class to export. ExportBase
$options Option list. array
$optionsModels array
$orientation Default document orientation. string
$selectedLang string
$selectedOption string
$selectedTitle string
$tools Tools list. array
__construct() ExportManager constructor. mixed
addBusinessDocPage() Adds a new page with the document data. bool
addListModelPage() Adds a new page with a table listing the models data. bool
addModelPage() Adds a new page with the model data. bool
addOption() Adds a new option. mixed
addOptionModel() mixed
addTool() Adds a new tool. mixed
addTablePage() Adds a new page with the table data. bool
defaultOption() Returns default option. string
getDoc() Return generated doc. mixed
getFormats() array
newDoc() Create a new doc and set headers. mixed
options() returns options to export. array
setOrientation() Sets default orientation. mixed
show() Returns the formatted data. mixed
tools() array
getExportClassName() Returns the full class name. string
init() Initialize options array mixed

Properties

$orientation

Default document orientation.

protected string $orientation

Methods

__construct()

ExportManager constructor.

public __construct( ) : mixed
Return values
mixed

addBusinessDocPage()

Adds a new page with the document data.

public addBusinessDocPage( $model : mixed ) : bool
Parameters
$model : mixed
Return values
bool

addListModelPage()

Adds a new page with a table listing the models data.

public addListModelPage( $model : mixed , $where : array , $order : array , $offset : int , $columns : array [, $title : string = '' ] ) : bool
Parameters
$model : mixed
$where : array
$order : array
$offset : int
$columns : array
$title : string = ''
Return values
bool

addModelPage()

Adds a new page with the model data.

public addModelPage( $model : mixed , $columns : array [, $title : string = '' ] ) : bool
Parameters
$model : mixed
$columns : array
$title : string = ''
Return values
bool

addOption()

Adds a new option.

public static addOption( $key : string , $description : string , $icon : string ) : mixed
Parameters
$key : string
$description : string
$icon : string
Return values
mixed

addOptionModel()

public static addOptionModel( $exportClassName : string , $optionKey : string , $modelName : string , $priority : int ) : mixed
Parameters
$exportClassName : string
$optionKey : string
$modelName : string
$priority : int
Return values
mixed

addTool()

Adds a new tool.

public static addTool( $key : string , $link : string , $description : string , $icon : string ) : mixed
Parameters
$key : string
$link : string
$description : string
$icon : string
Return values
mixed

addTablePage()

Adds a new page with the table data.

public addTablePage( $headers : array , $rows : array ) : bool
Parameters
$headers : array
$rows : array
Return values
bool

defaultOption()

Returns default option.

public static defaultOption( ) : string
Return values
string

getDoc()

Return generated doc.

public getDoc( ) : mixed
Return values
mixed

getFormats()

public getFormats( $model : object ) : array
Parameters
$model : object
Return values
array

newDoc()

Create a new doc and set headers.

public newDoc( $option : string [, $title : string = '' ] , $format : int [, $lang : string = '' ] ) : mixed
Parameters
$option : string
$title : string = ''
$format : int
$lang : string = ''
Return values
mixed

options()

returns options to export.

public static options( ) : array
Return values
array

setOrientation()

Sets default orientation.

public setOrientation( $orientation : string ) : mixed
Parameters
$orientation : string
Return values
mixed

show()

Returns the formatted data.

public show( &$response : Response ) : mixed
Parameters
$response : Response
Return values
mixed

getExportClassName()

Returns the full class name.

private getExportClassName( $option : string ) : string
Parameters
$option : string
Return values
string

init()

Initialize options array

protected static init( ) : mixed
Return values
mixed

Search results