1 <?xml version="1.0" encoding="UTF-8" ?>
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
8 @author Roland Haeder <webmaster@mxchange.org>
10 @copyright (c) 2003 - 2009 by Roland Haeder
11 @copyright (c) 2009 - 2012 by Mailer Developer Team
12 @license GNU GPL 2.0 or any newer version
13 @link http://mxchange.org
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.
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.
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,
30 <admin-entry-meta-data>
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).
36 <callback-function type="string" value="adminFooEntriesBar" />
38 Name of the database table where the entries should be read/write from/to.
40 <database-table name="" type="string" value="table_name" />
42 And all column names to read/write, leave this list tag empty for all (*).
44 <database-column-list>
46 A column name list entry. The type is always string, or do you have
47 numerical column names?
49 <database-column-list-entry name="" type="string" table="" value="foo" alias="" function="" />
50 </database-column-list>
52 "Filter" call-back functions to call back for piping the fetched data
53 through (can be left empty, no call-back function will be called)
55 <callback-function-list>
57 A call-back function list entry
59 <callback-function-list-entry name="" type="string" value="someFooCallback" />
60 </callback-function-list>
62 Extra parameters (2nd, 3rd, ...) for above call-back functions. If an array
63 is provided, we have more than two parameters to handle over to the
64 call-back function. See function handleExtraValues() for details.
66 <extra-parameter-list>
68 A list entry for a single extra parameter. 'type' can now be: string,
69 int, float, bool, array. If the type 'array' is provided, the parser
70 searches for a tag called "extra-parameter-<value>-list(-entry)", by
71 <value> is the value from the 'value' attribute. Please check out the
72 examples below. In addition to that you need to maintain <value>_list
73 in all corresponding elements, see admin_edit_show_surfbar_urls.xml for
77 A simple string example with a numerical index, int and float are similar.
79 <extra-parameter-list-entry name="" type="string" value="foo" />
81 A simple bool example with a numerical index, value can only be 'false' or 'true'
83 <extra-parameter-list-entry name="" type="bool" value="false" />
85 A one-dimensional array with a numerical index and with some entries
87 <extra-parameter-list-entry name="" type="array" value="bar">
91 <extra-parameter-bar-list>
93 A bool entry with a numerical index in the 'bar' array, all
94 other types are added in a similar way.
96 <extra-parameter-bar-list-entry name="" type="bool" value="true" />
98 A float entry with a alpha-numerical index in the 'bar' array.
100 <extra-parameter-bar-list-entry name="my_key" type="float" value="1.2345" />
101 </extra-parameter-bar-list>
102 </extra-parameter-list-entry>
103 </extra-parameter-list>
105 Wether to 'edit/delete/change' (change) the entries (true) or just read them for displaying (false)
107 <enable-modify-entries name="" type="bool" value="false" />
109 The table column which should be taken for the ids (see first parameter).
110 This' type can again only be 'string' (remember why?).
112 <table-id-column name="" type="string" value="id" />
114 The table column which should be taken for user ids
115 This' type can again only be 'string' (remember why?).
117 <table-userid-column name="" type="string" value="userid" />
119 Raw userid column ($key) to skip which is always an invalid (?) entry
120 This' type can again only be 'string' (remember why?).
122 <raw-userid-column-key name="" type="string" value="userid" />
126 <cache-file name="" type="string" value="some_foo" />
127 </admin-entry-meta-data>