From c685c8d7c85959f30de4b4b827d905e208f9b5b9 Mon Sep 17 00:00:00 2001
From: Kalle Sommer Nielsen <kalle@php.net>
Date: Wed, 10 Dec 2008 16:36:01 +0000
Subject: [PATCH] * Document XSLTProcessor::setProfiling() method * Document
 stream_supports_lock() * Document str_getcsv() * gmp_testbit() is available
 as of 5.3

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@270943 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/gmp/versions.xml                    |   3 +-
 .../stream/functions/stream-supports-lock.xml |  74 ++++++++++++
 reference/stream/versions.xml                 |   3 +-
 reference/strings/functions/str-getcsv.xml    |  55 ++++++++-
 reference/xsl/versions.xml                    |   3 +-
 reference/xsl/xsltprocessor/setprofiling.xml  | 110 ++++++++++++++++++
 6 files changed, 243 insertions(+), 5 deletions(-)
 create mode 100644 reference/stream/functions/stream-supports-lock.xml
 create mode 100644 reference/xsl/xsltprocessor/setprofiling.xml

diff --git a/reference/gmp/versions.xml b/reference/gmp/versions.xml
index e9a8d53a27..d60b12b560 100644
--- a/reference/gmp/versions.xml
+++ b/reference/gmp/versions.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!--
   Do NOT translate this file
 -->
@@ -43,6 +43,7 @@
  <function name='gmp_sqrtrem' from='PHP 4 &gt;= 4.0.4, PHP 5'/>
  <function name='gmp_strval' from='PHP 4 &gt;= 4.0.4, PHP 5'/>
  <function name='gmp_sub' from='PHP 4 &gt;= 4.0.4, PHP 5'/>
+ <function name='gmp_testbit' from='PHP 5 &gt;= 5.3.0'/>
  <function name='gmp_xor' from='PHP 4 &gt;= 4.0.4, PHP 5'/>
 </versions>
 
