[FEATURE] Add support for native date/time fields
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_xml.php
index 84ed452..dc563d8 100644 (file)
  *
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
-/**
- * Contains class for creating XML output from records
- *
- * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
- *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- */
-
 
 /**
  * XML class, Used to create XML output from input rows.
  * Doesn't contain a lot of advanced features - pretty straight forward, practical stuff
- * You are encouraged to use this class in your own applications.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
- * @see user_xmlversion, user_wapversion
+ * @deprecated since TYPO3 6.0. It will be removed with TYPO3 6.2, please use other xml helper solutions instead.
  */
 class t3lib_xml {
-       var $topLevelName = 'typo3_test'; // Top element name
-       var $XML_recFields = array(); // Contains a list of fields for each table which should be presented in the XML output
+               // Top element name
+       public $topLevelName = 'typo3_test';
+               // Contains a list of fields for each table which should be presented in the XML output
+       public $XML_recFields = array();
 
-       var $XMLIndent = 0;
-       var $Icode = '';
-       var $XMLdebug = 0;
-       var $includeNonEmptyValues = 0; // if set, all fields from records are rendered no matter their content. If not set, only 'true' (that is '' or zero) fields make it to the document.
-       var $lines = array();
+       public $XMLIndent = 0;
+       public $Icode = '';
+       public $XMLdebug = 0;
+               // If set, all fields from records are rendered no matter their content. If not set, only 'true' (that is '' or zero) fields make it to the document.
+       public $includeNonEmptyValues = 0;
+       public $lines = array();
 
        /**
         * Constructor, setting topLevelName to the input var
         *
-        * @param       string          Top Level Name
-        * @return      void
+        * @param string $topLevelName Top Level Name
+        * @return void
         */
-       function __construct($topLevelName) {
+       public function __construct($topLevelName) {
+               t3lib_div::deprecationLog(
+                       'Class t3lib_div is deprecated since TYPO3 6.0. ' .
+                       'It will be removed with TYPO3 6.2, please use other xml helper solutions instead.'
+               );
                $this->topLevelName = $topLevelName;
        }
 
        /**
-        * Compatibility constructor.
-        *
-        * @param string Top Level Name
-        * @deprecated since TYPO3 4.6 and will be removed in TYPO3 4.8. Use __construct() instead.
-        */
-       public function t3lib_xml($topLevelName) {
-               t3lib_div::logDeprecatedFunction();
-                       // Note: we cannot call $this->__construct() here because it would call the derived class constructor and cause recursion
-                       // This code uses official PHP behavior (http://www.php.net/manual/en/language.oop5.basic.php) when $this in the
-                       // statically called non-static method inherits $this from the caller's scope.
-               t3lib_xml::__construct($topLevelName);
-       }
-
-       /**
         * When outputting a input record in XML only fields listed in $this->XML_recFields for the current table will be rendered.
         *
-        * @param       string          Table name
-        * @param       string          Commalist of fields names from the table, $table, which is supposed to be rendered in the XML output. If a field is not in this list, it is not rendered.
-        * @return      void
+        * @param string $table Table name
+        * @param string $list Commalist of fields names from the table, $table, which is supposed to be rendered in the XML output. If a field is not in this list, it is not rendered.
+        * @return void
         */
-       function setRecFields($table, $list) {
+       public function setRecFields($table, $list) {
                $this->XML_recFields[$table] = $list;
        }
 
        /**
         * Returns the result of the XML rendering, basically this is imploding the internal ->lines array with linebreaks.
         *
-        * @return      string
+        * @return string
         */
-       function getResult() {
+       public function getResult() {
                $content = implode(LF, $this->lines);
                return $this->output($content);
        }
@@ -101,9 +85,9 @@ class t3lib_xml {
        /**
         * Initialize WML (WAP) document with <?xml + <!DOCTYPE header tags and setting ->topLevelName as the first level.
         *
-        * @return      void
+        * @return void
         */
-       function WAPHeader() {
+       public function WAPHeader() {
                $this->lines[] = '<?xml version="1.0"?>';
                $this->lines[] = '<!DOCTYPE ' . $this->topLevelName . ' PUBLIC "-//WAPFORUM//DTD WML 1.1//EN" "http://www.wapforum.org/DTD/wml_1.1.xml">';
                $this->newLevel($this->topLevelName, 1);
@@ -113,9 +97,9 @@ class t3lib_xml {
         * Initialize "anonymous" XML document with <?xml + <!DOCTYPE header tags and setting ->topLevelName as the first level.
         * Encoding is set to UTF-8!
         *
-        * @return      void
+        * @return void
         */
-       function renderHeader() {
+       public function renderHeader() {
                $this->lines[] = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>';
                $this->lines[] = '<!DOCTYPE ' . $this->topLevelName . '>';
                $this->newLevel($this->topLevelName, 1);
@@ -124,21 +108,21 @@ class t3lib_xml {
        /**
         * Sets the footer (of ->topLevelName)
         *
-        * @return      void
+        * @return void
         */
-       function renderFooter() {
+       public function renderFooter() {
                $this->newLevel($this->topLevelName, 0);
        }
 
        /**
         * Indents/Outdents a new level named, $name
         *
-        * @param       string          The name of the new element for this level
-        * @param       boolean         If FALSE, then this function call will *end* the level, otherwise create it.
-        * @param       array           Array of attributes in key/value pairs which will be added to the element (tag), $name
-        * @return      void
+        * @param string $name The name of the new element for this level
+        * @param boolean $beginEndFlag If FALSE, then this function call will *end* the level, otherwise create it.
+        * @param array $params Array of attributes in key/value pairs which will be added to the element (tag), $name
+        * @return void
         */
-       function newLevel($name, $beginEndFlag = 0, $params = array()) {
+       public function newLevel($name, $beginEndFlag = 0, $params = array()) {
                if ($beginEndFlag) {
                        $pList = '';
                        if (count($params)) {
@@ -159,10 +143,10 @@ class t3lib_xml {
        /**
         * Function that will return the content from string $content. If the internal ->XMLdebug flag is set the content returned will be formatted in <pre>-tags
         *
-        * @param       string          The XML content to output
-        * @return      string          Output
+        * @param string The XML content to output
+        * @return string Output
         */
-       function output($content) {
+       public function output($content) {
                if ($this->XMLdebug) {
                        return '<pre>' . htmlspecialchars($content) . '</pre>
                        <hr /><font color="red">Size: ' . strlen($content) . '</font>';
@@ -173,12 +157,12 @@ class t3lib_xml {
 
        /**
         * Increments/Decrements Indentation counter, ->XMLIndent
-        * Sets and returns ->Icode variable which is a line prefix consisting of a number of tab-chars corresponding to the indent-levels of the current posision (->XMLindent)
+        * Sets and returns ->Icode variable which is a line prefix consisting of a number of tab-chars corresponding to the indent-levels of the current position (->XMLindent)
         *
-        * @param       boolean         If TRUE the XMLIndent var is increased, otherwise decreased
-        * @return      string          ->Icode - the prefix string with TAB-chars.
+        * @param boolean $b If TRUE the XMLIndent var is increased, otherwise decreased
+        * @return string ->Icode - the prefix string with TAB-chars.
         */
-       function indent($b) {
+       public function indent($b) {
                if ($b) {
                        $this->XMLIndent++;
                } else {
@@ -194,25 +178,26 @@ class t3lib_xml {
        /**
         * Takes a SQL result for $table and traverses it, adding rows
         *
-        * @param       string          Tablename
-        * @param       pointer         SQL resource pointer, should be reset
-        * @return      void
+        * @param string $table Tablename
+        * @param pointer $res SQL resource pointer, should be reset
+        * @return void
         */
-       function renderRecords($table, $res) {
+       public function renderRecords($table, $res) {
                while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
                        $this->addRecord($table, $row);
                }
+               $GLOBALS['TYPO3_DB']->sql_free_result($res);
        }
 
        /**
         * Adds record, $row, from table, $table, to the internal array of XML-lines
         *
-        * @param       string          Table name
-        * @param       array           The row to add to XML structure from the table name
-        * @return      void
+        * @param string $table Table name
+        * @param array $row The row to add to XML structure from the table name
+        * @return void
         */
-       function addRecord($table, $row) {
-               $this->lines[] = $this->Icode . '<' . $table . ' uid="' . $row["uid"] . '">';
+       public function addRecord($table, $row) {
+               $this->lines[] = $this->Icode . '<' . $table . ' uid="' . $row['uid'] . '">';
                $this->indent(1);
                $this->getRowInXML($table, $row);
                $this->indent(0);
@@ -224,12 +209,12 @@ class t3lib_xml {
         * Notice that only fields from $table that are listed in $this->XML_recFields[$table] (set by setRecFields()) will be rendered (and in the order found in that array!)
         * Content from the row will be htmlspecialchar()'ed, UTF-8 encoded and have LF (newlines) exchanged for '<newline/>' tags. The element name for a value equals the fieldname from the record.
         *
-        * @param       string          Table name
-        * @param       array           Row from table to add.
-        * @return      void
+        * @param string $table Table name
+        * @param array $row Row from table to add.
+        * @return void
         * @access private
         */
-       function getRowInXML($table, $row) {
+       public function getRowInXML($table, $row) {
                $fields = t3lib_div::trimExplode(',', $this->XML_recFields[$table], 1);
                foreach ($fields as $field) {
                        if ($row[$field] || $this->includeNonEmptyValues) {
@@ -241,40 +226,40 @@ class t3lib_xml {
        /**
         * UTF-8 encodes the input content (from ISO-8859-1!)
         *
-        * @param       string          String content to UTF-8 encode
-        * @return      string          Encoded content.
+        * @param string $content String content to UTF-8 encode
+        * @return string Encoded content.
         */
-       function utf8($content) {
+       public function utf8($content) {
                return utf8_encode($content);
        }
 
        /**
         * Substitutes LF characters with a '<newline/>' tag.
         *
-        * @param       string          Input value
-        * @return      string          Processed input value
+        * @param string $string Input value
+        * @return string Processed input value
         */
-       function substNewline($string) {
+       public function substNewline($string) {
                return str_replace(LF, '<newline/>', $string);
        }
 
        /**
         * Wraps the value in tags with element name, $field.
         *
-        * @param       string          Fieldname from a record - will be the element name
-        * @param       string          Value from the field - will be wrapped in the elements.
-        * @return      string          The wrapped string.
+        * @param string $field Fieldname from a record - will be the element name
+        * @param string $value Value from the field - will be wrapped in the elements.
+        * @return string The wrapped string.
         */
-       function fieldWrap($field, $value) {
+       public function fieldWrap($field, $value) {
                return '<' . $field . '>' . $value . '</' . $field . '>';
        }
 
        /**
         * Creates the BACK button for WAP documents
         *
-        * @return      void
+        * @return void
         */
-       function WAPback() {
+       public function WAPback() {
                $this->newLevel('template', 1);
                $this->newLevel('do', 1, array('type' => 'accept', 'label' => 'Back'));
                $this->addLine('<prev/>');
@@ -285,16 +270,12 @@ class t3lib_xml {
        /**
         * Add a line to the internal XML structure (automatically prefixed with ->Icode.
         *
-        * @param       string          Line to add to the $this->lines array
-        * @return      void
+        * @param string Line to add to the $this->lines array
+        * @return void
         */
-       function addLine($str) {
+       public function addLine($str) {
                $this->lines[] = $this->Icode . $str;
        }
 }
 
-
-if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_xml.php'])) {
-       include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_xml.php']);
-}
-?>
\ No newline at end of file
+?>