XMLWriter::startDocument

xmlwriter_start_document

(PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL xmlwriter >= 0.1.0)

XMLWriter::startDocument -- xmlwriter_start_document — Создаёт тег документа

Описание

Объектно-ориентированный стиль

public function XMLWriter::startDocument(?string $version = "1.0", ?string $encoding = null, ?string $standalone = null): bool

Процедурный стиль

function xmlwriter_start_document(
    XMLWriter $writer,
    ?string $version = "1.0",
    ?string $encoding = null,
    ?string $standalone = null
): bool

Метод начинает документ.

Список параметров

writer: Только для процедурных вызовов. Изменяемый экземпляр класса XMLWriter. Объект возвращается из вызова xmlwriter_open_uri() или xmlwriter_open_memory().
version: Номер версии документа как часть XML-объявления.
encoding: Кодировка документа как часть XML-объявления.
standalone: Значение yes или no.

Возвращаемые значения

Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

Ошибки

При передаче в аргументе encoding кодировки, которая содержит нулевой байт, метод выбросит ошибку ValueError.

Список изменений

Версия	Описание
8.4.0	При передаче в аргументе `encoding` кодировки, которая содержит нулевой байт, метод выбросит ошибку ValueError.
8.0.0	В параметре `writer` теперь ожидается экземпляр класса XMLWriter; раньше параметр ждал ресурс (resource).

Смотрите также

XMLWriter::endDocument() - Завершить текущий документ

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 1 note

down

Sbastien ¶

4 years ago

XMLWriter::startDocument() writes the XML declaration.

Without XMLWriter::startDocument() :

<?php

$xml = new XMLWriter();
$xml->openUri('php://stdout');
$xml->writeElement('message', 'Hello World!');
exit;

/*
Outputs :
<message>Hello World!</message>
*/
?>

With XMLWriter::startDocument() :

<?php

$xml = new XMLWriter();
$xml->openUri('php://stdout');
$xml->startDocument();
$xml->writeElement('message', 'Hello World!');
exit;

/*
Outputs :
<?xml version="1.0"?>
<message>Hello World!</message>
*/
?>

＋Добавить