t3lib_xml Class Reference

List of all members.

Public Member Functions
	t3lib_xml ($topLevelName)
	Constructor, setting topLevelName to the input var.
	setRecFields ($table, $list)
	When outputting a input record in XML only fields listed in $this->XML_recFields for the current table will be rendered.
	getResult ()
	Returns the result of the XML rendering, basically this is imploding the internal ->lines array with linebreaks.
	WAPHeader ()
	Initialize WML (WAP) document with <?xml + <!DOCTYPE header tags and setting ->topLevelName as the first level.
	renderHeader ()
	Initialize "anonymous" XML document with <?xml + <!DOCTYPE header tags and setting ->topLevelName as the first level.
	renderFooter ()
	Sets the footer (of ->topLevelName).
	newLevel ($name, $beginEndFlag=0, $params=array())
	Indents/Outdents a new level named, $name.
	indent ($b)
	Function that will return the content from string $content.
	renderRecords ($table, $res)
	Takes a SQL result for $table and traverses it, adding rows.
	addRecord ($table, $row)
	Adds record, $row, from table, $table, to the internal array of XML-lines.
	getRowInXML ($table, $row)
	Internal function for adding the actual content of the $row from $table to the internal structure.
	utf8 ($content)
	UTF-8 encodes the input content (from ISO-8859-1!).
	substNewline ($string)
	Substitutes chr(10) characters with a '<newline/>' tag.
	fieldWrap ($field, $value)
	Wraps the value in tags with element name, $field.
	WAPback ()
	Creates the BACK button for WAP documents.
	addLine ($str)
	Add a line to the internal XML structure (automatically prefixed with ->Icode.
Public Attributes
	$topLevelName = 'typo3_test'
	$XML_recFields = array()
	$XMLIndent = 0
	$Icode = ''
	$XMLdebug = 0
	$includeNonEmptyValues = 0
	$lines = array()

---

Constructor & Destructor Documentation

t3lib_xml::t3lib_xml (  $  topLevelName  )

Constructor, setting topLevelName to the input var. Parameters: string  Top Level Name Returns: void Definition at line 102 of file class.t3lib_xml.php. { $this->topLevelName = $topLevelName; }

---

Member Function Documentation

t3lib_xml::addLine (  $  str  )

Add a line to the internal XML structure (automatically prefixed with ->Icode. Parameters: string  Line to add to the $this->lines array Returns: void Definition at line 315 of file class.t3lib_xml.php. Referenced by WAPback(). { $this->lines[]=$this->Icode.$str; }

t3lib_xml::addRecord (  $  table, $  row )

Adds record, $row, from table, $table, to the internal array of XML-lines. Parameters: string  Table name array  The row to add to XML structure from the table name Returns: void Definition at line 237 of file class.t3lib_xml.php. References getRowInXML(), indent(), and table(). Referenced by renderRecords(). { $this->lines[]=$this->Icode.'<'.$table.' uid="'.$row["uid"].'">'; $this->indent(1); $this->getRowInXML($table,$row); $this->indent(0); $this->lines[]=$this->Icode.'</'.$table.'>'; }

t3lib_xml::fieldWrap (  $  field, $  value )

Wraps the value in tags with element name, $field. Parameters: string  Fieldname from a record - will be the element name string  Value from the field - will be wrapped in the elements. Returns: string The wrapped string. Definition at line 292 of file class.t3lib_xml.php. { return '<'.$field.'>'.$value.'</'.$field.'>'; }

t3lib_xml::getResult (   )

Returns the result of the XML rendering, basically this is imploding the internal ->lines array with linebreaks. Returns: string Definition at line 122 of file class.t3lib_xml.php. References $content. { $content = implode(chr(10),$this->lines); return $this->output($content); }

t3lib_xml::getRowInXML (  $  table, $  row )

Internal function for adding the actual content of the $row from $table to the internal structure. 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 chr(10) (newlines) exchanged for '<newline/>' tags. The element name for a value equals the fieldname from the record. Parameters: string  Table name array  Row from table to add. Returns: void private Definition at line 255 of file class.t3lib_xml.php. References table(). Referenced by addRecord(). { $fields = t3lib_div::trimExplode(',',$this->XML_recFields[$table],1); reset($fields); while(list(,$field)=each($fields)) { if ($row[$field] || $this->includeNonEmptyValues) { $this->lines[]=$this->Icode.$this->fieldWrap($field,$this->substNewline($this->utf8(htmlspecialchars($row[$field])))); } } }

t3lib_xml::indent (  $  b  )

Function that will return the content from string $content. If the internal ->XMLdebug flag is set the content returned will be formatted in -tags Parameters: string  The XML content to output Returns: string Output */ function output($content) { if ($this->XMLdebug) { return ' '.htmlspecialchars($content).' <hr /><font color="red">Size: '.strlen($content).'</font>'; } else { return $content; } } /** 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) Parameters: boolean  If true the XMLIndent var is increased, otherwise decreased Returns: string ->Icode - the prefix string with TAB-chars. Definition at line 208 of file class.t3lib_xml.php. References $a. Referenced by addRecord(), and newLevel(). { if ($b) $this->XMLIndent++; else $this->XMLIndent--; $this->Icode=''; for ($a=0;$a<$this->XMLIndent;$a++) { $this->Icode.=chr(9); } return $this->Icode; }

t3lib_xml::newLevel (  $  name, $  beginEndFlag = 0, $  params = array() )

Indents/Outdents a new level named, $name. Parameters: string  The name of the new element for this level boolean  If false, then this function call will *end* the level, otherwise create it. array  Array of attributes in key/value pairs which will be added to the element (tag), $name Returns: void Definition at line 167 of file class.t3lib_xml.php. References $key, and indent(). Referenced by renderFooter(), renderHeader(), WAPback(), and WAPHeader(). { if ($beginEndFlag) { $pList=''; if (count($params)) { $par=array(); reset($params); while(list($key,$val)=each($params)) { $par[]=$key.'="'.htmlspecialchars($val).'"'; } $pList=' '.implode(' ',$par); } $this->lines[]=$this->Icode.'<'.$name.$pList.'>'; $this->indent(1); } else { $this->indent(0); $this->lines[]=$this->Icode.'</'.$name.'>'; } }

t3lib_xml::renderFooter (   )

Sets the footer (of ->topLevelName). Returns: void Definition at line 155 of file class.t3lib_xml.php. References newLevel(). { $this->newLevel($this->topLevelName,0); }

t3lib_xml::renderHeader (   )

Initialize "anonymous" XML document with <?xml + <!DOCTYPE header tags and setting ->topLevelName as the first level. Encoding is set to UTF-8! Returns: void Definition at line 144 of file class.t3lib_xml.php. References newLevel(). { $this->lines[]='<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'; $this->lines[]='<!DOCTYPE '.$this->topLevelName.'>'; $this->newLevel($this->topLevelName,1); }

t3lib_xml::renderRecords (  $  table, $  res )

Takes a SQL result for $table and traverses it, adding rows. Parameters: string  Tablename pointer  SQL resource pointer, should be reset Returns: void Definition at line 224 of file class.t3lib_xml.php. References addRecord(), and table(). { while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { $this->addRecord($table,$row); } }

t3lib_xml::setRecFields (  $  table, $  list )

When outputting a input record in XML only fields listed in $this->XML_recFields for the current table will be rendered. Parameters: string  Table name 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. Returns: void Definition at line 113 of file class.t3lib_xml.php. { $this->XML_recFields[$table]=$list; }

t3lib_xml::substNewline (  $  string  )

Substitutes chr(10) characters with a '<newline/>' tag. Parameters: string  Input value Returns: string Processed input value Definition at line 281 of file class.t3lib_xml.php. { return ereg_replace(chr(10),'<newline/>',$string); }

t3lib_xml::utf8 (  $  content  )

UTF-8 encodes the input content (from ISO-8859-1!). Parameters: string  String content to UTF-8 encode Returns: string Encoded content. Definition at line 271 of file class.t3lib_xml.php. { return utf8_encode($content); }

t3lib_xml::WAPback (   )

Creates the BACK button for WAP documents. Returns: void Definition at line 301 of file class.t3lib_xml.php. References addLine(), and newLevel(). { $this->newLevel('template',1); $this->newLevel('do',1,array('type'=>'accept','label'=>'Back')); $this->addLine('<prev/>'); $this->newLevel('do'); $this->newLevel('template'); }

t3lib_xml::WAPHeader (   )

Initialize WML (WAP) document with <?xml + <!DOCTYPE header tags and setting ->topLevelName as the first level. Returns: void Definition at line 132 of file class.t3lib_xml.php. References newLevel(). { $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); }

---

Member Data Documentation

t3lib_xml::$Icode = ''

Definition at line 91 of file class.t3lib_xml.php.

t3lib_xml::$includeNonEmptyValues = 0

Definition at line 93 of file class.t3lib_xml.php.

t3lib_xml::$lines = array()

Definition at line 94 of file class.t3lib_xml.php.

t3lib_xml::$topLevelName = 'typo3_test'

Definition at line 87 of file class.t3lib_xml.php.

t3lib_xml::$XML_recFields = array()

Definition at line 88 of file class.t3lib_xml.php.

t3lib_xml::$XMLdebug = 0

Definition at line 92 of file class.t3lib_xml.php.

t3lib_xml::$XMLIndent = 0

Definition at line 90 of file class.t3lib_xml.php.

---

The documentation for this class was generated from the following file:

• t3lib/class.t3lib_xml.php

---