wez             Sat Jun 21 09:24:59 2003 EDT

  Added files:                 
    /phpdoc/en/reference/sqlite/functions       sqlite-create-aggregate.xml 
                                                sqlite-udf-decode-binary.xml 
                                                sqlite-udf-encode-binary.xml 

  Removed files:               
    /phpdoc/en/reference/sqlite/functions       sqlite-register-aggregate.xml 

  Modified files:              
    /phpdoc/en/reference/sqlite ini.xml reference.xml 
    /phpdoc/en/reference/sqlite/functions       sqlite-create-function.xml 
                                                sqlite-escape-string.xml 
                                                sqlite-libencoding.xml 
  Log:
  Some corrections and additions in readyness for 1.0 release.
  
  
Index: phpdoc/en/reference/sqlite/ini.xml
diff -u phpdoc/en/reference/sqlite/ini.xml:1.2 phpdoc/en/reference/sqlite/ini.xml:1.3
--- phpdoc/en/reference/sqlite/ini.xml:1.2      Fri Jun 20 14:26:30 2003
+++ phpdoc/en/reference/sqlite/ini.xml  Sat Jun 21 09:24:58 2003
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <section id="sqlite.configuration">
  &reftitle.runtime;
  &extension.runtime;
@@ -18,7 +18,7 @@
      <row>
       <entry>sqlite.assoc_case</entry>
       <entry>0</entry>
-      <entry>PHP_INI_SYSTEM</entry>
+      <entry>PHP_INI_ALL</entry>
      </row>
     </tbody>
    </tgroup>
Index: phpdoc/en/reference/sqlite/reference.xml
diff -u phpdoc/en/reference/sqlite/reference.xml:1.5 
phpdoc/en/reference/sqlite/reference.xml:1.6
--- phpdoc/en/reference/sqlite/reference.xml:1.5        Fri Jun 20 16:19:29 2003
+++ phpdoc/en/reference/sqlite/reference.xml    Sat Jun 21 09:24:58 2003
@@ -1,11 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
  <reference id="ref.sqlite">
   <title>SQLite</title>
   <titleabbrev>SQLite</titleabbrev>
 
   <partintro>
-   &warn.experimental;
    <section id="sqlite.intro">
     &reftitle.intro;
     <para>
Index: phpdoc/en/reference/sqlite/functions/sqlite-create-function.xml
diff -u phpdoc/en/reference/sqlite/functions/sqlite-create-function.xml:1.3 
phpdoc/en/reference/sqlite/functions/sqlite-create-function.xml:1.4
--- phpdoc/en/reference/sqlite/functions/sqlite-create-function.xml:1.3 Fri Jun 20 
14:57:15 2003
+++ phpdoc/en/reference/sqlite/functions/sqlite-create-function.xml     Sat Jun 21 
09:24:58 2003
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry id="function.sqlite-create-function">
  <refnamediv>
   <refname>sqlite_create_function</refname>
@@ -90,7 +90,8 @@
     For performance reasons, PHP will not automatically encode/decode binary
     data passed to and from your UDF's.  You need to manually encode/decode
     the parameters and return values if you need to process binary data in
-    this way.
+    this way.  Take a look at <function>sqlite_udf_encode_binary</function>
+    and <function>sqlite_udf_decode_binary</function> for more details.
    </para>
   </note>
   <tip>
@@ -100,8 +101,15 @@
     application.
    </para>
   </tip>
+  <tip>
+   <para>
+    You can use <function>sqlite_create_function</function> and
+    <function>sqlite_create_aggregate</function> to override SQLite native
+    SQL functions.
+   </para>
+  </tip>
   <para>
-   See also <function>sqlite_register_aggregate</function>.
+   See also <function>sqlite_create_aggregate</function>.
   </para>
  </refsect1>
 </refentry>
Index: phpdoc/en/reference/sqlite/functions/sqlite-escape-string.xml
diff -u phpdoc/en/reference/sqlite/functions/sqlite-escape-string.xml:1.3 
phpdoc/en/reference/sqlite/functions/sqlite-escape-string.xml:1.4
--- phpdoc/en/reference/sqlite/functions/sqlite-escape-string.xml:1.3   Fri Jun 20 
14:57:15 2003
+++ phpdoc/en/reference/sqlite/functions/sqlite-escape-string.xml       Sat Jun 21 
09:24:58 2003
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry id="function.sqlite-escape-string">
  <refnamediv>
   <refname>sqlite_escape_string</refname>
@@ -39,6 +39,14 @@
     when retrieving your data.
    </simpara>
   </warning>
