FacturaScripts

CSVExport extends CSVExport
in package

Class created by Core/Base/PluginManager

Tags
author

FacturaScripts [email protected]

Table of Contents

LIST_LIMIT  = 1000
$csv  : array<string|int, mixed>
Contains the CSV data in array format
$delimiter  : string
Text delimiter value
$fileName  : string
$separator  : string
Separator value
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.
getDelimiter()  : string
Returns the received text delimiter assigned
getDoc()  : mixed
Return the full document.
getSeparator()  : string
Returns the assigned separator
newDoc()  : mixed
Blank document.
setDelimiter()  : mixed
Assigns the received text delimiter By default it will use '"' quotes.
setOrientation()  : mixed
Sets default orientation.
setSeparator()  : mixed
Assigns the received separator.
show()  : mixed
Set headers and output document content to response.
writeData()  : mixed
Fills an array with the CSV data.
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
writeHeader()  : mixed

Constants

Properties

$csv

Contains the CSV data in array format

private array<string|int, mixed> $csv = []

$delimiter

Text delimiter value

private string $delimiter = '"'

$separator

Separator value

private string $separator = ';'

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

getDelimiter()

Returns the received text delimiter assigned

public getDelimiter() : string
Return values
string

getDoc()

Return the full document.

public abstract getDoc() : mixed
Return values
mixed

getSeparator()

Returns the assigned separator

public getSeparator() : string
Return values
string

newDoc()

Blank document.

public abstract newDoc(string $title, int $idformat, string $langcode) : mixed
Parameters
$title : string
$idformat : int
$langcode : string
Return values
mixed

setDelimiter()

Assigns the received text delimiter By default it will use '"' quotes.

public setDelimiter(string $del) : mixed
Parameters
$del : string
Return values
mixed

setOrientation()

Sets default orientation.

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

setSeparator()

Assigns the received separator.

public setSeparator(string $sep) : mixed

By default it will use ';' semicolons.

Parameters
$sep : 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

writeData()

Fills an array with the CSV data.

public writeData(array<string|int, mixed> $data[, array<string|int, mixed> $fields = [] ]) : mixed
Parameters
$data : array<string|int, mixed>
$fields : array<string|int, mixed> = []
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>

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

writeHeader()

private writeHeader(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>
Return values
mixed

Search results