php-doc-en/reference/dom/functions/dom-domdocument-createentityreference.xml
2005-04-02 22:46:41 +00:00

99 lines
3.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry id="function.dom-domdocument-createentityreference">
<refnamediv>
<refname>DOMDocument->createEntityReference()</refname>
<refpurpose>Create new entity reference node</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMDocument</classname></ooclass>
<methodsynopsis>
<type>DOMEntityReference</type><methodname>createEntityReference</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function creates a new instance of class
<classname>DOMEntityReference</classname>. &dom.node.inserted;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The content of the entity reference, e.g. the entity reference minus
the leading <literal>&amp;</literal> and the trailing
<literal>;</literal> characters.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The new <classname>DOMEntityReference</classname> or &false; if an error
occured.
</para>
</refsect1>
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
<variablelist>
<varlistentry>
<term><constant>DOM_INVALID_CHARACTER_ERR</constant></term>
<listitem>
<para>
Raised if <parameter>name</parameter> contains an invalid character.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domnode-appendchild" /></member>
<member><xref linkend="function.dom-domdocument-createattribute" /></member>
<member><xref linkend="function.dom-domdocument-createattributens" /></member>
<member><xref linkend="function.dom-domdocument-createcdatasection" /></member>
<member><xref linkend="function.dom-domdocument-createcomment" /></member>
<member><xref linkend="function.dom-domdocument-createdocumentfragment" /></member>
<member><xref linkend="function.dom-domdocument-createelement" /></member>
<member><xref linkend="function.dom-domdocument-createelementns" /></member>
<member><xref linkend="function.dom-domdocument-createprocessinginstruction" /></member>
<member><xref linkend="function.dom-domdocument-createtextnode" /></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
-->