PHP Class Nayjest\Grids\Components\ExcelExport

The component provides control for exporting data to excel.
Author: : Alexander Hofmeister
Inheritance: extends Nayjest\Grids\Components\Base\RenderableComponent
Afficher le fichier Open project: nayjest/grids

Protected Properties

Свойство Type Description
$extension
$fileName string
$ignored_columns
$is_hidden_columns_exported
$name
$on_file_create
$on_sheet_create
$output string
$render_section
$rows_limit
$sheetName string
$template

Méthodes publiques

Méthode Description
getData ( ) : array
getExtension ( ) : string
getFileName ( ) : string Returns name of exported file.
getIgnoredColumns ( ) : string[]
getOnFileCreate ( ) : mixed
getOnSheetCreate ( ) : callable
getRowsLimit ( ) : integer
getSheetName ( ) : string
initialize ( Nayjest\Grids\Grid $grid ) : null | void
isHiddenColumnsExported ( ) : boolean
setExtension ( string $name )
setFileName ( string $name ) Sets name of exported file.
setHiddenColumnsExported ( boolean $isHiddenColumnsExported )
setIgnoredColumns ( array $ignoredColumns )
setOnFileCreate ( callable $onFileCreate )
setOnSheetCreate ( callable $onSheetCreate )
setRowsLimit ( integer $limit )
setSheetName ( string $name )

Méthodes protégées

Méthode Description
escapeString ( $str )
getHeaderRow ( )
isColumnExported ( Nayjest\Grids\FieldConfig $column ) : boolean
renderExcel ( )
resetPagination ( Nayjest\Grids\DataProvider $provider )

Method Details

escapeString() protected méthode

protected escapeString ( $str )

getData() public méthode

public getData ( ) : array
Résultat array

getExtension() public méthode

public getExtension ( ) : string
Résultat string

getFileName() public méthode

Returns name of exported file.
public getFileName ( ) : string
Résultat string

getHeaderRow() protected méthode

protected getHeaderRow ( )

getIgnoredColumns() public méthode

public getIgnoredColumns ( ) : string[]
Résultat string[]

getOnFileCreate() public méthode

public getOnFileCreate ( ) : mixed
Résultat mixed

getOnSheetCreate() public méthode

public getOnSheetCreate ( ) : callable
Résultat callable

getRowsLimit() public méthode

public getRowsLimit ( ) : integer
Résultat integer

getSheetName() public méthode

public getSheetName ( ) : string
Résultat string

initialize() public méthode

public initialize ( Nayjest\Grids\Grid $grid ) : null | void
$grid Nayjest\Grids\Grid
Résultat null | void

isColumnExported() protected méthode

protected isColumnExported ( Nayjest\Grids\FieldConfig $column ) : boolean
$column Nayjest\Grids\FieldConfig
Résultat boolean

isHiddenColumnsExported() public méthode

public isHiddenColumnsExported ( ) : boolean
Résultat boolean

renderExcel() protected méthode

protected renderExcel ( )

resetPagination() protected méthode

protected resetPagination ( Nayjest\Grids\DataProvider $provider )
$provider Nayjest\Grids\DataProvider

setExtension() public méthode

public setExtension ( string $name )
$name string

setFileName() public méthode

Sets name of exported file.
public setFileName ( string $name )
$name string

setHiddenColumnsExported() public méthode

public setHiddenColumnsExported ( boolean $isHiddenColumnsExported )
$isHiddenColumnsExported boolean

setIgnoredColumns() public méthode

public setIgnoredColumns ( array $ignoredColumns )
$ignoredColumns array

setOnFileCreate() public méthode

public setOnFileCreate ( callable $onFileCreate )
$onFileCreate callable

setOnSheetCreate() public méthode

public setOnSheetCreate ( callable $onSheetCreate )
$onSheetCreate callable

setRowsLimit() public méthode

public setRowsLimit ( integer $limit )
$limit integer

setSheetName() public méthode

public setSheetName ( string $name )
$name string

Property Details

$extension protected_oe property

protected $extension

$fileName protected_oe property

protected string $fileName
Résultat string

$ignored_columns protected_oe property

protected $ignored_columns

$is_hidden_columns_exported protected_oe property

protected $is_hidden_columns_exported

$name protected_oe property

protected $name

$on_file_create protected_oe property

protected $on_file_create

$on_sheet_create protected_oe property

protected $on_sheet_create

$output protected_oe property

protected string $output
Résultat string

$render_section protected_oe property

protected $render_section

$rows_limit protected_oe property

protected $rows_limit

$sheetName protected_oe property

protected string $sheetName
Résultat string

$template protected_oe property

protected $template