cvs: peardoc /en/package/structures/structures-datagrid/structures-datagrid addcolumn.xml removecolumn.xml sortrecordset.xml
/en/package/structures/structures-datagrid/structures-datagrid-datasource array.xml csv.xml dataobject.xml db.xml dbquery.xml dbtable.xml excel.xml
mdb2.xml rss.xml xml.xml

wiesemann Wed Oct 25 10:17:24 2006 UTC Modified files: /peardoc/en/package/structures/structures-datagrid/structures-datagrid addcolumn.xml removecolumn.xml sortrecordset.xml /peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource array.xml csv.xml dataobject.xml db.xml dbquery.xml dbtable.xml excel.xml mdb2.xml rss.xml xml.xml Log: - sync latest source code changes

http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml?r1=1.14&r2=1.15&diff_format=u Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml:1.14 peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml:1.15 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml:1.14 Sun Aug 20 21:33:26 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml Wed Oct 25 10:17:23 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid.addcolumn"> <refnamediv> <refname><function>Structures_DataGrid::addColumn</function></refname> @@ -14,7 +14,7 @@ <paramdef> <parameter>&amp;$column</parameter></paramdef> - <paramdef>string <parameter> <optional>$position = &apos;last&apos;</optional></parameter></paramdef> + <paramdef>string <parameter> <optional>$position = 'last'</optional></parameter></paramdef> <paramdef>string <parameter> <optional>$relativeTo = &null;</optional></parameter></paramdef> <paramdef>object <parameter>$column</parameter></paramdef> </funcprototype> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid/removecolumn.xml?r1=1.2&r2=1.3&diff_format=u Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid/removecolumn.xml diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid/removecolumn.xml:1.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid/removecolumn.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid/removecolumn.xml:1.2 Tue Oct 24 15:39:51 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid/removecolumn.xml Wed Oct 25 10:17:24 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid.removecolumn"> <refnamediv> <refname><function>Structures_DataGrid::removeColumn</function></refname> @@ -80,7 +80,7 @@ $column =&amp; $datagrid-&gt;<link linkend="package.structures.structures-datagrid.structures-datagrid.getcolumnbyfield">getColumnByField</link>(&apos;ID&apos;); // And we drop that column: -$datagrid-&gt;removeColumn($column); +$datagrid-&gt;<link linkend="package.structures.structures-datagrid.structures-datagrid.removecolumn">removeColumn</link>($column); // This will only render 4 fields: Name, CountryCode, District and Population: $datagrid-&gt;<link linkend="package.structures.structures-datagrid.structures-datagrid.render">render</link>(); http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid/sortrecordset.xml?r1=1.12&r2=1.13&diff_format=u Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid/sortrecordset.xml diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid/sortrecordset.xml:1.12 peardoc/en/package/structures/structures-datagrid/structures-datagrid/sortrecordset.xml:1.13 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid/sortrecordset.xml:1.12 Sun Aug 20 21:33:26 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid/sortrecordset.xml Wed Oct 25 10:17:24 2006 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid.sortrecordset"> <refnamediv> <refname><function>Structures_DataGrid::sortRecordSet</function></refname> @@ -12,7 +12,7 @@ <funcprototype> <funcdef>void <function>Structures_DataGrid::sortRecordSet</function></funcdef> <paramdef>array <parameter>$sortSpec</parameter></paramdef> - <paramdef>string <parameter> <optional>$direction = &apos;ASC&apos;</optional></parameter></paramdef> + <paramdef>string <parameter> <optional>$direction = 'ASC'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml?r1=1.2&r2=1.3&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.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml:1.2 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/array.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.array"> <refnamediv> <refname>Structures_DataGrid_DataSource_Array</refname> @@ -49,6 +49,14 @@ 'generate_columns' is true. Form: array(field =&gt; label, ...)</entry> <entry>array()</entry> </row> + <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> </tbody> </tgroup> </table> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml?r1=1.2&r2=1.3&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.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml:1.2 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/csv.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.csv"> <refnamediv> <refname>Structures_DataGrid_DataSource_CSV</refname> @@ -62,6 +62,14 @@ 'generate_columns' is true. Form: array(field =&gt; label, ...)</entry> <entry>array()</entry> </row> + <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> </tbody> </tgroup> </table> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dataobject.xml?r1=1.2&r2=1.3&diff_format=u Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dataobject.xml diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dataobject.xml:1.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dataobject.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dataobject.xml:1.2 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dataobject.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.dataobject"> <refnamediv> <refname>Structures_DataGrid_DataSource_DataObject</refname> @@ -67,6 +67,14 @@ used.</entry> <entry>'fb_fieldsLabels'</entry> </row> + <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> </tbody> </tgroup> </table> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml?r1=1.2&r2=1.3&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.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml:1.2 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/db.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.db"> <refnamediv> <refname>Structures_DataGrid_DataSource_DB</refname> @@ -49,6 +49,14 @@ 'generate_columns' is true. Form: array(field =&gt; label, ...)</entry> <entry>array()</entry> </row> + <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> </tbody> </tgroup> </table> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbquery.xml?r1=1.2&r2=1.3&diff_format=u Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbquery.xml diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbquery.xml:1.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbquery.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbquery.xml:1.2 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbquery.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.dbquery"> <refnamediv> <refname>Structures_DataGrid_DataSource_DBQuery</refname> @@ -63,6 +63,14 @@ 'generate_columns' is true. Form: array(field =&gt; label, ...)</entry> <entry>array()</entry> </row> + <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> </tbody> </tgroup> </table> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbtable.xml?r1=1.3&r2=1.4&diff_format=u Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbtable.xml diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbtable.xml:1.3 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbtable.xml:1.4 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbtable.xml:1.3 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/dbtable.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.dbtable"> <refnamediv> <refname>Structures_DataGrid_DataSource_DBTable</refname> @@ -56,6 +56,14 @@ <entry>array()</entry> </row> <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> + <row> <entry>view</entry> <entry>string</entry> <entry>The view from $sql array in your DB_Table object. This option is @@ -82,6 +90,12 @@ of the view that this counting view belongs to. (For example: if you have a view named 'all', the counting view needs to be named as '__count_all'.) </para> + <para> + To use update() and delete() methods, it is required that the indexes are + properly defined in the $idx array in your DB_Table subclass. If you have, + for example, created your database table yourself and did not setup the $idx + array, you can use the 'primary_key' option to define the primary key field. + </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml?r1=1.1&r2=1.2&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.1 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml:1.2 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml:1.1 Sat Oct 14 20:33:16 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/excel.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.excel"> <refnamediv> <refname>Structures_DataGrid_DataSource_Excel</refname> @@ -55,6 +55,14 @@ 'generate_columns' is true. Form: array(field =&gt; label, ...)</entry> <entry>array()</entry> </row> + <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> </tbody> </tgroup> </table> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/mdb2.xml?r1=1.2&r2=1.3&diff_format=u Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/mdb2.xml diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/mdb2.xml:1.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/mdb2.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/mdb2.xml:1.2 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/mdb2.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.mdb2"> <refnamediv> <refname>Structures_DataGrid_DataSource_MDB2</refname> @@ -63,6 +63,14 @@ 'generate_columns' is true. Form: array(field =&gt; label, ...)</entry> <entry>array()</entry> </row> + <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> </tbody> </tgroup> </table> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml?r1=1.2&r2=1.3&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.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml:1.2 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/rss.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.rss"> <refnamediv> <refname>Structures_DataGrid_DataSource_RSS</refname> @@ -43,6 +43,14 @@ 'generate_columns' is true. Form: array(field =&gt; label, ...)</entry> <entry>array()</entry> </row> + <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> </tbody> </tgroup> </table> http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml?r1=1.2&r2=1.3&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.2 peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml:1.3 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml:1.2 Thu Sep 21 11:58:25 2006 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/xml.xml Wed Oct 25 10:17:24 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="package.structures.structures-datagrid.structures-datagrid-datasource.xml"> <refnamediv> <refname>Structures_DataGrid_DataSource_XML</refname> @@ -65,6 +65,14 @@ <entry>array()</entry> </row> <row> + <entry>primary_key</entry> + <entry>array</entry> + <entry>Name(s), or numerical index(es) of the field(s) which contain a + unique record identifier (only use several fields in case of a + multiple-fields primary key)</entry> + <entry></entry> + </row> + <row> <entry>xpath</entry> <entry>string</entry> <entry>XPath to a subset of the XML data.</entry>