Documentation

WordRender extends Render
in package
implements IRender

Визуализатор отчетов в формате Microsoft Word

Interfaces, Classes and Traits

IRender
Интерфейс для определения визуализатора отчетов

Table of Contents

FORMAT_WORD2007  = 'Word2007'
OUTPUT_DOWNLOAD  = 'download'
OUTPUT_SAVE  = 'save'
$dataSourceCallback  : callable|null
$variablesCallback  : callable|null
$fileName  : string
$format  : string
$outputType  : string
$phpWord  : PhpWord
$section  : Section
$styles  : array<string|int, mixed>
__construct()  : mixed
addDatasource()  : mixed
addDelimiter()  : mixed
addHeader()  : mixed
Добавить заголовок
addList()  : mixed
Добавить список
addParagraph()  : mixed
Добавить абзац
render()  : mixed
Визуализация блоков
setDataSourceCallback()  : mixed
setFileName()  : mixed
Установить имя файла для скачивания
setVariablesCallback()  : mixed
dataSource()  : false|IDataSource|null
Получить источник данных
variables()  : mixed
download()  : void
save()  : string
styles()  : array<string|int, mixed>

Constants

FORMAT_WORD2007

public string FORMAT_WORD2007 = 'Word2007'

OUTPUT_DOWNLOAD

public string OUTPUT_DOWNLOAD = 'download'

Properties

$dataSourceCallback

protected callable|null $dataSourceCallback

$variablesCallback

protected callable|null $variablesCallback

$styles

private array<string|int, mixed> $styles

Methods

__construct()

public __construct([string $format = WordRender::FORMAT_WORD2007 ][, string $outputType = WordRender::OUTPUT_DOWNLOAD ]) : mixed
Parameters
$format : string = WordRender::FORMAT_WORD2007

Формат документа

$outputType : string = WordRender::OUTPUT_DOWNLOAD

Тип вывода

Return values
mixed —

addDatasource()

public addDatasource(string $id, string $dataSourceName) : mixed
Parameters
$id : string
$dataSourceName : string
Return values
mixed —

addDelimiter()

public addDelimiter(string $id) : mixed
Parameters
$id : string
Return values
mixed —

addHeader()

Добавить заголовок

public addHeader(string $id, int $level, string $text) : mixed
Parameters
$id : string

Идентификатор блока

$level : int

Уровень заголовка

$text : string

Текст заголовка

Return values
mixed —

addList()

Добавить список

public addList(string $id, array<string|int, mixed> $items, string $style) : mixed
Parameters
$id : string

Идентификатор блока

$items : array<string|int, mixed>

Элементы списка

$style : string

Стиль списка: IRender::LIST_STYLE_ORDERED или IRender::LIST_STYLE_UNORDERED

Return values
mixed —

addParagraph()

Добавить абзац

public addParagraph(string $id, string $text) : mixed
Parameters
$id : string

Идентификатор блока

$text : string

Текст содержимого абзаца

Return values
mixed —

render()

Визуализация блоков

public render(string $title) : mixed
Parameters
$title : string
Return values
mixed —

setDataSourceCallback()

public setDataSourceCallback(callable|null $callback) : mixed
Parameters
$callback : callable|null
Return values
mixed —

setFileName()

Установить имя файла для скачивания

public setFileName(string $fileName) : mixed
Parameters
$fileName : string

Имя файла

Return values
mixed —

setVariablesCallback()

public setVariablesCallback(callable|null $callback) : mixed
Parameters
$callback : callable|null
Return values
mixed —

dataSource()

Получить источник данных

protected dataSource(string $dataSourceName) : false|IDataSource|null
Parameters
$dataSourceName : string
Return values
false|IDataSource|null —

variables()

protected variables(string $text) : mixed
Parameters
$text : string
Return values
mixed —

download()

private download( $fileName) : void
Parameters
$fileName :
Tags
throws
Exception
Return values
void —

save()

private save([mixed $fileName = null ]) : string
Parameters
$fileName : mixed = null
Tags
throws
Exception
Return values
string —

styles()

private static styles() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results