php-doc-en/reference/xslt/functions/xslt-set-log.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

114 lines
3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.xslt-set-log" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>xslt_set_log</refname>
<refpurpose>Set the log file to write log messages to</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<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>
This function allows you to set the file in which you want <acronym>XSLT</acronym> log
messages to, <acronym>XSLT</acronym> 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 <acronym>XSLT</acronym> processor. They are useful for
debugging <acronym>XSLT</acronym>, 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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xh</parameter></term>
<listitem>
<para>
The XSLT processor link identifier, created with
<function>xslt_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>log</parameter></term>
<listitem>
<para>
This parameter is either a boolean value which toggles logging on and
off, or a string containing the logfile in which log errors too.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.xslt.windows;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Using the <acronym>XSLT</acronym> 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>
</para>
</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:"~/.phpdoc/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
-->