[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pear-doc
Subject:    [PEAR-DOC] cvs: peardoc /en/package/structures/structures-datagrid/structures-datagrid-datasource ar
From:       "Mark Wiesemann" <wiesemann () php ! net>
Date:       2007-09-12 21:05:36
Message-ID: cvswiesemann1189631136 () cvsserver
[Download RAW message or body]

wiesemann		Wed Sep 12 21:05:36 2007 UTC

  Modified files:              
    /peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource	
                                                                                     	array.xml 
                                                                                     	csv.xml 
                                                                                     	db.xml 
                                                                                     	excel.xml 
                                                                                     	rss.xml 
                                                                                     	xml.xml 
  Log:
  - sync documentation addition and new 'natsort' option from source code
  
["wiesemann-20070912210536.txt" (text/plain)]

http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml?r1=1.8&r2=1.9&diff_format=u
                
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml
                
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml:1.8 \
peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml:1.9
                
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml:1.8	Sun \
                Jul 22 14:41:39 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml	Wed \
Sep 12 21:05:36 2007 @@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.array">
  <refnamediv>
   <refname>Structures_DataGrid_DataSource_Array</refname>
@@ -8,7 +8,7 @@
  <refsect1 id="package.structures.structures-datagrid.structures-datagrid-datasource.array.desc">
  <title>Description</title>
   <para>
-   This class is a data source driver for a 2D Array
+   This class is a data source driver for a 2D array
   </para>
  </refsect1>
  <refsect1 id="package.structures.structures-datagrid.structures-datagrid-datasource.array.modes">
 @@ -79,6 +79,14 @@
       <entry>array()</entry>
      </row>
      <row>
+      <entry>natsort</entry>
+      <entry>boolean</entry>
+      <entry>Whether the array should be sorted naturally (e.g. example1,
+       Example2, test1, Test2) or not (e.g. Example2, Test2, example1, test1;
+       i.e. capital letters will come first).</entry>
+      <entry>false</entry>
+     </row>
+     <row>
       <entry>primaryKey</entry>
       <entry>array</entry>
       <entry>Name(s), or numerical index(es) of the field(s) which contain a
@@ -90,6 +98,25 @@
    </tgroup>
   </table>
  </refsect1>
+ <refsect1 id="package.structures.structures-datagrid.structures-datagrid-datasource.array.notes">
 +  <title>General notes</title>
+  <para>
+   This driver expects an array of the following form:
+   <programlisting>
+$data = array(0 =&gt; array('col0' =&gt; 'val00', 'col1' =&gt; 'val01', ...),
+              1 =&gt; array('col0' =&gt; 'val10', 'col1' =&gt; 'val11', ...),
+              ...
+             );
+   </programlisting>
+  </para>
+  <para>   
+   The first level of this array contains one entry for each row. For every
+   row entry an array with the data for this row is expected. Such an array
+   contains the field names as the keys. For example, 'val01' is the value
+   of the column with the field name 'col1' in the first row. Row numbers
+   start with 0, not with 1.
+  </para>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml?r1=1.9&r2=1.10&diff_format=u
                
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml
                
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml:1.9 \
peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml:1.10
                
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml:1.9	Sun \
                Jul 22 14:41:39 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml	Wed \
Sep 12 21:05:36 2007 @@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.csv">
  <refnamediv>
   <refname>Structures_DataGrid_DataSource_CSV</refname>
@@ -98,6 +98,14 @@
       <entry>array()</entry>
      </row>
      <row>
+      <entry>natsort</entry>
+      <entry>boolean</entry>
+      <entry>Whether the array should be sorted naturally (e.g. example1,
+       Example2, test1, Test2) or not (e.g. Example2, Test2, example1, test1;
+       i.e. capital letters will come first).</entry>
+      <entry>false</entry>
+     </row>
+     <row>
       <entry>primaryKey</entry>
       <entry>array</entry>
       <entry>Name(s), or numerical index(es) of the field(s) which contain a
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml?r1=1.8&r2=1.9&diff_format=u
                
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml
                
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml:1.8 \
peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml:1.9
                
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml:1.8	Sun \
                Jul 22 14:41:39 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml	Wed \
Sep 12 21:05:36 2007 @@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.db">
  <refnamediv>
   <refname>Structures_DataGrid_DataSource_DB</refname>
@@ -79,6 +79,14 @@
       <entry>array()</entry>
      </row>
      <row>
+      <entry>natsort</entry>
+      <entry>boolean</entry>
+      <entry>Whether the array should be sorted naturally (e.g. example1,
+       Example2, test1, Test2) or not (e.g. Example2, Test2, example1, test1;
+       i.e. capital letters will come first).</entry>
+      <entry>false</entry>
+     </row>
+     <row>
       <entry>primaryKey</entry>
       <entry>array</entry>
       <entry>Name(s), or numerical index(es) of the field(s) which contain a
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml?r1=1.9&r2=1.10&diff_format=u
                
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml
                
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml:1.9 \
peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml:1.10
                
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml:1.9	Sun \
                Jul 22 14:41:39 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml	Wed \
Sep 12 21:05:36 2007 @@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.excel">
  <refnamediv>
   <refname>Structures_DataGrid_DataSource_Excel</refname>
@@ -85,6 +85,14 @@
       <entry>array()</entry>
      </row>
      <row>
+      <entry>natsort</entry>
+      <entry>boolean</entry>
+      <entry>Whether the array should be sorted naturally (e.g. example1,
+       Example2, test1, Test2) or not (e.g. Example2, Test2, example1, test1;
+       i.e. capital letters will come first).</entry>
+      <entry>false</entry>
+     </row>
+     <row>
       <entry>primaryKey</entry>
       <entry>array</entry>
       <entry>Name(s), or numerical index(es) of the field(s) which contain a
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml?r1=1.8&r2=1.9&diff_format=u
                
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml
                
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml:1.8 \
peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml:1.9
                
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml:1.8	Sun \
                Jul 22 14:41:39 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml	Wed \
Sep 12 21:05:36 2007 @@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.rss">
  <refnamediv>
   <refname>Structures_DataGrid_DataSource_RSS</refname>
@@ -73,6 +73,14 @@
       <entry>array()</entry>
      </row>
      <row>
+      <entry>natsort</entry>
+      <entry>boolean</entry>
+      <entry>Whether the array should be sorted naturally (e.g. example1,
+       Example2, test1, Test2) or not (e.g. Example2, Test2, example1, test1;
+       i.e. capital letters will come first).</entry>
+      <entry>false</entry>
+     </row>
+     <row>
       <entry>primaryKey</entry>
       <entry>array</entry>
       <entry>Name(s), or numerical index(es) of the field(s) which contain a
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml?r1=1.10&r2=1.11&diff_format=u
                
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml
                
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml:1.10 \
peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml:1.11
                
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml:1.10	Sun \
                Jul 22 14:41:39 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml	Wed \
Sep 12 21:05:36 2007 @@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
 <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.xml">
  <refnamediv>
   <refname>Structures_DataGrid_DataSource_XML</refname>
@@ -96,6 +96,14 @@
       <entry>array()</entry>
      </row>
      <row>
+      <entry>natsort</entry>
+      <entry>boolean</entry>
+      <entry>Whether the array should be sorted naturally (e.g. example1,
+       Example2, test1, Test2) or not (e.g. Example2, Test2, example1, test1;
+       i.e. capital letters will come first).</entry>
+      <entry>false</entry>
+     </row>
+     <row>
       <entry>primaryKey</entry>
       <entry>array</entry>
       <entry>Name(s), or numerical index(es) of the field(s) which contain a



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

[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic