]> git.mxchange.org Git - mailer.git/blobdiff - templates/xml/admin/admin_list_network_query_api_config.xml
Mailer project rwritten:
[mailer.git] / templates / xml / admin / admin_list_network_query_api_config.xml
diff --git a/templates/xml/admin/admin_list_network_query_api_config.xml b/templates/xml/admin/admin_list_network_query_api_config.xml
new file mode 100644 (file)
index 0000000..9305c8d
--- /dev/null
@@ -0,0 +1,146 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+This template is for showing all configured networks with at least one type
+handler set up.
+
+@author                Roland Haeder <webmaster@mxchange.org>
+@version       0.2.1-FINAL
+@copyright     (c) 2003 - 2009 by Roland Haeder
+@copyright     (c) 2009 - 2012 by Mailer Developer Team
+@license       GNU GPL 2.0 or any newer version
+@link          http://mxchange.org
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
+MA 02110-1301 USA
+//-->
+<admin-list-data>
+       <!--
+       Call-back function, the extracted data from this XML will then be re-read
+       from that function. The most common function this XML uses is
+       doGenericListEntries() so mostly you can leave this alone unless you have JOINs.
+       Use doGenericJoinedListEntries for JOINs:
+       //-->
+       <callback-function type="string" value="doGenericJoinedListEntries" />
+       <!--
+       Now we need information which template should be loaded and which functions
+       shall be called back. So lets start with the main list template. This mostly
+       requires no call-back function.
+       //-->
+       <list-template type="string" value="admin_list_network_query_api" />
+       <!--
+       The template for all rows, mostly this name has a '_row' suffix and again,
+       no call-back function is usually required.
+       //-->
+       <list-row-template type="string" value="admin_list_network_query_api_row" />
+       <!--
+       Message id to display if no entry could be found
+       //-->
+       <no-entry-found-message type="string" value="ADMIN_NETWORK_QUERY_API_404" />
+       <!--
+       The table(s) we shall grab the data from, all as list.
+       //-->
+       <data-tables>
+               <!--
+               A single table entry, with alias and without the configurable
+               _MYSQL_PREFIX. You can specify the table's name or alias later on.
+               //-->
+               <data-table type="string" alias="nac" value="network_api_config" />
+               <!--
+               A join condition to merge data from two or more tables, leave out
+               if you want to do simple SELECTs.
+               //-->
+               <table-join-condition>
+                       <!--
+                       The joining type, can be any valid SQL statement. Here it is an
+                       INNER JOIN (from both tables the data must exist).
+                       //-->
+                       <table-join-type type="INNER JOIN" />
+                       <!--
+                       Name (and alias) of the table we want to join
+                       //-->
+                       <table-join-name name="network_handler_config" alias="ntc" />
+                       <!--
+                       On which condition these tables should join
+                       //-->
+                       <join-on>
+                               <!--
+                               The left table, name can also be an alias, column is the column
+                               of the left table.
+                               //-->
+                               <join-on-left-table type="string" name="nac" column="network_id" />
+                               <!--
+                               Condition how these two tables should be joined.
+                               //-->
+                               <join-on-condition type="string" condition="EQUALS" />
+                               <!--
+                               And the corresponding right part.
+                               //-->
+                               <join-on-right-table type="string" name="ntc" column="network_id" />
+                       </join-on>
+               </table-join-condition>
+               <!--
+               Columns to perform the SELECT statement on, with alias and name plus which table.
+               //-->
+               <select-data-from-list>
+                       <!--
+                       A single entry with table name (can be left empty), value (must
+                       always be set), alias (again can be left empty) and SQL function
+                       (can also be left empty) which shall be applied on the column.
+                       //-->
+                       <select-data-from-list-entry type="string" table="nac" value="network_id" alias="" function="" />
+                       <select-data-from-list-entry type="string" table="ntc" value="network_type_id" alias="" function="" />
+               </select-data-from-list>
+               <!--
+               And the column list to perform the WHERE statement on.
+               //-->
+               <where-select-from-list>
+                       <!--
+                       A single entry to perform the WHERE statement on:
+                       - table     = table name (or alias)
+                       - value     = column name
+                       - condition = look-up condition
+                       - look-for  = What to look for
+                       //-->
+                       <where-select-from-list-entry type="string" table="nac" value="network_id" condition="EQUALS" look-for="$content[network_id]" />
+               </where-select-from-list>
+               <!--
+               Columns to perform the ORDER BY statement (GROUP BY is not yet supported)
+               //-->
+               <order-by-list>
+                       <!--
+                       A single entry to perform the ORDER BY statement on, see above WHERE entry for details.
+                       //-->
+                       <order-by-list-entry type="string" table="nac" order="network_id" value="ASC" />
+               </order-by-list>
+       </data-tables>
+       <!--
+       List all column names from the 'select-data-from-list' node here, but now
+       with call-back informations. The list must only contain those entries where
+       a call-back function shall be called for.
+       //-->
+       <column-callback-list>
+       </column-callback-list>
+       <!--
+       Extra parameters (2nd, 3rd, ...) for above call-back functions. If an array
+       is provided, we have more than two parameters to handle over to the
+       call-back function. See function handleExtraValues() for details.
+       //-->
+       <extra-parameter-list>
+       </extra-parameter-list>
+       <!--
+       How the named column shall be logical linked to the above.
+       //-->
+       <where-condition type="string" name="" condition="" />
+</admin-list-data>