+  <note>
+   <simpara>
+    Do not use this function to encode the return values from UDF's created
+    using <function>sqlite_create_function</function> or
+    <function>sqlite_create_aggregate</function> - use
+    <function>sqlite_udf_encode_binary</function> instead.
+   </simpara>
+  </note>
  </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
Index: phpdoc/en/reference/sqlite/functions/sqlite-libencoding.xml
diff -u phpdoc/en/reference/sqlite/functions/sqlite-libencoding.xml:1.3 
phpdoc/en/reference/sqlite/functions/sqlite-libencoding.xml:1.4
--- phpdoc/en/reference/sqlite/functions/sqlite-libencoding.xml:1.3     Fri Jun 20 
14:57:15 2003
+++ phpdoc/en/reference/sqlite/functions/sqlite-libencoding.xml Sat Jun 21 09:24:58 
2003
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry id="function.sqlite-libencoding">
  <refnamediv>
   <refname>sqlite_libencoding</refname>
@@ -32,12 +32,14 @@
    example), and some comparison operations may still not be carried out
    correctly.
   </para>
-  <para>
-   It is not recommended that you use PHP in a web-server configuration
-   with a version of the SQLite library compiled with UTF-8 support, since
-   libsqlite will abort the process if it detects a problem with the
-   UTF-8 encoding.
-  </para>
+  <warning>
+   <para>
+    It is not recommended that you use PHP in a web-server configuration
+    with a version of the SQLite library compiled with UTF-8 support, since
+    libsqlite will abort the process if it detects a problem with the
+    UTF-8 encoding.
+   </para>
+  </warning>
   <para>
    See also <function>sqlite_libversion</function>.
   </para>

Index: phpdoc/en/reference/sqlite/functions/sqlite-create-aggregate.xml
+++ phpdoc/en/reference/sqlite/functions/sqlite-create-aggregate.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sqlite-create-aggregate">
 <refnamediv>
  <refname>sqlite_create_aggregate</refname>
  <refpurpose>Register an aggregating UDF for use in SQL statements</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>bool</type><methodname>sqlite_create_aggregate</methodname>
   <methodparam><type>resource</type><parameter>db</parameter></methodparam>
   <methodparam><type>string</type><parameter>function_name</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>step_func</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>finalize_func</parameter></methodparam>
   <methodparam 
choice="opt"><type>int</type><parameter>num_args</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>sqlite_create_aggregate</function> is similar to
   <function>sqlite_create_function</function> except that it registers
   functions that can be used to calculate a result aggregated across all the
   rows of a query.
  </para>
  <para>
   The key difference between this function and
   <function>sqlite_create_function</function> is that two functions are
   required to manage the aggregate; <parameter>step_func</parameter> is
   called for each row of the result set.  Your PHP function should
   accumulate the result and store it into the aggregation context.
   Once all the rows have been processed,
   <parameter>finalize_func</parameter> will be called and it should then
   take the data from the aggregation context and return the result.
  </para>
  <para>
   <example>
    <title>max_length aggregation function example</title>
    <programlisting role="php">
<![CDATA[
<?php
$data = array(
   'one',
   'two',
   'three',
   'four'
   'five'
   'six',
   'seven',
   'eight',
   'nine'
   'ten'
   );
$db = sqlite_open(':memory:');
sqlite_query($db, "CREATE TABLE strings(a)");
foreach ($data as $str) {
  sqlite_query($db, "INSERT INTO strings VALUES('" .
    sqlite_escape_string($str) . "')");
}

function max_len_step(&$context, $string) {
  if (strlen($string) > $context) {
    $context = strlen($string);
  }
}

function max_len_finalize(&$context) {
  return $context;
}

sqlite_create_aggregate($db, 'max_len', 'max_len_step', 'max_len_finalize');

var_dump(sqlite_array_query($db, 'SELECT max_len(a) from strings'));

?>]]>
    </programlisting>
   </example>
  </para>
  <para>
   In this example, we are creating an aggregating function that will
   calculate the length of the longest string in one of the columns of the
   table.  For each row, the <literal>max_len_step</literal> function is
   called and passed a <parameter>context</parameter> parameter.  The context
   parameter is just like any other PHP variable and be set to hold an array
   or even an object value.  In this example, we are simply using it to hold
   the maximum length we have seen so far; if the
   <parameter>string</parameter> has a length longer than the current
   maximum, we update the the context to hold this new maximum length.
  </para>
  <para>
   After all of the rows have been processed, SQLite calls the
   <literal>max_len_finalize</literal> function to determine the aggregate
   result.  Here, we could perform some kind of calculation based on the
   data found in the <parameter>context</parameter>.  In our simple example
   though, we have been calculating the result as the query progressed, so we
   simply need to return the context value.
  </para>
  <note>
   <para>
    The example above will not work correctly if the column contains binary
    data.  Take a look at the manual page for
    <function>sqlite_udf_decode_binary</function> for an explanation of why
    this is so, and an example of how to make it respect the binary encoding.
   </para>
  </note>
  <tip>
   <para>
    It is NOT recommended for you to store a copy of the values in the context
    and then process them at the end, as you would cause SQLite to use a lot of
    memory to process the query - just think of how much memory you would need
    if a million rows were stored in memory, each containing a string 32 bytes
    in length.
   </para>
  </tip>
  <tip>
   <para>
    You can use <function>sqlite_create_function</function> and
    <function>sqlite_create_aggregate</function> to override SQLite native
    SQL functions.
   </para>
  </tip>
  <para>
   See also <function>sqlite_create_function</function>,
   <function>sqlite_udf_encode_binary</function> and
   <function>sqlite_udf_decode_binary</function>.
  </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
 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
 -->

