<!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 the SAX handlers to be called when the XML document gets processed</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.xslt-set-sax-handler.html">xslt_set_sax_handler</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.xslt-set-scheme-handler.html">xslt_set_scheme_handler</a></div> <div class="up"><a href="ref.xslt.html">XSLT (PHP 4) Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.xslt-set-sax-handlers" class="refentry"> <div class="refnamediv"> <h1 class="refname">xslt_set_sax_handlers</h1> <p class="verinfo">(PHP 4 >= 4.0.6)</p><p class="refpurpose"><span class="refname">xslt_set_sax_handlers</span> — <span class="dc-title">Set the SAX handlers to be called when the XML document gets processed</span></p> </div> <div class="refsect1 description" id="refsect1-function.xslt-set-sax-handlers-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>xslt_set_sax_handlers</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter">$handlers</code></span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>xslt_set_sax_handlers()</strong></span> registers the SAX <em><code class="parameter">handlers</code></em> for the document, given a XSLT <em><code class="parameter">processor</code></em> resource. </p> <p class="para"> Using <span class="function"><strong>xslt_set_sax_handlers()</strong></span> doesn't look very different than running a SAX parser like <span class="function"><a href="function.xml-parse.html" class="function">xml_parse()</a></span> on the result of an <span class="function"><a href="function.xslt-process.html" class="function">xslt_process()</a></span> transformation. </p> </div> <div class="refsect1 parameters" id="refsect1-function.xslt-set-sax-handlers-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter"> processor</code></em></span><dd> <p class="para">The <acronym title="eXtensible Stylesheet Language Transformations">XSLT</acronym> processor link identifier, created with <span class="function"><a href="function.xslt-create.html" class="function">xslt_create()</a></span>.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">handlers</code></em></span> <dd> <p class="para"> <em><code class="parameter">handlers</code></em> should be an array in the following format: <div class="informalexample"> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$handlers </span><span style="color: #007700">= array(<br /><br /> </span><span style="color: #DD0000">"document" </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">"start_doc"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"end_doc"</span><span style="color: #007700">),<br /><br /> </span><span style="color: #DD0000">"element" </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">"start_element"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"end_element"</span><span style="color: #007700">),<br /><br /> </span><span style="color: #DD0000">"namespace" </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">"start_namespace"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"end_namespace"</span><span style="color: #007700">),<br /><br /> </span><span style="color: #DD0000">"comment" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"comment"</span><span style="color: #007700">,<br /><br /> </span><span style="color: #DD0000">"pi" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"pi"</span><span style="color: #007700">,<br /><br /> </span><span style="color: #DD0000">"character" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"characters"<br /><br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> Where the functions follow the syntax described for the scheme handler functions. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> The given array does not need to contain all of the different sax handler elements (although it can), but it only needs to conform to "handler" => "function" format described above. </p> </p></blockquote> <p class="para"> Each of the individual SAX handler functions are in the format below: <ul class="itemizedlist"> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">start_doc</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> )</div> </p> </li> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">end_doc</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> )</div> </p> </li> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">start_element</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter">$attributes</code></span> )</div> </p> </li> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">end_element</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> )</div> </p> </li> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">start_namespace</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$prefix</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$uri</code></span> )</div> </p> </li> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">end_namespace</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$prefix</code></span> )</div> </p> </li> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">comment</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$contents</code></span> )</div> </p> </li> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">pi</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</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">$contents</code></span> )</div> </p> </li> <li class="listitem"> <p class="para"> <div class="methodsynopsis dc-description"> <span class="methodname"><span class="replaceable">characters</span></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$processor</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$contents</code></span> )</div> </p> </li> </ul> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.xslt-set-sax-handlers-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> No value is returned. </p> </div> <div class="refsect1 examples" id="refsect1-function.xslt-set-sax-handlers-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5557"> <p><strong>Example #1 <span class="function"><strong>xslt_set_sax_handlers()</strong></span> Example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// From ohlesbeauxjours at yahoo dot fr<br />// Here's a simple example that applies strtoupper() on<br />// the content of every <auteur> tag and then displays the<br />// resulting XML tree:<br /><br /></span><span style="color: #0000BB">$xml</span><span style="color: #007700">=</span><span style="color: #DD0000">'<?xml version="1.0"?><br /><books><br /> <book><br /> <title>Mme Bovary</title><br /> <author>Gustave Flaubert</author><br /> </book><br /> <book><br /> <title>Mrs Dalloway</title><br /> <author>Virginia Woolf</author><br /> </book><br /></books>'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$xsl</span><span style="color: #007700">=</span><span style="color: #DD0000">'<?xml version="1.0"?><br /><xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"><br /><xsl:output method="html" encoding="ISO-8859-1" indent="no" omit-xml-declaration="yes"/><br /><xsl:template match="/"><br /> <xsl:for-each select="books/book"><br /> <livre><br /> <auteur><xsl:value-of select="author/text()"/></auteur><br /> </livre><br /> </xsl:for-each><br /></xsl:template><br /></xsl:stylesheet>'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Handlers :<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">start_document</span><span style="color: #007700">()<br />{<br /> </span><span style="color: #FF8000">// start reading the document<br /></span><span style="color: #007700">}<br /><br />function </span><span style="color: #0000BB">end_document</span><span style="color: #007700">()<br />{<br /> </span><span style="color: #FF8000">// end reading the document<br /></span><span style="color: #007700">}<br /><br />function </span><span style="color: #0000BB">start_element</span><span style="color: #007700">(</span><span style="color: #0000BB">$parser</span><span style="color: #007700">, </span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #0000BB">$attributes</span><span style="color: #007700">)<br />{<br /> global </span><span style="color: #0000BB">$result</span><span style="color: #007700">,</span><span style="color: #0000BB">$tag</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$result </span><span style="color: #007700">.= </span><span style="color: #DD0000">"<"</span><span style="color: #007700">. </span><span style="color: #0000BB">$name </span><span style="color: #007700">. </span><span style="color: #DD0000">">"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$tag </span><span style="color: #007700">= </span><span style="color: #0000BB">$name</span><span style="color: #007700">;<br />}<br /><br />function </span><span style="color: #0000BB">end_element</span><span style="color: #007700">(</span><span style="color: #0000BB">$parser</span><span style="color: #007700">, </span><span style="color: #0000BB">$name</span><span style="color: #007700">)<br />{<br /> global </span><span style="color: #0000BB">$result</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$result </span><span style="color: #007700">.= </span><span style="color: #DD0000">"</" </span><span style="color: #007700">. </span><span style="color: #0000BB">$name </span><span style="color: #007700">. </span><span style="color: #DD0000">">"</span><span style="color: #007700">;<br />}<br /><br />function </span><span style="color: #0000BB">characters</span><span style="color: #007700">(</span><span style="color: #0000BB">$parser</span><span style="color: #007700">, </span><span style="color: #0000BB">$data</span><span style="color: #007700">)<br />{<br /> global </span><span style="color: #0000BB">$result</span><span style="color: #007700">,</span><span style="color: #0000BB">$tag</span><span style="color: #007700">;<br /> if (</span><span style="color: #0000BB">$tag </span><span style="color: #007700">== </span><span style="color: #DD0000">"auteur" </span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">strtoupper</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #0000BB">$result </span><span style="color: #007700">.= </span><span style="color: #0000BB">$data</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// Transformation :<br /></span><span style="color: #0000BB">$xh </span><span style="color: #007700">= </span><span style="color: #0000BB">xslt_create</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$handlers </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"document" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"start_document"</span><span style="color: #007700">,</span><span style="color: #DD0000">"end_document"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"element" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">"start_element"</span><span style="color: #007700">,</span><span style="color: #DD0000">"end_element"</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"character" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"characters"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">xslt_set_sax_handlers</span><span style="color: #007700">(</span><span style="color: #0000BB">$xh</span><span style="color: #007700">, </span><span style="color: #0000BB">$handlers</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">xslt_process</span><span style="color: #007700">(</span><span style="color: #0000BB">$xh</span><span style="color: #007700">, </span><span style="color: #DD0000">'arg:/_xml'</span><span style="color: #007700">, </span><span style="color: #DD0000">'arg:/_xsl'</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"/_xml"</span><span style="color: #007700">=></span><span style="color: #0000BB">$xml</span><span style="color: #007700">, </span><span style="color: #DD0000">"/_xsl"</span><span style="color: #007700">=></span><span style="color: #0000BB">$xsl</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">xslt_free</span><span style="color: #007700">(</span><span style="color: #0000BB">$xh</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> <p class="para"> You can also use <span class="function"><a href="function.xslt-set-object.html" class="function">xslt_set_object()</a></span> if you want to implement your handlers in an object. </p> <div class="example" id="example-5558"> <p><strong>Example #2 Object oriented handler</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// This is the object oriented version of the previous example<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">data_sax_handler </span><span style="color: #007700">{<br /><br /> var </span><span style="color: #0000BB">$buffer</span><span style="color: #007700">, </span><span style="color: #0000BB">$tag</span><span style="color: #007700">, </span><span style="color: #0000BB">$attrs</span><span style="color: #007700">;<br /><br /> var </span><span style="color: #0000BB">$_xh</span><span style="color: #007700">;<br /><br /> function </span><span style="color: #0000BB">data_sax_handler</span><span style="color: #007700">(</span><span style="color: #0000BB">$xml</span><span style="color: #007700">, </span><span style="color: #0000BB">$xsl</span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #FF8000">// our xslt resource<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_xh </span><span style="color: #007700">= </span><span style="color: #0000BB">xslt_create</span><span style="color: #007700">();<br /><br /> </span><span style="color: #0000BB">xslt_set_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_xs</span><span style="color: #007700">, </span><span style="color: #0000BB">$this</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// configure sax handlers<br /> </span><span style="color: #0000BB">$handlers </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">"document" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'start_document'</span><span style="color: #007700">, </span><span style="color: #DD0000">'end_document'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"element" </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'start_element'</span><span style="color: #007700">, </span><span style="color: #DD0000">'end_element'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"character" </span><span style="color: #007700">=> </span><span style="color: #DD0000">'characters'<br /> </span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">xslt_set_sax_handlers</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_xh</span><span style="color: #007700">, </span><span style="color: #0000BB">$handlers</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">xslt_process</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_xh</span><span style="color: #007700">, </span><span style="color: #DD0000">'arg:/_xml'</span><span style="color: #007700">, </span><span style="color: #DD0000">'arg:/_xsl'</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"/_xml"</span><span style="color: #007700">=></span><span style="color: #0000BB">$xml</span><span style="color: #007700">, </span><span style="color: #DD0000">"/_xsl"</span><span style="color: #007700">=></span><span style="color: #0000BB">$xsl</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">xslt_free</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_xh</span><span style="color: #007700">);<br /><br /><br /> }<br /><br /> function </span><span style="color: #0000BB">start_document</span><span style="color: #007700">()<br /> {<br /> </span><span style="color: #FF8000">// start reading the document<br /> </span><span style="color: #007700">}<br /><br /> function </span><span style="color: #0000BB">end_document</span><span style="color: #007700">() {<br /> </span><span style="color: #FF8000">// complete reading the document<br /> </span><span style="color: #007700">}<br /><br /> function </span><span style="color: #0000BB">start_element</span><span style="color: #007700">(</span><span style="color: #0000BB">$parser</span><span style="color: #007700">, </span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #0000BB">$attributes</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">tag </span><span style="color: #007700">= </span><span style="color: #0000BB">$name</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">buffer </span><span style="color: #007700">.= </span><span style="color: #DD0000">"<" </span><span style="color: #007700">. </span><span style="color: #0000BB">$name </span><span style="color: #007700">. </span><span style="color: #DD0000">">"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">attrs </span><span style="color: #007700">= </span><span style="color: #0000BB">$attributes</span><span style="color: #007700">;<br /> }<br /><br /> function </span><span style="color: #0000BB">end_element</span><span style="color: #007700">(</span><span style="color: #0000BB">$parser</span><span style="color: #007700">, </span><span style="color: #0000BB">$name</span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">tag </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">buffer </span><span style="color: #007700">.= </span><span style="color: #DD0000">"</" </span><span style="color: #007700">. </span><span style="color: #0000BB">$name </span><span style="color: #007700">. </span><span style="color: #DD0000">">"</span><span style="color: #007700">;<br /> }<br /><br /> function </span><span style="color: #0000BB">characters</span><span style="color: #007700">(</span><span style="color: #0000BB">$parser</span><span style="color: #007700">, </span><span style="color: #0000BB">$data</span><span style="color: #007700">)<br /> {<br /> if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">tag </span><span style="color: #007700">== </span><span style="color: #DD0000">'auteur'</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">strtoupper</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">buffer </span><span style="color: #007700">.= </span><span style="color: #0000BB">$data</span><span style="color: #007700">;<br /> }<br /><br /> function </span><span style="color: #0000BB">get_buffer</span><span style="color: #007700">() {<br /> return </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">buffer</span><span style="color: #007700">;<br /> }<br /><br />}<br /><br /></span><span style="color: #0000BB">$exec </span><span style="color: #007700">= new </span><span style="color: #0000BB">data_sax_handler</span><span style="color: #007700">(</span><span style="color: #0000BB">$xml</span><span style="color: #007700">, </span><span style="color: #0000BB">$xsl</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p> Both examples will output: </p></div> <div class="example-contents screen"> <div class="cdata"><pre> <livre> <auteur>GUSTAVE FLAUBERT</auteur> </livre> <livre> <auteur>VIRGINIA WOOLF</auteur> </livre> </pre></div> </div> </div> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.xslt-set-sax-handler.html">xslt_set_sax_handler</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.xslt-set-scheme-handler.html">xslt_set_scheme_handler</a></div> <div class="up"><a href="ref.xslt.html">XSLT (PHP 4) Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>