PHP Класс Nayjest\Grids\Components\ExcelExport

The component provides control for exporting data to excel.
Автор: : Alexander Hofmeister
Наследование: extends Nayjest\Grids\Components\Base\RenderableComponent
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
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 )

Защищенные методы

Метод Описание
escapeString ( $str )
getHeaderRow ( )
isColumnExported ( Nayjest\Grids\FieldConfig $column ) : boolean
renderExcel ( )
resetPagination ( Nayjest\Grids\DataProvider $provider )

Описание методов

escapeString() защищенный Метод

protected escapeString ( $str )

getData() публичный Метод

public getData ( ) : array
Результат array

getExtension() публичный Метод

public getExtension ( ) : string
Результат string

getFileName() публичный Метод

Returns name of exported file.
public getFileName ( ) : string
Результат string

getHeaderRow() защищенный Метод

protected getHeaderRow ( )

getIgnoredColumns() публичный Метод

public getIgnoredColumns ( ) : string[]
Результат string[]

getOnFileCreate() публичный Метод

public getOnFileCreate ( ) : mixed
Результат mixed

getOnSheetCreate() публичный Метод

public getOnSheetCreate ( ) : callable
Результат callable

getRowsLimit() публичный Метод

public getRowsLimit ( ) : integer
Результат integer

getSheetName() публичный Метод

public getSheetName ( ) : string
Результат string

initialize() публичный Метод

public initialize ( Nayjest\Grids\Grid $grid ) : null | void
$grid Nayjest\Grids\Grid
Результат null | void

isColumnExported() защищенный Метод

protected isColumnExported ( Nayjest\Grids\FieldConfig $column ) : boolean
$column Nayjest\Grids\FieldConfig
Результат boolean

isHiddenColumnsExported() публичный Метод

public isHiddenColumnsExported ( ) : boolean
Результат boolean

renderExcel() защищенный Метод

protected renderExcel ( )

resetPagination() защищенный Метод

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

setExtension() публичный Метод

public setExtension ( string $name )
$name string

setFileName() публичный Метод

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

setHiddenColumnsExported() публичный Метод

public setHiddenColumnsExported ( boolean $isHiddenColumnsExported )
$isHiddenColumnsExported boolean

setIgnoredColumns() публичный Метод

public setIgnoredColumns ( array $ignoredColumns )
$ignoredColumns array

setOnFileCreate() публичный Метод

public setOnFileCreate ( callable $onFileCreate )
$onFileCreate callable

setOnSheetCreate() публичный Метод

public setOnSheetCreate ( callable $onSheetCreate )
$onSheetCreate callable

setRowsLimit() публичный Метод

public setRowsLimit ( integer $limit )
$limit integer

setSheetName() публичный Метод

public setSheetName ( string $name )
$name string

Описание свойств

$extension защищенное свойство

protected $extension

$fileName защищенное свойство

protected string $fileName
Результат string

$ignored_columns защищенное свойство

protected $ignored_columns

$is_hidden_columns_exported защищенное свойство

protected $is_hidden_columns_exported

$name защищенное свойство

protected $name

$on_file_create защищенное свойство

protected $on_file_create

$on_sheet_create защищенное свойство

protected $on_sheet_create

$output защищенное свойство

protected string $output
Результат string

$render_section защищенное свойство

protected $render_section

$rows_limit защищенное свойство

protected $rows_limit

$sheetName защищенное свойство

protected string $sheetName
Результат string

$template защищенное свойство

protected $template