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.

参数

xmlwriter: 仅用于过程调用。被修改的 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

改进此页面

了解如何改进此页面 • 提交拉取请求 • 报告一个错误

＋添加备注

用户贡献的备注 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>
*/
?>