PHP Conference Nagoya 2025

XMLWriter::startDocument

xmlwriter_start_document

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

XMLWriter::startDocument -- xmlwriter_start_documentCrée un document

Description

Style orienté objet

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

Style procédural

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

Commence un document.

Liste de paramètres

writer

Uniquement pour les appels procéduraux. L'instance XMLWriter qui est modifiée. Cet objet provient d'un appel à xmlwriter_open_uri() ou xmlwriter_open_memory().

version

Le numéro de version du document dans la déclaration XML.

encoding

L'encodage du document dans la déclaration XML.

standalone

yes ou no.

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Erreurs / Exceptions

Passer un encoding contenant des octets nuls déclenchera une exception ValueError.

Historique

Version Description
8.4.0 Passer un encoding contenant des octets nuls déclenche désormais une exception ValueError.
8.0.0 writer attend une instance de XMLWriter désormais; auparavant, une resource était attendu.

Voir aussi

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