diff --git a/reference/stream/functions/stream-supports-lock.xml b/reference/stream/functions/stream-supports-lock.xml
new file mode 100644
index 0000000000..19f7d9cca5
--- /dev/null
+++ b/reference/stream/functions/stream-supports-lock.xml
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xml:id="function.stream-supports-lock" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>stream_supports_lock</refname>
+  <refpurpose>Tells wether the stream supports locking.</refpurpose>
+ </refnamediv>
+ 
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>resource</type><methodname>stream_supports_locking</methodname>
+   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Tells wether the stream supports locking through 
+   <function>flock</function>.
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="parameters"><!-- {{{ -->
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>stream</parameter></term>
+     <listitem>
+      <para>
+       The stream to check.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1><!-- }}} -->
+
+ <refsect1 role="returnvalues"><!-- {{{ -->
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1><!-- }}} -->
+ 
+ <refsect1 role="seealso"><!-- {{{ -->
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>flock</function></member>
+   </simplelist>
+  </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:"../../../../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
+-->
diff --git a/reference/stream/versions.xml b/reference/stream/versions.xml
index 70f06e540c..40ce712f4b 100644
--- a/reference/stream/versions.xml
+++ b/reference/stream/versions.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!--
   Do NOT translate this file
 -->
@@ -39,6 +39,7 @@
  <function name='stream_socket_sendto' from='PHP 5'/>
  <function name='stream_socket_server' from='PHP 5'/>
  <function name='stream_socket_shutdown' from='PHP 5 &gt;= 5.2.1'/>
+ <function name='stream_supports_lock' from='PHP 5 &gt;= 5.3.0'/>
  <function name='stream_wrapper_register' from='PHP 4 &gt;= 4.3.2, PHP 5'/>
  <function name='stream_wrapper_restore' from='PHP 5 &gt;= 5.1.0'/>
  <function name='stream_wrapper_unregister' from='PHP 5 &gt;= 5.1.0'/>
diff --git a/reference/strings/functions/str-getcsv.xml b/reference/strings/functions/str-getcsv.xml
index fd9e972c83..8257bea186 100644
--- a/reference/strings/functions/str-getcsv.xml
+++ b/reference/strings/functions/str-getcsv.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.str-getcsv">
  <refnamediv>
   <refname>str_getcsv</refname>
@@ -18,7 +18,58 @@
    <methodparam choice="opt"><type>string</type><parameter>escape</parameter></methodparam>
   </methodsynopsis>
   <para>
-   &warn.undocumented.func;
+   Similar to <function>fgetcsv</function> this functions parses a 
+   string as its input unlike <function>fgetcsv</function> which 
+   takes a file as its input.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>input</parameter></term>
+     <listitem>
+      <para>
+       The string to parse.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>delimiter</parameter></term>
+     <listitem>
+      <para>
+       Set the field delimiter (one character only). Defaults as a comma.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>enclosure</parameter></term>
+     <listitem>
+      <para>
+       Set the field enclosure character (one character only). Defaults as a
+       double quotation mark.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>escape</parameter></term>
+     <listitem>
+      <para>
+       Set the escape character (one character only). Defaults as a backslash
+       (<literal>\</literal>)
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an indexed array containing the fields read.
   </para>
  </refsect1>
 
diff --git a/reference/xsl/versions.xml b/reference/xsl/versions.xml
index 12bc6ff3b3..bacaec8986 100644
--- a/reference/xsl/versions.xml
+++ b/reference/xsl/versions.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!--
   Do NOT translate this file
 -->
@@ -10,6 +10,7 @@
  <function name='xsl_xsltprocessor_register_php_functions' from='PHP 5 &gt;= 5.0.4'/>
  <function name='xsl_xsltprocessor_remove_parameter' from='PHP 5'/>
  <function name='xsl_xsltprocessor_set_parameter' from='PHP 5'/>
+ <function name='xsl_xsltprocessor_set_parameter' from='PHP &gt;= 5.3.0'/>
  <function name='xsl_xsltprocessor_transform_to_doc' from='PHP 5'/>
  <function name='xsl_xsltprocessor_transform_to_uri' from='PHP 5'/>
  <function name='xsl_xsltprocessor_transform_to_xml' from='PHP 5'/>
diff --git a/reference/xsl/xsltprocessor/setprofiling.xml b/reference/xsl/xsltprocessor/setprofiling.xml
new file mode 100644
index 0000000000..7a18f052d8
--- /dev/null
+++ b/reference/xsl/xsltprocessor/setprofiling.xml
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xml:id="xsltprocessor.setprofiling" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>XSLTProcessor::setProfiling</refname>
+  <refpurpose>Sets profiling output file</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <classsynopsis>
+   <ooclass><classname>XSLTProcessor</classname></ooclass>
+   <methodsynopsis>
+    <type>bool</type><methodname>setProfiling</methodname>
+    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
+   </methodsynopsis>
+  </classsynopsis>
+  <para>
+   Sets the file to output profiling information when processing 
+   a stylesheet.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>filename</parameter></term>
+     <listitem>
+      <para>
+       Path to the file to dump profiling information.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Example profiling output</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+// Load the XML source
+$xml = new DOMDocument;
+$xml->load('collection.xml');
+
+$xsl = new DOMDocument;
+$xsl->load('collection.xsl');
+
+// Configure the transformer
+$proc = new XSLTProcessor;
+$proc->setProfiling('profiling.txt');
+$proc->importStyleSheet($xsl); // attach the xsl rules
+
+echo trim($proc->transformToDoc($xml)->firstChild->wholeText);
+?>
+]]>
+    </programlisting>
+    <para>
+     The above code will produce the following information 
+     in the profiling file:
+    </para>
+    <screen>
+<![CDATA[
+number               match                name      mode  Calls Tot 100us Avg
+
+    0                   cd                                    2      3      1
+    1           collection                                    1      1      1
+
+                         Total                                3      4
+
+]]>
+    </screen>
+   </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:"../../../../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
+-->