<!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 processing instruction (PI) 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-object.html">xml_set_object</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xml-set-start-namespace-decl-handler.html">xml_set_start_namespace_decl_handler</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-processing-instruction-handler" class="refentry">
<div class="refnamediv">
<h1 class="refname">xml_set_processing_instruction_handler</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">xml_set_processing_instruction_handler</span> — <span class="dc-title">
Set up processing instruction (PI) handler
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.xml-set-processing-instruction-handler-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>xml_set_processing_instruction_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 processing instruction (PI) handler function for the XML parser
<em><code class="parameter">parser</code></em>.
</p>
<p class="para">
A processing instruction has the following format:
<div class="informalexample">
<div class="example-contents"><div class="cdata"><pre><?</pre></div><span class="replaceable">target</span>
<span class="replaceable">data</span><div class="cdata"><pre>?>
</pre></div></div>
</div>
You can put PHP code into such a tag, but be aware of one limitation: in
an XML PI, the PI end tag (<em>?></em>) can not be quoted,
so this character sequence should not appear in the PHP code you embed
with PIs in XML documents.If it does, the rest of the PHP code, as well
as the "real" PI end tag, will be treated as character data.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.xml-set-processing-instruction-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 processing instruction (PI) 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
three 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">$target</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</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">target</code></em></span>
<dd>
<span class="simpara">
The second parameter, <em><code class="parameter">target</code></em>, contains the PI
target.
</span>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">data</code></em></span>
<dd>
<span class="simpara">
The third parameter, <em><code class="parameter">data</code></em>, contains the PI
data.
</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-processing-instruction-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-object.html">xml_set_object</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xml-set-start-namespace-decl-handler.html">xml_set_start_namespace_decl_handler</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>
