templates/xml/admin_data_template.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!--
   3 This is an admin XML template for all other XML templates which provides meta
   4 data for editing/deleting/changing database entries. If you want to write your
   5 own templates, please keep this header except *this* description and the author
   6 tag intact.
   7
   8 @author         Roland Haeder <webmaster@mxchange.org>
   9 @version        0.2.1-FINAL
  10 @copyright      (c) 2003 - 2009 by Roland Haeder
  11 @copyright      (c) 2009 - 2011 by Mailer Developer Team
  12 @license        GNU GPL 2.0 or any newer version
  13 @link           http://www.mxchange.org
  14
  15 This program is free software; you can redistribute it and/or modify
  16 it under the terms of the GNU General Public License as published by
  17 the Free Software Foundation; either version 2 of the License, or
  18 (at your option) any later version.
  19
  20 This program is distributed in the hope that it will be useful,
  21 but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 GNU General Public License for more details.
  24
  25 You should have received a copy of the GNU General Public License
  26 along with this program; if not, write to the Free Software
  27 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
  28 MA  02110-1301  USA
  29 //-->
  30 <admin-entry-meta-data>
  31         <!--
  32         Call-back function which should all following parameter handled over
  33         to. This will always be type of string but we like homogene XMLs.
  34         Keep 'name' empty for numerical array indexes (array keys).
  35         //-->
  36         <callback-function type="string" value="adminFooEntriesBar" />
  37         <!--
  38         Array index from HTTP POST data array for identifying every data row
  39         //-->
  40         <post-data-identify-index name="" type="string" value="id" />
  41         <!--
  42         Name of the database table where the entries should be read/write from/to.
  43         //-->
  44         <database-table name="" type="string" value="table_name" />
  45         <!--
  46         The following three lists must have the same count of list entries, else an
  47         error may occur.
  48         //-->
  49         <!--
  50         And all column names to read/write, leave this list tag empty for all (*).
  51         //-->
  52         <database-column-list>
  53                 <!--
  54                 A column name list entry. The type is always string, or do you have
  55                 numerical column names?
  56                 //-->
  57                 <database-column-list-entry name="" type="string" value="foo" />
  58         </database-column-list>
  59         <!--
  60         "Filter" call-back functions to call back for piping the fetched data
  61         through (can be left empty, no call-back function will be called)
  62         //-->
  63         <callback-function-list>
  64                 <!--
  65                 A call-back function list entry
  66                 //-->
  67                 <callback-function-list-entry name="" type="string" value="someFooCallback" />
  68         </callback-function-list>
  69         <!--
  70         Extra parameters (2nd, 3rd, ...) for above call-back functions. If an array
  71         is provided, we have more than two parameters to handle over to the
  72         call-back function. See function handleExtraValues() for details.
  73         //-->
  74         <extra-parameter-list>
  75                 <!--
  76                 A list entry for a single extra parameter. 'type' can now be: string,
  77                 int, float, bool, array. If the type 'array' is provided, the parser
  78                 searches for a tag called "extra-parameter-<value>-list(-entry)", by
  79                 <value> is the value from the 'value' attribute. Please check out the
  80                 examples below. In addition to that you need to maintain <value>_list
  81                 in all corresponding elements, see admin_edit_show_surfbar_urls.xml for
  82                 an example.
  83                 //-->
  84                 <!--
  85                 A simple string example with a numerical index, int and float are similar.
  86                 //-->
  87                 <extra-parameter-list-entry name="" type="string" value="foo" />
  88                 <!--
  89                 A simple bool example with a numerical index, value can only be 'false' or 'true'
  90                 //-->
  91                 <extra-parameter-list-entry name="" type="bool" value="false" />
  92                 <!--
  93                 A one-dimensional array with a numerical index and with some entries
  94                 //-->
  95                 <extra-parameter-list-entry name="" type="array" value="bar">
  96                         <!--
  97                         Our 'bar' array
  98                         //-->
  99                         <extra-parameter-bar-list>
 100                                 <!--
 101                                 A bool entry with a numerical index in the 'bar' array, all
 102                                 other types are added in a similar way.
 103                                 //-->
 104                                 <extra-parameter-bar-list-entry name="" type="bool" value="true" />
 105                                 <!--
 106                                 A float entry with a alpha-numerical index in the 'bar' array.
 107                                 //-->
 108                                 <extra-parameter-bar-list-entry name="my_key" type="float" value="1.2345" />
 109                         </extra-parameter-bar-list>
 110                 </extra-parameter-list-entry>
 111         </extra-parameter-list>
 112         <!--
 113         Wether to 'edit/delete/change' (change) the entries (true) or just read them for displaying (false)
 114         //-->
 115         <enable-modify-entries name="" type="bool" value="false" />
 116         <!--
 117         The table column which should be taken for the ids (see first parameter).
 118         This' type can again only be 'string' (remember why?).
 119         //-->
 120         <table-id-column name="" type="string" value="id" />
 121         <!--
 122         The table column which should be taken for user ids
 123         This' type can again only be 'string' (remember why?).
 124         //-->
 125         <table-userid-column name="" type="string" value="userid" />
 126         <!--
 127         Raw userid column ($key) to skip which is always an invalid (?) entry
 128         This' type can again only be 'string' (remember why?).
 129         //-->
 130         <raw-userid-column-key name="" type="string" value="userid" />
 131 </admin-entry-meta-data>