php-doc-en/reference/dom/functions/dom-domdocument-saveHTMLFile.xml
Mehdi Achour 2b1af939e4 Used the new documentation format in the documented functions
Documented, reviewed and added examples to DOMDocument->__construct(), createEle
ment*, load, loadXML, save*.
Also documented DOMDocument->xinclude() and found bug #31200


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@175146 c90b9560-bf6c-de11-be94-00142212c4b1
2004-12-20 15:57:49 +00:00

110 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.dom-domdocument-savehtmlfile">
<refnamediv>
<refname>DOMDocument->saveHTML</refname>
<refpurpose>
Dumps the internal document into a file using HTML formatting
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMDocument</classname></ooclass>
<methodsynopsis>
<type>int</type>
<methodname>saveHTMLFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Creates an HTML document from the DOM representation. This function is usually
called after building a new dom document from scratch as in the example below.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The path to the saved HTML document.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of bytes written or &false; if an error occured.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Saving a HTML tree into a file</title>
<programlisting role="php">
<![CDATA[
<?php
$doc = new DOMDocument('1.0');
// we want a nice output
$doc->formatOutput = true;
$root = $doc->createElement('html');
$root = $doc->appendChild($root);
$head = $doc->createElement('head');
$head = $root->appendChild($head);
$title = $doc->createElement('title');
$title = $head->appendChild($title);
$text = $doc->createTextNode('This is the title');
$text = $title->appendChild($text);
echo 'Wrote: ' . $doc->saveHTMLFile("/tmp/test.html") . ' bytes'; // Wrote: 129 bytes
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="function.dom-domdocument-savehtml">DOMDocument->saveHTML()</link></member>
<member><link linkend="function.dom-domdocument-loadhtml">DOMDocument->loadHTML()</link></member>
<member><link linkend="function.dom-domdocument-loadhtmlfile">DOMDocument->loadHTMLFile()</link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->