mailer project continued:
[mailer.git] / templates / xml / admin / admin_edit_show_surfbar_urls.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!--
3 This template provides meta data for editing URLs of the surfbar in the admin
4 area.
5
6 @author         Roland Haeder <webmaster@mxchange.org>
7 @version        0.2.1-FINAL
8 @copyright      (c) 2003 - 2009 by Roland Haeder
9 @copyright      (c) 2009 - 2012 by Mailer Developer Team
10 @license        GNU GPL 2.0 or any newer version
11 @link           http://mxchange.org
12
13 This program is free software; you can redistribute it and/or modify
14 it under the terms of the GNU General Public License as published by
15 the Free Software Foundation; either version 2 of the License, or
16 (at your option) any later version.
17
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 GNU General Public License for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
26 MA  02110-1301  USA
27 //-->
28 <admin-entry-meta-data>
29         <!--
30         Call-back function which should all following parameter handled over
31         to. This will always be type of string but we like homogene XMLs.
32         //-->
33         <callback-function type="string" value="adminEditEntriesConfirm" />
34         <!--
35         Name of the database table where the entries should be read/write from/to.
36         //-->
37         <database-table name="" type="string" value="surfbar_urls" />
38         <!--
39         The following three lists must have the same count of list entries, else an
40         error may occur.
41         //-->
42         <!--
43         And all column names to read/write, leave this list tag empty for all (*).
44         //-->
45         <database-column-list>
46                 <!--
47                 A column name list entry. The type is always string, or do you have
48                 numerical column names?
49                 //-->
50                 <database-column-list-entry name="" type="string" table="" value="url_id" alias="" function="" />
51                 <database-column-list-entry name="member_list" type="string" table="" value="url_userid" alias="" function="" />
52                 <database-column-list-entry name="" type="string" table="" value="url" alias="" function="" />
53         </database-column-list>
54         <!--
55         "Filter" call-back functions to call back for piping the fetched data
56         through (can be left empty, no call-back function will be called)
57         //-->
58         <callback-function-list>
59                 <!--
60                 A call-back function list entry
61                 //-->
62                 <callback-function-list-entry name="" type="string" value="bigintval" />
63                 <callback-function-list-entry name="member_list" type="string" value="addMemberSelectionBox" />
64         </callback-function-list>
65         <!--
66         Extra parameters (2nd, 3rd, ...) for above call-back functions. If an array
67         is provided, we have more than two parameters to handle over to the
68         call-back function. See function handleExtraValues() for details.
69         //-->
70         <extra-parameter-list>
71                 <!--
72                 A list entry for a single extra parameter. 'type' can now be: string,
73                 int, float, bool, array. If the type 'array' is provided, the parser
74                 searches for a tag called "extra-parameter-<value>-list(-entry)", by
75                 <value> is the value from the 'value' attribute. Please check out the
76                 examples below.
77                 //-->
78                 <!--
79                 Dummy entry
80                 //-->
81                 <extra-parameter-list-entry name="" type="string" value="" />
82                 <!--
83                 A one-dimensional array with some entries
84                 //-->
85                 <extra-parameter-list-entry name="" type="array" value="member">
86                         <!--
87                         Our 'member' array
88                         //-->
89                         <extra-parameter-member-list>
90                                 <!--
91                                 A bool entry in the 'bar' array, all other types are added in a
92                                 similar way.
93                                 //-->
94                                 <extra-parameter-member-list-entry name="" type="bool" value="false" />
95                                 <extra-parameter-member-list-entry name="" type="bool" value="true" />
96                                 <extra-parameter-member-list-entry name="" type="bool" value="true" />
97                                 <!--
98                                 The brackets [] are required for addMemberSelectionBox(),
99                                 please read there for details.
100                                 //-->
101                                 <extra-parameter-member-list-entry name="" type="string" value="url_userid[]" />
102                         </extra-parameter-member-list>
103                 </extra-parameter-list-entry>
104                 <!--
105                 Dummy entry
106                 //-->
107                 <extra-parameter-list-entry name="" type="string" value="" />
108         </extra-parameter-list>
109         <!--
110         Columns for converting single time selections into a timestamp
111         //-->
112         <time-columns-list>
113         </time-columns-list>
114         <!--
115         Wether to 'edit/delete/change' (change) the entries (true) or just read them for displaying (false)
116         //-->
117         <enable-modify-entries name="" type="bool" value="false" />
118         <!--
119         The table column which should be taken for the ids (see first parameter).
120         This' type can again only be 'string' (remember why?).
121         //-->
122         <table-id-column name="" type="string" value="url_id" />
123         <!--
124         The table column which should be taken for user ids
125         This' type can again only be 'string' (remember why?).
126         //-->
127         <table-userid-column name="" type="string" value="url_userid" />
128         <!--
129         Raw userid column ($key) to skip which is always an invalid (?) entry
130         This' type can again only be 'string' (remember why?).
131         //-->
132         <raw-userid-column-key name="" type="string" value="url_userid" />
133 </admin-entry-meta-data>