Documentation

HtmlRender extends Render
in package
implements IRender

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

Interfaces, Classes and Traits

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

Table of Contents

FORMAT_HTML  = 'html'
FORMAT_STRING  = 'str'
TYPE_EMBED  = 'embed'
TYPE_PAGE  = 'page'
$dataSourceCallback  : callable|null
$variablesCallback  : callable|null
$allowedFormats  : array<string|int, mixed>
$allowedListStyles  : array<string|int, mixed>
$allowedTypes  : array<string|int, mixed>
$contentHtml  : Html
$format  : string
$styleUrl  : string
$type  : string
__construct()  : mixed
addDatasource()  : mixed
addDelimiter()  : mixed
addHeader()  : mixed
Добавить заголовок
addList()  : mixed
Добавить список
addParagraph()  : mixed
Добавить абзац
render()  : Html|string
Визуализация блоков
setDataSourceCallback()  : mixed
setStyleUrl()  : mixed
Установить ссылку до CSS файла стилей
setVariablesCallback()  : mixed
dataSource()  : false|IDataSource|null
Получить источник данных
variables()  : mixed

Constants

FORMAT_STRING

public mixed FORMAT_STRING = 'str'

Properties

$dataSourceCallback

protected callable|null $dataSourceCallback

$variablesCallback

protected callable|null $variablesCallback

$allowedFormats

private array<string|int, mixed> $allowedFormats = [self::FORMAT_STRING, self::FORMAT_HTML]

$allowedListStyles

private array<string|int, mixed> $allowedListStyles = [self::LIST_STYLE_ORDERED, self::LIST_STYLE_UNORDERED]

$allowedTypes

private array<string|int, mixed> $allowedTypes = [self::TYPE_PAGE, self::TYPE_EMBED]

Methods

__construct()

public __construct(string $format[, string $type = HtmlRender::TYPE_PAGE ]) : mixed
Parameters
$format : string
$type : string = HtmlRender::TYPE_PAGE
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) : Html|string
Parameters
$title : string
Tags
throws
BlockError
Return values
Html|string —

setDataSourceCallback()

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

setStyleUrl()

Установить ссылку до CSS файла стилей

public setStyleUrl(string $url) : mixed
Parameters
$url : 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 —

Search results