Updated copyright year.
[mailer.git] / templates / xml / admin / admin_list_grade_data.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!--
3 This template provides meta data for listing grades.
4
5 @author         Roland Haeder <webmaster@mxchange.org>
6 @version        0.2.1-FINAL
7 @copyright      (c) 2003 - 2009 by Roland Haeder
8 @copyright      (c) 2009 - 2016 by Mailer Developer Team
9 @license        GNU GPL 2.0 or any newer version
10 @link           http://mxchange.org
11
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.
16
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.
21
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,
25 MA  02110-1301  USA
26 //-->
27 <admin-list-data>
28         <!--
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.
32         //-->
33         <callback-function type="string" value="doGenericListEntries" />
34         <!--
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.
38         //-->
39         <list-template type="string" value="admin_list_grade_data" />
40         <!--
41         The template for all rows, mostly this name has a '_row' suffix and again,
42         no call-back function is usually required.
43         //-->
44         <list-row-template type="string" value="admin_list_grade_data_row" />
45         <!--
46         Message id to display if no entry could be found
47         //-->
48         <no-entry-found-message type="string" value="ADMIN_GRADE_DATA_404" />
49         <!--
50         The table(s) we shall grab the data from, all as list.
51         //-->
52         <data-tables>
53                 <!--
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.
56                 //-->
57                 <data-table type="string" alias="" value="grade_data" />
58                 <!--
59                 Columns to perform the SELECT statement on, with alias and name plus which table.
60                 //-->
61                 <select-data-from-list>
62                         <!--
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.
66                         //-->
67                         <select-data-from-list-entry type="string" table="" value="grade_id" alias="" function="" />
68                         <select-data-from-list-entry type="string" table="" value="grade_name" alias="" function="" />
69                         <select-data-from-list-entry type="string" table="" value="grade_description" alias="" function="" />
70                         <select-data-from-list-entry type="string" table="" value="grade_parent_id" alias="" function="" />
71                 </select-data-from-list>
72                 <!--
73                 And the column list to perform the WHERE statement on.
74                 //-->
75                 <where-select-from-list>
76                 </where-select-from-list>
77                 <!--
78                 Columns to perform the ORDER BY statement (GROUP BY is not yet supported)
79                 //-->
80                 <order-by-list>
81                         <!--
82                         A single entry to perform the ORDER BY statement on, see above WHERE entry for details.
83                         //-->
84                         <order-by-list-entry type="string" table="" order="grade_id" value="ASC" />
85                 </order-by-list>
86         </data-tables>
87         <!--
88         List all column names from the 'select-data-from-list' node here, but now
89         with call-back informations. The list must only contain those entries where
90         a call-back function shall be called for.
91         //-->
92         <column-callback-list>
93                 <!--
94                 Another column, now we need a second parameter here because
95                 generateDateTime() expects two parameters (first is always the data
96                 from column).
97                 //-->
98                 <column-callback-list-entry>
99                         <!--
100                         The actual data, again.
101                         //-->
102                         <column-callback-data type="string" value="grade_parent_id" callback="generateAdminGradeDataSelectionBox" />
103                         <!--
104                         More parameters, remember that the first parameter is always given
105                         and that it is the data from column.
106                         //-->
107                         <callback-extra-parameter-list>
108                                 <!--
109                                 A single parameter, 'type' can be one of 'float', 'int',
110                                 'bool', 'string'. 'array' is not yet supported.
111                                 //-->
112                                 <callback-extra-parameter-list-entry type="int" column="grade_parent_id" data="grade_id" />
113                                 <callback-extra-parameter-list-entry type="int" column="grade_parent_id" data="grade_parent_id" />
114                         </callback-extra-parameter-list>
115                 </column-callback-list-entry>
116         </column-callback-list>
117         <!--
118         How the named column shall be logical linked to the above.
119         //-->
120         <where-condition type="string" name="" condition="" />
121 </admin-list-data>