XMLWriter::startDocument

xmlwriter_start_document

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

XMLWriter::startDocument -- xmlwriter_start_document — Create document tag

Опис

Об'єктно-орієнтований стиль

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

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

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

Starts a document.

Параметри

writer: Тільки для процедурних викликів. Примірник XMLWriter, що буде оброблятися. Цей об'єкт повертається функцією xmlwriter_open_uri() або xmlwriter_open_memory().
version: The version number of the document as part of the XML declaration.
encoding: The encoding of the document as part of the XML declaration.
standalone: yes or no.

Значення, що повертаються

Повертає true у разі успіху або false в разі помилки.

Помилки/виключення

Passing an encoding containing null bytes will throw a ValueError.

Журнал змін

Версія	Опис
8.4.0	Passing an `encoding` containing null bytes will now throw a ValueError.
8.0.0	Тепер `writer` має бути примірником XMLWriter. Раніше очікувався resource.

Прогляньте також

XMLWriter::endDocument() - End current document

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

Sbastien ¶

2 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>
*/
?>

＋add a note