mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
115 lines
3.3 KiB
XML
115 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="domdocument.loadhtml" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>DOMDocument::loadHTML</refname>
|
|
<refpurpose>
|
|
Load HTML from a string
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type class="union"><type>DOMDocument</type><type>bool</type></type><methodname>DOMDocument::loadHTML</methodname>
|
|
<methodparam><type>string</type><parameter>source</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
The function parses the HTML contained in the string <parameter>source</parameter>.
|
|
Unlike loading XML, HTML does not have to be well-formed to load. This
|
|
function may also be called statically to load and create a
|
|
<classname>DOMDocument</classname> object. The static invocation may be
|
|
used when no <classname>DOMDocument</classname> properties need to be
|
|
set prior to loading.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>source</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The HTML string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Since Libxml 2.6.0, you may also use the
|
|
<parameter>options</parameter> parameter to specify <link linkend="libxml.constants">additional Libxml parameters</link>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success; If called statically, returns a
|
|
<classname>DOMDocument</classname>&return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
If an empty string is passed as the <parameter>source</parameter>,
|
|
a warning will be generated. This warning is not generated by libxml
|
|
and cannot be handled using libxml's error handling functions.
|
|
</para>
|
|
&dom.allowstatic;
|
|
&dom.malformederror;
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Creating a Document</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$doc = new DOMDocument();
|
|
$doc->loadHTML("<html><body>Test<br></body></html>");
|
|
echo $doc->saveHTML();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>DOMDocument::loadHTMLFile</methodname></member>
|
|
<member><methodname>DOMDocument::saveHTML</methodname></member>
|
|
<member><methodname>DOMDocument::saveHTMLFile</methodname></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:"~/.phpdoc/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
|
|
-->
|