Index: phpdoc/en/reference/sqlite/functions/sqlite-udf-decode-binary.xml
+++ phpdoc/en/reference/sqlite/functions/sqlite-udf-decode-binary.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sqlite-udf-decode-binary">
 <refnamediv>
  <refname>sqlite_udf_decode_binary</refname>
  <refpurpose>Decode binary data passed as parameters to an UDF</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>string</type><methodname>sqlite_udf_decode_binary</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>sqlite_udf_decode_binary</function> decodes the binary encoding
   that was applied to the parameter by either
   <function>sqlite_udf_encode_binary</function> or
   <function>sqlite_escape_string</function>.
  </para>
  <para>
   You must call this function on parameters passed to your UDF if you need
   them to handle binary data, as the binary encoding employed by PHP will
   obscure the content and of the parameter in its natural, non-coded form.
  </para>
  <para>
   PHP does not perform this encode/decode operation automatically as it would
   severely impact performance if it did.
  </para>
  <para>
   <example>
    <title>binary-safe max_length aggregation function example</title>
    <programlisting role="php">
<![CDATA[
<?php
$data = array(
   'one',
   'two',
   'three',
   'four'
   'five'
   'six',
   'seven',
   'eight',
   'nine'
   'ten'
   );
$db = sqlite_open(':memory:');
sqlite_query($db, "CREATE TABLE strings(a)");
foreach ($data as $str) {
  sqlite_query($db, "INSERT INTO strings VALUES('" .
    sqlite_escape_string($str) . "')");
}

function max_len_step(&$context, $string) {
  $string = sqlite_udf_decode_binary($string);
  if (strlen($string) > $context) {
    $context = strlen($string);
  }
}

function max_len_finalize(&$context) {
  return $context;
}

sqlite_create_aggregate($db, 'max_len', 'max_len_step', 'max_len_finalize');

var_dump(sqlite_array_query($db, 'SELECT max_len(a) from strings'));

?>]]>
    </programlisting>
   </example>
  </para>
  <para>
   See also <function>sqlite_udf_encode_binary</function>, 
   <function>sqlite_create_function</function> and
   <function>sqlite_create_aggregate</function>.
  </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
 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
 -->

Index: phpdoc/en/reference/sqlite/functions/sqlite-udf-encode-binary.xml
+++ phpdoc/en/reference/sqlite/functions/sqlite-udf-encode-binary.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sqlite-udf-encode-binary">
 <refnamediv>
  <refname>sqlite_udf_encode_binary</refname>
  <refpurpose>Encode binary data before returning it from an UDF</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>string</type><methodname>sqlite_udf_encode_binary</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>sqlite_udf_encode_binary</function> applies a binary encoding
   to the <parameter>data</parameter> so that it can be safely returned from
   queries (since the underlying libsqlite API is not binary safe).
  </para>
  <para>
   If there is a chance that your data might be binary unsafe (eg: it
   contains a NUL byte in the middle rather than at the end, or if it has and
   <literal>0x01</literal> byte as the first character) then you must
   call this function to encode the return value from your UDF.
  </para>
  <para>
   PHP does not perform this encode/decode operation automatically as it would
   severely impact performance if it did.
  </para>
  <note>
   <para>
   Do not use <function>sqlite_escape_string</function> to quote strings
   returned from UDF's as it will lead to double-quoting of the data.  Use
   this function instead!
   </para>
  </note>
  <para>
   See also <function>sqlite_udf_decode_binary</function>,
   <function>sqlite_escape_string</function>, 
   <function>sqlite_create_function</function> and
   <function>sqlite_create_aggregate</function>.
  </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
 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
 -->

-- 
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

Reply via email to