php-doc-en/reference/xslt/functions/xslt-set-log.xml

94 lines
2.6 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/xslt.xml, last change in rev 1.3 -->
<refentry id="function.xslt-set-log">
<refnamediv>
<refname>xslt_set_log</refname>
<refpurpose>Set the log file to write log messages to</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>xslt_set_log</methodname>
<methodparam><type>resource</type><parameter>xh</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>log</parameter></methodparam>
</methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>xh</parameter></term>
<listitem>
<simpara>
A reference to the XSLT parser.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>log</parameter></term>
<listitem>
<simpara>
This parameter is either a boolean value which toggles logging on and
off, or a string containing the logfile in which log errors too.
</simpara>
</listitem>
</varlistentry>
</variablelist></para>
<para>
This function allows you to set the file in which you want XSLT log
messages to, XSLT log messages are different than error messages, in
that log messages are not actually error messages but rather messages
related to the state of the XSLT processor. They are useful for
debugging XSLT, when something goes wrong.
</para>
<para>
By default logging is disabled, in order to enable logging you must
first call <function>xslt_set_log</function> with a boolean parameter
which enables logging, then if you want to set the log file to debug to,
you must then pass it a string containing the filename.
</para>
&note.xslt.windows;
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Using the XSLT Logging features</title>
<programlisting role="php">
<![CDATA[
<?php
$xh = xslt_create();
xslt_set_log($xh, true);
xslt_set_log($xh, getcwd() . '/myfile.log');
$result = xslt_process($xh, 'dog.xml', 'pets.xsl');
echo $result;
xslt_free($xh);
?>
]]>
</programlisting>
</example>
</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
-->