<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Create document tag</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xmlwriter-start-comment.html">XMLWriter::startComment</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xmlwriter-start-dtd-attlist.html">XMLWriter::startDtdAttlist</a></div>
<div class="up"><a href="ref.xmlwriter.html">XMLWriter Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.xmlwriter-start-document" class="refentry">
<div class="refnamediv">
<h1 class="refname">XMLWriter::startDocument</h1>
<h1 class="refname">xmlwriter_start_document</h1>
<p class="verinfo">(PHP 5 >= 5.1.2, PHP 7, PECL xmlwriter >= 0.1.0)</p><p class="refpurpose"><span class="refname">XMLWriter::startDocument</span> -- <span class="refname">xmlwriter_start_document</span> — <span class="dc-title">Create document tag</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.xmlwriter-start-document-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>XMLWriter::startDocument</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$version</code><span class="initializer"> = 1.0</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$standalone</code></span>
]]] )</div>
<p class="para rdfs-comment">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>xmlwriter_start_document</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$xmlwriter</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$version</code><span class="initializer"> = 1.0</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$standalone</code></span>
]]] )</div>
<p class="para rdfs-comment">
Starts a document.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.xmlwriter-start-document-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">
xmlwriter</code></dt>
<dd>
<p class="para">Only for procedural calls.
The XMLWriter <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span> that is being modified. This resource comes from a call to <span class="function"><a href="function.xmlwriter-open-uri.html" class="function">xmlwriter_open_uri()</a></span> or <span class="function"><a href="function.xmlwriter-open-memory.html" class="function">xmlwriter_open_memory()</a></span>.</p></dd>
<dt>
<code class="parameter">version</code></dt>
<dd>
<p class="para">
The version number of the document as part of the XML declaration.
</p>
</dd>
<dt>
<code class="parameter">encoding</code></dt>
<dd>
<p class="para">
The encoding of the document as part of the XML declaration.
</p>
</dd>
<dt>
<code class="parameter">standalone</code></dt>
<dd>
<p class="para">
<em>yes</em> or <em>no</em>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.xmlwriter-start-document-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.xmlwriter-start-document-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="function.xmlwriter-end-document.html" class="methodname" rel="rdfs-seeAlso">XMLWriter::endDocument()</a> - End current document</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xmlwriter-start-comment.html">XMLWriter::startComment</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xmlwriter-start-dtd-attlist.html">XMLWriter::startDtdAttlist</a></div>
<div class="up"><a href="ref.xmlwriter.html">XMLWriter Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
