ExportBase
in package
Export interface.
Tags
Table of Contents
- $fileName : string
- 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.
- addTablePage() : bool
- Adds a new page with the table.
- getDoc() : mixed
- Return the full document.
- newDoc() : mixed
- Blank document.
- setOrientation() : mixed
- Sets default orientation.
- show() : mixed
- Set headers and output document content to response.
- getColumnAlignments() : array<string|int, mixed>
- getColumnTitles() : array<string|int, mixed>
- getColumnWidgets() : array<string|int, mixed>
- getCursorData() : array<string|int, mixed>
- getCursorRawData() : array<string|int, mixed>
- getDocumentFormat() : FormatoDocumento
- getFileName() : string
- getModelColumnsData() : array<string|int, mixed>
- getModelFields() : array<string|int, mixed>
- setFileName() : mixed
- toolBox() : ToolBox
Properties
$fileName
private
string
$fileName
Methods
addBusinessDocPage()
Adds a new page with the document data.
public
abstract addBusinessDocPage(mixed $model) : bool
Parameters
- $model : mixed
Return values
bool —addListModelPage()
Adds a new page with a table listing the models data.
public
abstract addListModelPage(mixed $model, mixed $where, mixed $order, mixed $offset, mixed $columns[, mixed $title = '' ]) : bool
Parameters
- $model : mixed
- $where : mixed
- $order : mixed
- $offset : mixed
- $columns : mixed
- $title : mixed = ''
Return values
bool —addModelPage()
Adds a new page with the model data.
public
abstract addModelPage(mixed $model, mixed $columns[, mixed $title = '' ]) : bool
Parameters
- $model : mixed
- $columns : mixed
- $title : mixed = ''
Return values
bool —addTablePage()
Adds a new page with the table.
public
abstract addTablePage(mixed $headers, mixed $rows[, mixed $options = [] ][, mixed $title = '' ]) : bool
Parameters
- $headers : mixed
- $rows : mixed
- $options : mixed = []
- $title : mixed = ''
Return values
bool —getDoc()
Return the full document.
public
abstract getDoc() : mixed
Return values
mixed —newDoc()
Blank document.
public
abstract newDoc(string $title, int $idformat, string $langcode) : mixed
Parameters
- $title : string
- $idformat : int
- $langcode : string
Return values
mixed —setOrientation()
Sets default orientation.
public
abstract setOrientation(string $orientation) : mixed
Parameters
- $orientation : string
Return values
mixed —show()
Set headers and output document content to response.
public
abstract show(Response &$response) : mixed
Parameters
- $response : Response
Return values
mixed —getColumnAlignments()
protected
getColumnAlignments(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
Return values
array<string|int, mixed> —getColumnTitles()
protected
getColumnTitles(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
Return values
array<string|int, mixed> —getColumnWidgets()
protected
getColumnWidgets(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
Return values
array<string|int, mixed> —getCursorData()
protected
getCursorData(array<string|int, ModelClass> $cursor, array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $cursor : array<string|int, ModelClass>
- $columns : array<string|int, mixed>
Return values
array<string|int, mixed> —getCursorRawData()
protected
getCursorRawData(array<string|int, ModelClass> $cursor[, array<string|int, mixed> $fields = [] ]) : array<string|int, mixed>
Parameters
- $cursor : array<string|int, ModelClass>
- $fields : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getDocumentFormat()
protected
getDocumentFormat(BusinessDocument $model) : FormatoDocumento
Parameters
- $model : BusinessDocument
Return values
FormatoDocumento —getFileName()
protected
getFileName() : string
Return values
string —getModelColumnsData()
protected
getModelColumnsData(ModelClass $model, array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $model : ModelClass
- $columns : array<string|int, mixed>
Return values
array<string|int, mixed> —getModelFields()
protected
getModelFields(ModelClass $model) : array<string|int, mixed>
Parameters
- $model : ModelClass
Return values
array<string|int, mixed> —setFileName()
protected
setFileName(string $name) : mixed
Parameters
- $name : string
Return values
mixed —toolBox()
protected
toolBox() : ToolBox