FacturaScripts

ExportManager
in package

Description of ExportManager

Tags
author

Carlos García Gómez [email protected]

Table of Contents

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

Properties

$options

Option list.

protected static array<string|int, mixed> $options = []

$optionsModels

protected static array<string|int, mixed> $optionsModels = []

$orientation

Default document orientation.

protected string $orientation

$tools

Tools list.

protected static array<string|int, mixed> $tools = []

Methods

__construct()

ExportManager constructor.

public __construct() : mixed
Return values
mixed

addBusinessDocPage()

Adds a new page with the document data.

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

addListModelPage()

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

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

addModelPage()

Adds a new page with the model data.

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

addOption()

Adds a new option.

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

addOptionModel()

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

addTablePage()

Adds a new page with the table data.

public addTablePage(array<string|int, mixed> $headers, array<string|int, mixed> $rows[, array<string|int, mixed> $options = [] ][, string $title = '' ]) : bool
Parameters
$headers : array<string|int, mixed>
$rows : array<string|int, mixed>
$options : array<string|int, mixed> = []
$title : string = ''
Return values
bool

addTool()

Adds a new tool.

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

defaultOption()

Returns default option.

public static defaultOption() : string
Return values
string

getDoc()

Return generated doc.

public getDoc() : mixed
Return values
mixed

getFormats()

public getFormats(object $model) : array<string|int, mixed>
Parameters
$model : object
Return values
array<string|int, mixed>

newDoc()

Create a new doc and set headers.

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

options()

returns options to export.

public static options() : array<string|int, mixed>
Return values
array<string|int, mixed>

setOrientation()

Sets default orientation.

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

show()

Returns the formatted data.

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

tools()

public static tools() : array<string|int, mixed>
Return values
array<string|int, mixed>

init()

Initialize options array

protected static init() : mixed
Return values
mixed

getExportClassName()

Returns the full class name.

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

Search results