<?xml version="1.0" encoding="iso-8859-1"?>
 <reference id="ref.xslt">
  <title>XSLT functions</title>
  <titleabbrev>XSLT</titleabbrev>

  <partintro>
   &warn.experimental;
   <sect1 id="xslt.partintro">
    <title>Introduction</title>

    <sect2 id="xslt.intro">
     <title>About XSLT and Sablotron</title>
     <para>
      XSLT (Extensible Stylesheet Language (XSL)
      Transformations) is a language for transforming XML
      documents into other XML documents.  It is a standard
      defined by The World Wide Web consortium (W3C). 
      Information about XSLT and related technologies can be
      found at <ulink url="&url.xslt;">&url.xslt;</ulink>.
     </para>
    </sect2>

    <sect2 id="xslt.install">
     <title>Installation</title>
     <para>
      This extension uses <productname>Sabloton</productname>
      and <productname>expat</productname>, which can both be
      found at <ulink
      url="&url.sablotron;">&url.sablotron;</ulink>. Binaries
      are provided as well as source.
     </para>
     <para>
      On UNIX, run <command>configure</command> with the <option
      role="configure">--with-sablot</option> and <option
      role="configure">--enable-sablot-errors-descriptive</option>
      options.  The <productname>Sablotron</productname> library
      should be installed somewhere your compiler can find it. 
     </para>
    </sect2>

    <sect2 id="xslt.about">
     <title>About This Extension</title>
     <para>
      This PHP extension implements support
      <productname>Sablotron</productname> from Ginger Alliance
      in PHP. This toolkit lets you transform 
      XML documents into other documents, including new XML
      documents, but also into HTML or other target formats. It
      basically provides a standardized and portable template
      mechanism, separating content and design of a website.
     </para>
    </sect2>

   </sect1>
  </partintro>

  <refentry id="function.xslt-closelog">
   <refnamediv>
    <refname>xslt_closelog</refname>
    <refpurpose>Clear the logfile for a given instance of Sablotron</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>xslt_closelog</methodname>
      <methodparam><type>resource</type><parameter>xh</parameter></methodparam>
     </methodsynopsis>
    <para>
     <variablelist>
      <varlistentry>
       <term><parameter>xh</parameter></term>
       <listitem>
    <simpara>
     A reference to the XSLT parser.
    </simpara>
       </listitem>
      </varlistentry>
     </variablelist></para>
    <para>
     This function returns &false; if <parameter>parser</parameter> does
     not refer to a valid parser, or if the closing of the logfile
     fails. Otherwise it returns &true;.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-create">
   <refnamediv>
    <refname>xslt_create</refname>
    <refpurpose>Create a new XSL processor.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>resource</type><methodname>xslt_create</methodname>
      <void/>
     </methodsynopsis>
    <para>
     This function returns a handle for a new XSL processor. This handle
     is needed in all subsequent calls to XSL functions.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-errno">
   <refnamediv>
    <refname>xslt_errno</refname>
    <refpurpose>Return the current error number</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>xslt_errno</methodname>
       <methodparam choice="opt"><type></type><parameter>int xh</parameter></methodparam>
     </methodsynopsis>
    <para>
     Return the current error number of the given XSL processor. If
     no handle is given, the last error number that occured anywhere
     is returned.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-error">
   <refnamediv>
    <refname>xslt_error</refname>
    <refpurpose>Return the current error string</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>xslt_error</methodname>
       <methodparam choice="opt"><type></type><parameter>int xh</parameter></methodparam>
     </methodsynopsis>
    <para>
     Return the current error string of the given XSL processor. If
     no handle is given, the last error string that occured anywhere
     is returned.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-fetch-result">
   <refnamediv>
    <refname>xslt_fetch_result</refname>
    <refpurpose>Fetch a (named) result buffer</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>xslt_fetch_result</methodname>
       <methodparam><type>int</type><parameter>xh</parameter></methodparam>
       <methodparam choice="opt"><parameter>string result_name</parameter></methodparam>
     </methodsynopsis>
    <para>
     Fetch a result buffer from the XSLT processor identified by
     the given handle. If no result name is given, the
     buffer named &quot;/_result&quot; is fetched.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-free">
   <refnamediv>
    <refname>xslt_free</refname>
    <refpurpose>Free XSLT processor</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>xslt_free</methodname>
       <methodparam><type>resource</type><parameter>xh</parameter></methodparam>
     </methodsynopsis>
    <para>
     Free the XSLT processor identified by the given handle.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-openlog">
   <refnamediv>
    <refname>xslt_openlog</refname>
    <refpurpose>Set a logfile for XSLT processor messages</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>xslt_openlog</methodname>
       <methodparam><parameter>resource xh</parameter></methodparam>
       <methodparam><parameter>string logfile</parameter></methodparam>
       <methodparam choice="opt"><parameter>int loglevel</parameter></methodparam>  
     </methodsynopsis>
    <para>
     Set a logfile for the XSLT processor to place all of its error
     messages.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-output-begintransform">
   <refnamediv>
    <refname>xslt_output_begintransform</refname>
    <refpurpose>unknown</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>unknown</type><methodname>xslt_output_begintransform</methodname>
       <methodparam><type></type><parameter>unknown</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function lacks a prototype definition.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-output-endtransform">
   <refnamediv>
    <refname>xslt_output_endtransform</refname>
    <refpurpose>unknown</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>unknown</type><methodname>xslt_output_endtransform</methodname>
       <methodparam><type></type><parameter>unknown</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function lacks a prototype definition.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-process">
   <refnamediv>
    <refname>xslt_output_process</refname>
    <refpurpose>unknown</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>unknown</type><methodname>xslt_process</methodname>
       <methodparam><type></type><parameter>unknown</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function lacks a prototype definition.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-run">
   <refnamediv>
    <refname>xslt_run</refname>
    <refpurpose>Apply a XSLT stylesheet to a file.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>xslt_run</methodname>
       <methodparam><type>resource</type><parameter>xh</parameter></methodparam>
       <methodparam><type>string</type><parameter>xslt_file</parameter></methodparam>
       <methodparam><type>string</type><parameter>xml_data_file</parameter></methodparam>
       <methodparam choice="opt"><type>string</type><parameter>result</parameter></methodparam>
       <methodparam choice="opt"><type>array</type><parameter>xslt_params</parameter></methodparam>
       <methodparam choice="opt"><type>array</type><parameter>xslt_args</parameter></methodparam>
     </methodsynopsis>
    <para>
      Process the xml_data_file by applying the xslt_file stylesheet to
      it. The stylesheet has access to xslt_params and the processor
      is started with xslt_args. The result of the XSLT transformation
      is placed in the named buffer (default is &quot;/_result&quot;).
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-set-sax-handler">
   <refnamediv>
    <refname>xslt_set_sax_handler</refname>
    <refpurpose>Set SAX handlers for a XSLT processor</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>xslt_set_sax_handler</methodname>
       <methodparam><type>resource</type><parameter>xh</parameter></methodparam>
       <methodparam><type></type><parameter>handlers</parameter></methodparam>
     </methodsynopsis>
    <para>
     Set SAX handlers on the ressource handle given by xh.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.xslt-transform">
   <refnamediv>
    <refname>xslt_transform</refname>
    <refpurpose>unknown</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>unknown</type><methodname>xslt_transform</methodname>
       <methodparam><type></type><parameter>unknown</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function lacks a prototype definition.
    </para>
   </refsect1>
  </refentry>

 </reference>

<!-- 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:
-->