Documentation

XmlGenerator

Класс XmlGenerator

Tags
version
0.0.1
generated

Зорин Алексей, please DO NOT EDIT!

author

Зорин Алексей zorinalexey59292@gmail.com

copyright

2022 разработчик Зорин Алексей Евгеньевич.

Table of Contents

$config  : Config|null
Конфигурация генратора
$file  : string|null
Путь к файлу для сохранения
$obj  : XMLWriter|null
Объект генерации xml
__construct()  : mixed
Конструктор класса
addAttribute()  : self
Добавить атрибут к элементу
addElement()  : self
Добавить элемент с содержанием
closeElement()  : self
Закрыть элемент схемы
get()  : Xml
Получить резултат генерации xml
startDocument()  : self
Запустить генерацию документа
startElement()  : self
Открыть элемент схемы
setFileSystemGenerator()  : void
Создать файл на диске
setMemoryGenerator()  : void
Создать файл в память

Properties

$file

Путь к файлу для сохранения

private string|null $file = null

$obj

Объект генерации xml

private XMLWriter|null $obj = null

Methods

__construct()

Конструктор класса

public __construct(Config $config) : mixed
Parameters
$config : Config

Параметры конфигурации

Return values
mixed

addAttribute()

Добавить атрибут к элементу

public addAttribute(string $name, string|int $text) : self
Parameters
$name : string

Наименование атрибута

$text : string|int

Значение атрибута

Return values
self

addElement()

Добавить элемент с содержанием

public addElement(string $name[, string|int|null|bool $content = false ][, array<string|int, mixed> $attribites = [] ][, string|null $comment = null ]) : self
Parameters
$name : string

Наименование элемента

$content : string|int|null|bool = false

Содержание элемента

$attribites : array<string|int, mixed> = []

Атрибуты элемента

$comment : string|null = null

Коментарий элемента

Return values
self

closeElement()

Закрыть элемент схемы

public closeElement() : self
Return values
self

get()

Получить резултат генерации xml

public get() : Xml
Return values
Xml

startDocument()

Запустить генерацию документа

public startDocument([string $version = '1.0' ][, string $encoding = 'utf-8' ]) : self
Parameters
$version : string = '1.0'

Версия документа

$encoding : string = 'utf-8'

Кодировка документа

Return values
self

startElement()

Открыть элемент схемы

public startElement(string $name[, array<string|int, mixed> $attribites = [] ][, string|null $comment = null ]) : self
Parameters
$name : string

Наименование элемента

$attribites : array<string|int, mixed> = []

Атрибуты элемента

$comment : string|null = null

коментарий к элементу

Return values
self

setFileSystemGenerator()

Создать файл на диске

private setFileSystemGenerator() : void
Return values
void

setMemoryGenerator()

Создать файл в память

private setMemoryGenerator() : void
Return values
void

Search results