PHPのお勉強!

PHP TOP

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 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

ドキュメントを開始します。

パラメータ

writer

手続き型のコールでのみ使用します。 変更される XMLWriter のインスタンスです。 このインスタンスは、xmlwriter_open_uri() あるいは xmlwriter_open_memory() を呼び出すことで取得したものです。

version

XML 宣言で使用するドキュメントのバージョン番号。

encoding

XML 宣言で使用するドキュメントのエンコーディング。

standalone

yes あるいは no

戻り値

成功した場合に true を、失敗した場合に false を返します。

エラー / 例外

encoding に null バイトを含む値を指定すると、 ValueError がスローされます。

変更履歴

バージョン 説明
8.4.0 encoding に null バイトを含む値を指定すると、 ValueError がスローされるようになりました。
8.0.0 引数 writer は、XMLWriter のインスタンスを期待するようになりました。 これより前のバージョンでは、リソースが期待されていました。

参考

add a note

User Contributed Notes 1 note

up
3
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>
*/
?>
To Top