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         //-->
  35         <admin-callback-function type="string" value="adminFooEntriesBar" />
  36         <!--
  37         Array index from HTTP POST data array for identifying every data row
  38         //-->
  39         <post-data-identify-index type="string" value="id" />
  40         <!--
  41         Name of the database table where the entries should be read/write from/to.
  42         //-->
  43         <database-table type="string" value="table_name" />
  44         <!--
  45         The following three lists must have the same count of list entries, else an
  46         error may occur.
  47         //-->
  48         <!--
  49         And all column names to read/write, leave this list tag empty for all (*).
  50         //-->
  51         <database-column-list>
  52                 <!--
  53                 A column name list entry. The type is always string, or do you have
  54                 numerical column names?
  55                 //-->
  56                 <database-column-list-entry type="string" value="foo" />
  57         </database-column-list>
  58         <!--
  59         "Filter" call-back functions to call back for piping the fetched data
  60         through (can be left empty, no call-back function will be called)
  61         //-->
  62         <callback-function-list>
  63                 <!--
  64                 A call-back function list entry
  65                 //-->
  66                 <callback-function-list-entry type="string" value="someFooCallback" />
  67         </callback-function-list>
  68         <!--
  69         Extra parameters (2nd, 3rd, ...) for above call-back functions. If an array
  70         is provided, we have more than two parameters to handle over to the
  71         call-back function. See function handleExtraValues() for details.
  72         //-->
  73         <extra-parameter-list>
  74                 <!--
  75                 A list entry for a single extra parameter. 'type' can now be: string,
  76                 int, float, bool, array. If the type 'array' is provided, the parser
  77                 searches for a tag called "extra-parameter-<value>-list(-entry)", by
  78                 <value> is the value from the 'value' attribute. Please check out the
  79                 examples below.
  80                 Keep 'name' empty for numerical array indexes (array keys).
  81                 //-->
  82                 <!--
  83                 A simple string example with a numerical index, int and float are similar.
  84                 //-->
  85                 <extra-parameter-list-entry name="" type="string" value="foo" />
  86                 <!--
  87                 A simple bool example with a numerical index, value can only be 'false' or 'true'
  88                 //-->
  89                 <extra-parameter-list-entry name="" type="bool" value="false" />
  90                 <!--
  91                 A one-dimensional array with a numerical index and with some entries
  92                 //-->
  93                 <extra-parameter-list-entry name="" type="array" value="bar">
  94                         <!--
  95                         Our 'bar' array
  96                         //-->
  97                         <extra-parameter-bar-list>
  98                                 <!--
  99                                 A bool entry with a numerical index in the 'bar' array, all
 100                                 other types are added in a similar way.
 101                                 //-->
 102                                 <extra-parameter-bar-list-entry name="" type="bool" value="true" />
 103                                 <!--
 104                                 A float entry with a alpha-numerical index in the 'bar' array.
 105                                 //-->
 106                                 <extra-parameter-bar-list-entry name="my_key" type="float" value="1.2345" />
 107                         </extra-parameter-bar-list>
 108                 </extra-parameter-list-entry>
 109         </extra-parameter-list>
 110         <!--
 111         Wether to 'edit/delete/change' (change) the entries (true) or just read them for displaying (false)
 112         //-->
 113         <enable-modify-entries type="bool" value="false" />
 114         <!--
 115         The table column which should be taken for the ids (see first parameter).
 116         This' type can again only be 'string' (remember why?).
 117         //-->
 118         <table-id-column type="string" value="id" />
 119         <!--
 120         The table column which should be taken for user ids
 121         This' type can again only be 'string' (remember why?).
 122         //-->
 123         <table-userid-column type="string" value="userid" />
 124         <!--
 125         Raw userid column ($key) to skip which is always an invalid (?) entry
 126         This' type can again only be 'string' (remember why?).
 127         //-->
 128         <raw-userid-column-key type="string" value="userid" />
 129 </admin-entry-meta-data>