98ee721d7c54d443b8ded15f74ae05bd4f6fb242
[Packages/TYPO3.CMS.git] / typo3 / sysext / cms / tslib / media / scripts / xmlversionLib.inc
1 <?php
2 /***************************************************************
3 *  Copyright notice
4 *
5 *  (c) 1999-2009 Kasper Skårhøj (kasperYYYY@typo3.com)
6 *  All rights reserved
7 *
8 *  This script is part of the TYPO3 project. The TYPO3 project is
9 *  free software; you can redistribute it and/or modify
10 *  it under the terms of the GNU General Public License as published by
11 *  the Free Software Foundation; either version 2 of the License, or
12 *  (at your option) any later version.
13 *
14 *  The GNU General Public License can be found at
15 *  http://www.gnu.org/copyleft/gpl.html.
16 *  A copy is found in the textfile GPL.txt and important notices to the license
17 *  from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 *  This script is distributed in the hope that it will be useful,
21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23 *  GNU General Public License for more details.
24 *
25 *  This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29  * Example class showing how one could make XML export of page content elements in TYPO3
30  *
31  * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
32  *
33  * @author Kasper Skårhøj <kasperYYYY@typo3.com>
34  */
35
36 /**
37  * Class that creates the current page and content element records as an XML structure using the library "t3lib_xml"
38  * It is demonstrated in use in the testsite package on page "59"
39  * The static template "plugin.alt.xml" is used to trigger this XML creation as well. That template contains this set of TypoScript lines which triggers the XML creation and disables all regular HTML headers
40  *
41  * ## Set up page/type number:
42  * alt_xml >
43  * alt_xml = PAGE
44  * alt_xml {
45  *   typeNum=96
46  *   config.disableAllHeaderCode = 1
47  *   config.additionalHeaders = Content-type: text/xml
48  *
49  *   ## Includes the newsLib:
50  *   includeLibs.alt_xml = media/scripts/xmlversionLib.inc
51  *
52  *   ## Inserting the USER cObject for XML rendering
53  *   10 = USER
54  *   10 {
55  *     userFunc = user_xmlversion->main_xmlversion
56  *   }
57  * }
58  *
59  * @package TYPO3
60  * @subpackage tslib
61  * @author Kasper Skårhøj <kasperYYYY@typo3.com>
62  */
63 class user_xmlversion {
64                 // The backReference to the mother cObj object set at call time
65         var $cObj;
66
67
68         /**
69          * Main function, called from TypoScript
70          *
71          * @param string $content Empty, ignore.
72          * @param array $conf TypoScript properties for this content object/function call
73          * @return string XML content
74          */
75         function main_xmlversion($content, $conf) {
76                 $xmlObj = t3lib_div::makeInstance('t3lib_xml', 'typo3_page');
77                 $xmlObj->XMLdebug = 0;
78                 $xmlObj->setRecFields('pages', 'doktype,title,alias,hidden,starttime,endtime,fe_group,url,target,no_cache,shortcut,keywords,description,abstract,author,author_email,newUntil,lastUpdated,cache_timeout');
79                 $xmlObj->setRecFields('tt_content', 'CType,header,header_link,bodytext,image,imagewidth,imageorient,media,records,colPos,starttime,endtime,fe_group');
80
81                         // Creating top level object
82                 $xmlObj->renderHeader();
83
84                         // Add page information
85                 $xmlObj->addRecord('pages', $GLOBALS['TSFE']->page);
86
87                         // Add page content information
88                 $xmlObj->newLevel('content_records', 1);
89                 $xmlObj->renderRecords('pages', $this->getContentResult('pages'));
90                 $xmlObj->renderRecords('tt_content', $this->getContentResult('tt_content'));
91                 $xmlObj->newLevel('content_records');
92
93                 $xmlObj->renderFooter();
94
95                 return $xmlObj->getResult();
96         }
97
98         /**
99          * Selects all records from $table having the current page id as PID (records belonging to that page)
100          *
101          * @param string $table A tablename found in $GLOBALS['TCA']
102          * @return pointer A database resource pointer
103          */
104         function getContentResult($table) {
105                 if ($GLOBALS['TCA'][$table]) {
106                         $orderBy = ($GLOBALS['TCA'][$table]['ctrl']['sortby']
107                                 ? 'ORDER BY '.$GLOBALS['TCA'][$table]['ctrl']['sortby']
108                                 : $GLOBALS['TCA'][$table]['ctrl']['default_sortby']);
109                         $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $table, 'pid='.intval($GLOBALS['TSFE']->id).$this->cObj->enableFields($table), '', $GLOBALS['TYPO3_DB']->stripOrderBy($orderBy));
110                         return $res;
111                 }
112         }
113 }
114
115 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['media/scripts/xmlversionLib.inc'])) {
116         include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['media/scripts/xmlversionLib.inc']);
117 }
118 ?>