]> git.mxchange.org Git - mailer.git/blobdiff - templates/xml/admin_data_template.xml
These are all handlers
[mailer.git] / templates / xml / admin_data_template.xml
index a1639cb5807f3c766c9c99fa25f018f8c269d377..5edb946296aa9558f0ef05d8c638ae653811dac8 100644 (file)
@@ -10,7 +10,7 @@ tag intact.
 @copyright     (c) 2003 - 2009 by Roland Haeder
 @copyright     (c) 2009 - 2011 by Mailer Developer Team
 @license       GNU GPL 2.0 or any newer version
-@link          http://www.mxchange.org
+@link          http://mxchange.org
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -31,16 +31,13 @@ MA  02110-1301  USA
        <!--
        Call-back function which should all following parameter handled over
        to. This will always be type of string but we like homogene XMLs.
+       Keep 'name' empty for numerical array indexes (array keys).
        //-->
-       <admin-callback-function type="string" value="adminFooEntriesBar" />
-       <!--
-       Array index from HTTP POST data array for identifying every data row
-       //-->
-       <post-data-identify-index type="string" value="id" />
+       <callback-function type="string" value="adminFooEntriesBar" />
        <!--
        Name of the database table where the entries should be read/write from/to.
        //-->
-       <database-table type="string" value="table_name" />
+       <database-table name="" type="string" value="table_name" />
        <!--
        The following three lists must have the same count of list entries, else an
        error may occur.
@@ -53,7 +50,7 @@ MA  02110-1301  USA
                A column name list entry. The type is always string, or do you have
                numerical column names?
                //-->
-               <database-column-list-entry type="string" value="foo" />
+               <database-column-list-entry name="" type="string" table="" value="foo" alias="" function="" />
        </database-column-list>
        <!--
        "Filter" call-back functions to call back for piping the fetched data
@@ -63,7 +60,7 @@ MA  02110-1301  USA
                <!--
                A call-back function list entry
                //-->
-               <callback-function-list-entry type="string" value="someFooCallback" />
+               <callback-function-list-entry name="" type="string" value="someFooCallback" />
        </callback-function-list>
        <!--
        Extra parameters (2nd, 3rd, ...) for above call-back functions. If an array
@@ -73,51 +70,58 @@ MA  02110-1301  USA
        <extra-parameter-list>
                <!--
                A list entry for a single extra parameter. 'type' can now be: string,
-               int, float, bool, array. If the type 'array' is provided, the parser searches
-               for a tag called "extra-parameter-<value>-list(-entry)", by <value>
-               is the value from the 'value' attribute. Please check out the examples below.
+               int, float, bool, array. If the type 'array' is provided, the parser
+               searches for a tag called "extra-parameter-<value>-list(-entry)", by
+               <value> is the value from the 'value' attribute. Please check out the
+               examples below. In addition to that you need to maintain <value>_list
+               in all corresponding elements, see admin_edit_show_surfbar_urls.xml for
+               an example.
                //-->
                <!--
-               A simple string example, int and float are similar.
+               A simple string example with a numerical index, int and float are similar.
                //-->
-               <extra-parameter-list-entry type="string" value="foo" />
+               <extra-parameter-list-entry name="" type="string" value="foo" />
                <!--
-               A simple bool example, value can only be 'false' or 'true'
+               A simple bool example with a numerical index, value can only be 'false' or 'true'
                //-->
-               <extra-parameter-list-entry type="bool" value="false" />
+               <extra-parameter-list-entry name="" type="bool" value="false" />
                <!--
-               A one-dimensional array with some entries
+               A one-dimensional array with a numerical index and with some entries
                //-->
-               <extra-parameter-list-entry type="array" value="bar">
+               <extra-parameter-list-entry name="" type="array" value="bar">
                        <!--
                        Our 'bar' array
                        //-->
                        <extra-parameter-bar-list>
                                <!--
-                               A bool entry in the 'bar' array, all other types are added in a
-                               similar way.
+                               A bool entry with a numerical index in the 'bar' array, all
+                               other types are added in a similar way.
+                               //-->
+                               <extra-parameter-bar-list-entry name="" type="bool" value="true" />
+                               <!--
+                               A float entry with a alpha-numerical index in the 'bar' array.
                                //-->
-                               <extra-parameter-bar-list-entry type="bool" value="true" />
+                               <extra-parameter-bar-list-entry name="my_key" type="float" value="1.2345" />
                        </extra-parameter-bar-list>
                </extra-parameter-list-entry>
        </extra-parameter-list>
        <!--
        Wether to 'edit/delete/change' (change) the entries (true) or just read them for displaying (false)
        //-->
-       <enable-modify-entries type="bool" value="false" />
+       <enable-modify-entries name="" type="bool" value="false" />
        <!--
        The table column which should be taken for the ids (see first parameter).
        This' type can again only be 'string' (remember why?).
        //-->
-       <table-id-column type="string" value="id" />
+       <table-id-column name="" type="string" value="id" />
        <!--
        The table column which should be taken for user ids
        This' type can again only be 'string' (remember why?).
        //-->
-       <table-userid-column type="string" value="userid" />
+       <table-userid-column name="" type="string" value="userid" />
        <!--
        Raw userid column ($key) to skip which is always an invalid (?) entry
        This' type can again only be 'string' (remember why?).
        //-->
-       <raw-userid-column-key type="string" value="userid" />
+       <raw-userid-column-key name="" type="string" value="userid" />
 </admin-entry-meta-data>