Extension ext-user (sub-id tracking) continued:
[mailer.git] / templates / xml / admin / admin_edit_show_user_subid.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!--
3 This template provides meta data for editing user's sub ids.
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 - 2012 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-entry-meta-data>
28         <!--
29         Call-back function which should all following parameter handled over
30         to. This will always be type of string but we like homogene XMLs.
31         //-->
32         <callback-function type="string" value="adminEditEntriesConfirm" />
33         <!--
34         Name of the database table where the entries should be read/write from/to.
35         //-->
36         <database-table name="" type="string" value="user_subids" />
37         <!--
38         The following three lists must have the same count of list entries, else an
39         error may occur.
40         //-->
41         <!--
42         And all column names to read/write, leave this list tag empty for all (*).
43         //-->
44         <database-column-list>
45                 <!--
46                 A column name list entry. The type is always string, or do you have
47                 numerical column names?
48                 //-->
49                 <database-column-list-entry name="" type="string" table="" value="id" alias="" function="" />
50                 <database-column-list-entry name="added_list" type="string" table="" value="subid_added" alias="subid_added" function="UNIX_TIMESTAMP" />
51                 <database-column-list-entry name="" type="string" table="" value="subid" alias="" function="" />
52         </database-column-list>
53         <!--
54         "Filter" call-back functions to call back for piping the fetched data
55         through (can be left empty, no call-back function will be called)
56         //-->
57         <callback-function-list>
58                 <!--
59                 A call-back function list entry
60                 //-->
61                 <callback-function-list-entry name="" type="string" value="bigintval" />
62                 <callback-function-list-entry name="added_list" type="string" value="generateDateTime" />
63         </callback-function-list>
64         <!--
65         Extra parameters (2nd, 3rd, ...) for above call-back functions. If an array
66         is provided, we have more than two parameters to handle over to the
67         call-back function. See function handleExtraValues() for details.
68         //-->
69         <extra-parameter-list>
70                 <!--
71                 A one-dimensional array with some entries
72                 //-->
73                 <extra-parameter-list-entry name="" type="array" value="member">
74                         <!--
75                         Our 'member' array
76                         //-->
77                         <extra-parameter-member-list>
78                                 <!--
79                                 A bool entry in the 'member' array, all other types are added in a
80                                 similar way.
81                                 //-->
82                                 <extra-parameter-member-list-entry name="" type="bool" value="false" />
83                                 <extra-parameter-member-list-entry name="" type="bool" value="true" />
84                                 <extra-parameter-member-list-entry name="" type="bool" value="true" />
85                                 <!--
86                                 The brackets [] are required for addMemberSelectionBox(),
87                                 please read there for details.
88                                 //-->
89                                 <extra-parameter-member-list-entry name="" type="string" value="userid[]" />
90                         </extra-parameter-member-list>
91                 </extra-parameter-list-entry>
92                 <!--
93                 A one-dimensional array with some entries
94                 //-->
95                 <extra-parameter-list-entry name="" type="array" value="added">
96                         <!--
97                         Our 'added' array
98                         //-->
99                         <extra-parameter-added-list>
100                                 <!--
101                                 A bool entry in the 'added' array, all other types are added in a
102                                 similar way.
103                                 //-->
104                                 <extra-parameter-added-list-entry name="" type="int" value="2" />
105                         </extra-parameter-added-list>
106                 </extra-parameter-list-entry>
107         </extra-parameter-list>
108         <!--
109         Columns for converting single time selections into a timestamp
110         //-->
111         <time-columns-list>
112         </time-columns-list>
113         <!--
114         Wether to 'edit/delete/change' (change) the entries (true) or just read them for displaying (false)
115         //-->
116         <enable-modify-entries name="" type="bool" value="false" />
117         <!--
118         The table column which should be taken for the ids (see first parameter).
119         This' type can again only be 'string' (remember why?).
120         //-->
121         <table-id-column name="" type="string" value="id" />
122         <!--
123         The table column which should be taken for user ids
124         This' type can again only be 'string' (remember why?).
125         //-->
126         <table-userid-column name="" type="string" value="userid" />
127         <!--
128         Raw userid column ($key) to skip which is always an invalid (?) entry
129         This' type can again only be 'string' (remember why?).
130         //-->
131         <raw-userid-column-key name="" type="string" value="userid" />
132 </admin-entry-meta-data>