1 <?xml version="1.0" encoding="UTF-8" ?>
3 This template provides meta data for listing nickname-change history entries.
5 @author Roland Haeder <webmaster@mxchange.org>
7 @copyright (c) 2003 - 2009 by Roland Haeder
8 @copyright (c) 2009 - 2011 by Mailer Developer Team
9 @license GNU GPL 2.0 or any newer version
10 @link http://mxchange.org
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
29 Call-back function, the extracted data from this XML will then be re-read
30 from that function. The most common function this XML uses is
31 doGenericListEntries() so mostly you can leave this alone unless you have JOINs.
33 <callback-function type="string" value="doGenericListEntries" />
35 Now we need information which template should be loaded and which functions
36 shall be called back. So lets start with the main list template. This mostly
37 requires no call-back function.
39 <list-template type="string" value="admin_list_nickname_history" />
41 The template for all rows, mostly this name has a '_row' suffix and again,
42 no call-back function is usually required.
44 <list-row-template type="string" value="admin_list_nickname_history_row" />
46 Message id to display if no entry could be found
48 <no-entry-found-message type="string" value="ADMIN_LIST_NICKNAME_HISTORY_404" />
50 The table(s) we shall grab the data from, all as list.
54 A single table entry, with alias and without the configurable
55 _MYSQL_PREFIX. You can specify the table's name or alias later on.
57 <data-table type="string" alias="" value="history" />
59 Columns to perform the SELECT statement on, with alias and name plus which table.
61 <select-data-from-list>
63 A single entry with table name (can be left empty), value (must
64 always be set), alias (again can be left empty) and SQL function
65 (can also be left empty) which shall be applied on the column.
67 <select-data-from-list-entry type="string" table="" value="history_userid" alias="" function="" />
68 <select-data-from-list-entry type="string" table="" value="history_value" alias="" function="" />
69 <select-data-from-list-entry type="string" table="" value="history_added" alias="history_added" function="UNIX_TIMESTAMP" />
70 <select-data-from-list-entry type="string" table="" value="history_last_used" alias="history_last_used" function="UNIX_TIMESTAMP" />
71 </select-data-from-list>
73 And the column list to perform the WHERE statement on.
75 <where-select-from-list>
77 A single entry to perform the WHERE statement on:
78 - table = table name (or alias)
80 - condition = look-up condition
81 - look-for = What to look for
83 <where-select-from-list-entry type="string" table="" value="history_subject" condition="EQUALS" look-for="NICKNAME_CHANGED" />
85 A single entry to perform the AND statement on:
86 - table = table name (or alias)
88 - condition = look-up condition
89 - look-for = What to look for
91 <where-select-from-list-entry type="string" table="" value="history_userid" condition="EQUALS" look-for="$content[userid]" />
92 </where-select-from-list>
94 Columns to perform the ORDER BY statement (GROUP BY is not yet supported)
98 A single entry to perform the ORDER BY statement on, see above WHERE entry for details.
100 <order-by-list-entry type="string" table="" order="history_added" value="DESC" />
104 List all column names from the 'select-data-from-list' node here, but now
105 with call-back informations. The list must only contain those entries where
106 a call-back function shall be called for.
108 <column-callback-list>
110 Another column, now we need a second parameter here because
111 generateDateTime() expects two parameters (first is always the data
114 <column-callback-list-entry>
116 The actual data, again.
118 <column-callback-data type="string" value="history_added" callback="generateDateTime" />
120 More parameters, remember that the first parameter is always given
121 and that it is the data from column.
123 <callback-extra-parameter-list>
125 A single parameter, 'type' can be one of 'float', 'int',
126 'bool', 'string'. 'array' is not yet supported.
128 <callback-extra-parameter-list-entry type="int" column="history_added" value="2" />
129 </callback-extra-parameter-list>
130 </column-callback-list-entry>
132 Another column, now we need a second parameter here because
133 generateDateTime() expects two parameters (first is always the data
136 <column-callback-list-entry>
138 The actual data, again.
140 <column-callback-data type="string" value="history_last_used" callback="generateDateTime" />
142 More parameters, remember that the first parameter is always given
143 and that it is the data from column.
145 <callback-extra-parameter-list>
147 A single parameter, 'type' can be one of 'float', 'int',
148 'bool', 'string'. 'array' is not yet supported.
150 <callback-extra-parameter-list-entry type="int" column="history_last_used" value="2" />
151 </callback-extra-parameter-list>
152 </column-callback-list-entry>
153 </column-callback-list>
155 How the named column shall be logical linked to the above.
157 <where-condition type="string" name="history_userid" condition="AND" />