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 - 2011 by Mailer Developer Team
  10 @license        GNU GPL 2.0 or any newer version
  11 @link           http://www.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         <admin-callback-function type="string" value="adminEditEntriesConfirm" />
  34         <!--
  35         Array index from HTTP POST data array for identifying every data row
  36         //-->
  37         <post-data-identify-index name="" type="string" value="url_id" />
  38         <!--
  39         Name of the database table where the entries should be read/write from/to.
  40         //-->
  41         <database-table name="" type="string" value="surfbar_urls" />
  42         <!--
  43         The following three lists must have the same count of list entries, else an
  44         error may occur.
  45         //-->
  46         <!--
  47         And all column names to read/write, leave this list tag empty for all (*).
  48         //-->
  49         <database-column-list>
  50                 <!--
  51                 A column name list entry. The type is always string, or do you have
  52                 numerical column names?
  53                 //-->
  54                 <database-column-list-entry name="" type="string" value="url_id" />
  55                 <database-column-list-entry name="member_list" type="string" value="url_userid" />
  56                 <database-column-list-entry name="" type="string" value="url" />
  57         </database-column-list>
  58         <!--
  59         "Filter" call-back functions to call back for piping the fetched data
  60         through (can be left empty, no call-back function will be called)
  61         //-->
  62         <callback-function-list>
  63                 <!--
  64                 A call-back function list entry
  65                 //-->
  66                 <callback-function-list-entry name="" type="string" value="bigintval" />
  67                 <callback-function-list-entry name="member_list" type="string" value="addMemberSelectionBox" />
  68                 <callback-function-list-entry name="" type="string" value="" /> <!-- No callback function! //-->
  69         </callback-function-list>
  70         <!--
  71         Extra parameters (2nd, 3rd, ...) for above call-back functions. If an array
  72         is provided, we have more than two parameters to handle over to the
  73         call-back function. See function handleExtraValues() for details.
  74         //-->
  75         <extra-parameter-list>
  76                 <!--
  77                 A list entry for a single extra parameter. 'type' can now be: string,
  78                 int, float, bool, array. If the type 'array' is provided, the parser searches
  79                 for a tag called "extra-parameter-<value>-list(-entry)", by <value>
  80                 is the value from the 'value' attribute. Please check out the examples below.
  81                 //-->
  82                 <!--
  83                 Dummy entry
  84                 //-->
  85                 <extra-parameter-list-entry name="" type="string" value="" />
  86                 <!--
  87                 A one-dimensional array with some entries
  88                 //-->
  89                 <extra-parameter-list-entry name="" type="array" value="member">
  90                         <!--
  91                         Our 'member' array
  92                         //-->
  93                         <extra-parameter-member-list>
  94                                 <!--
  95                                 A bool entry in the 'bar' array, all other types are added in a
  96                                 similar way.
  97                                 //-->
  98                                 <extra-parameter-member-list-entry name="" type="bool" value="false" />
  99                                 <extra-parameter-member-list-entry name="" type="bool" value="true" />
 100                                 <extra-parameter-member-list-entry name="" type="bool" value="true" />
 101                                 <!--
 102                                 The brackets [] are required for addMemberSelectionBox(),
 103                                 please read there for details.
 104                                 //-->
 105                                 <extra-parameter-member-list-entry name="" type="string" value="url_userid[]" />
 106                         </extra-parameter-member-list>
 107                 </extra-parameter-list-entry>
 108                 <!--
 109                 Dummy entry
 110                 //-->
 111                 <extra-parameter-list-entry name="" type="string" value="" />
 112         </extra-parameter-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="url_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="url_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="url_userid" />
 132 </admin-entry-meta-data>