<!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>Set up unparsed entity declaration handler</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xml-set-start-namespace-decl-handler.html">xml_set_start_namespace_decl_handler</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.xmlreader.html">XMLReader</a></div>
<div class="up"><a href="ref.xml.html">XML Parser Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.xml-set-unparsed-entity-decl-handler" class="refentry">
<div class="refnamediv">
<h1 class="refname">xml_set_unparsed_entity_decl_handler</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">xml_set_unparsed_entity_decl_handler</span> — <span class="dc-title">
Set up unparsed entity declaration handler
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.xml-set-unparsed-entity-decl-handler-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>xml_set_unparsed_entity_decl_handler</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$parser</code></span>
, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$handler</code></span>
)</div>
<p class="para rdfs-comment">
Sets the unparsed entity declaration handler function for the XML parser
<em><code class="parameter">parser</code></em>.
</p>
<p class="para">
The <em><code class="parameter">handler</code></em> will be called if the XML parser
encounters an external entity declaration with an NDATA declaration, like
the following:
<div class="example-contents">
<div class="xmlcode"><pre class="xmlcode"><!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>}
NDATA <parameter>notationName</parameter></pre>
</div>
</div>
</p>
<p class="para">
See <a href="http://www.w3.org/TR/1998/REC-xml-19980210#sec-external-ent" class="link external">» section 4.2.2 of
the XML 1.0 spec</a> for the definition of notation declared
external entities.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.xml-set-unparsed-entity-decl-handler-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">parser</code></em></span>
<dd>
<p class="para">
A reference to the XML parser to set up unparsed entity declaration handler function.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">handler</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">handler</code></em> is a string containing the name of a
function that must exist when <span class="function"><a href="function.xml-parse.html" class="function">xml_parse()</a></span> is called
for <em><code class="parameter">parser</code></em>.
</p>
<p class="para">
The function named by <em><code class="parameter">handler</code></em> must accept six
parameters:
<div class="methodsynopsis dc-description">
<span class="methodname"><span class="replaceable">handler</span></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$parser</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$entity_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$base</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$system_id</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$public_id</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$notation_name</code></span>
)</div>
<dl>
<dt>
<span class="term"><em><code class="parameter">parser</code></em></span>
<dd>
<span class="simpara">
The first parameter, <span class="replaceable">parser</span>, is a
reference to the XML parser calling the
handler.
</span>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">entity_name</code></em></span>
<dd>
<span class="simpara">
The name of the entity that is about to be defined.
</span>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">base</code></em></span>
<dd>
<span class="simpara">
This is the base for resolving the system identifier
(<em><code class="parameter">systemId</code></em>) of the external entity.Currently
this parameter will always be set to an empty string.
</span>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">system_id</code></em></span>
<dd>
<span class="simpara">
System identifier for the external entity.
</span>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">public_id</code></em></span>
<dd>
<span class="simpara">
Public identifier for the external entity.
</span>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">notation_name</code></em></span>
<dd>
<span class="simpara">
Name of the notation of this entity (see
<span class="function"><a href="function.xml-set-notation-decl-handler.html" class="function">xml_set_notation_decl_handler()</a></span>).
</span>
</dd>
</dt>
</dl>
</p>
<p class="para">
If a handler function is set to an empty string, or <strong><code>FALSE</code></strong>, the handler
in question is disabled.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">Instead of a function name, an
array containing an object reference and a method name can also be
supplied.</span></p></blockquote>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.xml-set-unparsed-entity-decl-handler-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><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xml-set-start-namespace-decl-handler.html">xml_set_start_namespace_decl_handler</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.xmlreader.html">XMLReader</a></div>
<div class="up"><a href="ref.xml.html">XML Parser Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
