t3lib_xml Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	t3lib_xml ($topLevelName)
	setRecFields ($table, $list)
	getResult ()
	WAPHeader ()
	renderHeader ()
	renderFooter ()
	newLevel ($name, $beginEndFlag=0, $params=array())
	output ($content)
	indent ($b)
	renderRecords ($table, $res)
	addRecord ($table, $row)
	getRowInXML ($table, $row)
	utf8 ($content)
	substNewline ($string)
	fieldWrap ($field, $value)
	WAPback ()
	addLine ($str)
Öffentliche Attribute
	$topLevelName = 'typo3_test'
	$XML_recFields = array()
	$XMLIndent = 0
	$Icode = ''
	$XMLdebug = 0
	$includeNonEmptyValues = 0
	$lines = array()

---

Dokumentation der Elementfunktionen

t3lib_xml::addLine

(

$

str

)

Add a line to the internal XML structure (automatically prefixed with ->Icode.

Parameter:

string

Line to add to the $this->lines array

Rückgabe:

void

t3lib_xml::addRecord	(	$	table,
		$	row
	)

Adds record, $row, from table, $table, to the internal array of XML-lines

Parameter:

	string	Table name
	array	The row to add to XML structure from the table name

Rückgabe:

void

t3lib_xml::fieldWrap	(	$	field,
		$	value
	)

Wraps the value in tags with element name, $field.

Parameter:

	string	Fieldname from a record - will be the element name
	string	Value from the field - will be wrapped in the elements.

Rückgabe:

string The wrapped string.

t3lib_xml::getResult

(

)

Returns the result of the XML rendering, basically this is imploding the internal ->lines array with linebreaks.

Rückgabe:

string

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.

Parameter:

	string	Table name
	array	Row from table to add.

Rückgabe:

void private

t3lib_xml::indent

(

$

b

)

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)

Parameter:

boolean

If true the XMLIndent var is increased, otherwise decreased

Rückgabe:

string ->Icode - the prefix string with TAB-chars.

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

Indents/Outdents a new level named, $name

Parameter:

	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

Rückgabe:

void

t3lib_xml::output

(

$

content

)

Function that will return the content from string $content. If the internal ->XMLdebug flag is set the content returned will be formatted in

-tags

 
Parameter:

  

    
string 
The XML content to output
 
  
  

Rückgabe:
string		Output

t3lib_xml::renderFooter

(

)

Sets the footer (of ->topLevelName)

Rückgabe:

void

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!

Rückgabe:

void

t3lib_xml::renderRecords	(	$	table,
		$	res
	)

Takes a SQL result for $table and traverses it, adding rows

Parameter:

	string	Tablename
	pointer	SQL resource pointer, should be reset

Rückgabe:

void

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.

Parameter:

	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.

Rückgabe:

void

t3lib_xml::substNewline

(

$

string

)

Substitutes chr(10) characters with a '<newline>' tag.

Parameter:

string

Input value

Rückgabe:

string Processed input value

t3lib_xml::t3lib_xml

(

$

topLevelName

)

Constructor, setting topLevelName to the input var

Parameter:

string

Top Level Name

Rückgabe:

void

t3lib_xml::utf8

(

$

content

)

UTF-8 encodes the input content (from ISO-8859-1!)

Parameter:

string

String content to UTF-8 encode

Rückgabe:

string Encoded content.

t3lib_xml::WAPback

(

)

Creates the BACK button for WAP documents

Rückgabe:

void

t3lib_xml::WAPHeader

(

)

Initialize WML (WAP) document with <?xml + <!DOCTYPE header tags and setting ->topLevelName as the first level.

Rückgabe:

void

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_xml.php