ExportManager
extends ExportManager
in package
Class created by Core/Internal/PluginsDeploy
Table of Contents
Properties
- $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.
Methods
- __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() : void
- Adds a new option.
- addOptionModel() : void
- addTablePage() : bool
- Adds a new page with the table data.
- addTool() : void
- Adds a new tool.
- defaultOption() : string
- Returns default option.
- getDoc() : mixed
- Return generated doc.
- getFormats() : array<string|int, mixed>
- newDoc() : void
- Create a new doc and set headers.
- options() : array<string|int, mixed>
- returns options to export.
- setCompany() : void
- setOrientation() : void
- Sets default orientation.
- show() : void
- Returns the formatted data.
- tools() : array<string|int, mixed>
- init() : void
- Initialize options array
Properties
$engine
The selected engine/class to export.
protected
static ExportBase
$engine
$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
$selectedLang
protected
static string
$selectedLang
$selectedOption
protected
static string
$selectedOption
$selectedTitle
protected
static string
$selectedTitle
$tools
Tools list.
protected
static array<string|int, mixed>
$tools
= []
Methods
__construct()
ExportManager constructor.
public
__construct() : mixed
addBusinessDocPage()
Adds a new page with the document data.
public
addBusinessDocPage(mixed $model) : bool
Parameters
- $model : mixed
Return values
booladdListModelPage()
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
booladdModelPage()
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
booladdOption()
Adds a new option.
public
static addOption(string $key, string $description, string $icon) : void
Parameters
- $key : string
- $description : string
- $icon : string
addOptionModel()
public
static addOptionModel(string $exportClassName, string $optionKey, string $modelName[, int $priority = 0 ]) : void
Parameters
- $exportClassName : string
- $optionKey : string
- $modelName : string
- $priority : int = 0
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
booladdTool()
Adds a new tool.
public
static addTool(string $key, string $link, string $description, string $icon) : void
Parameters
- $key : string
- $link : string
- $description : string
- $icon : string
defaultOption()
Returns default option.
public
static defaultOption() : string
Return values
stringgetDoc()
Return generated doc.
public
getDoc() : 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 = 0 ][, string $lang = '' ]) : void
Parameters
- $option : string
- $title : string = ''
- $format : int = 0
- $lang : string = ''
options()
returns options to export.
public
static options() : array<string|int, mixed>
Return values
array<string|int, mixed>setCompany()
public
setCompany(int $idempresa) : void
Parameters
- $idempresa : int
setOrientation()
Sets default orientation.
public
setOrientation(string $orientation) : void
Parameters
- $orientation : string
show()
Returns the formatted data.
public
show(Response &$response) : void
Parameters
- $response : Response
tools()
public
static tools() : array<string|int, mixed>
Return values
array<string|int, mixed>init()
Initialize options array
protected
static init() : void