Location: PHPKode > projects > FOOWD > foowd/apidocs/Foowd/foowd_text_xml.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>

<title>Foowd_text_xml</title>

<link rel="stylesheet" type="text/css" href="../stylesheet.css" />
<link rel="start" href="overview-summary.html" />

</head>

<body>

<table width="100%" cellpadding="0" class="header">
<tr><td class="header">
<a href="../overview-summary.html">Overview</a>
<a href="package-summary.html">Package</a>
<a href="package-tree.html">Tree</a></td><td class="short_title">
FOOWD</td></tr>
</table>

<table width="100%" cellpadding="0" class="small_links">
<tr>
<td><a href="../index.html" target="_top">FRAMES</a> <a href="foowd_text_xml.html" target="_top">NO FRAMES</a></td>
</tr>
<tr>
<td>SUMMARY: <a href="#summary_field">FIELD</a> <a href="#summary_method">METHOD</a></td>
<td>DETAIL: <a href="#detail_field">FIELD</a> <a href="#detail_method">METHOD</a></td>
</tr>
</table>

<hr />

<h1>Class foowd_text_xml</h1>

<pre><a href="../Foowd/foowd_object.html">foowd_object</a><br />  |<br />  +--<a href="../Foowd/foowd_text_plain.html">foowd_text_plain</a><br />        |<br />        +--<strong>foowd_text_xml</strong><br /></pre>


<hr />

<p>
class <strong>foowd_text_xml</strong><br />
extends <a href="../Foowd/foowd_text_plain.html">foowd_text_plain</a><br /></p>

<p>XML text object class. </p><p>This class defines a XML text area and methods to view and edit that area. </p><dl><dt>Author:</dt><dd>Paul James </dd></dl>
<hr />
<br />

<a name="summary_field"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th colspan="2" class="title">Field Summary</th></tr>
</table>

<table width="100%" cellspacing="0" class="body"><tr><td class="type">public int</td><td class="description"><a href="#$schema">$schema</a><br />ID of XML schema object to use for this XML object. </td></tr></table><br /><table width="100%" cellspacing="0" class="inherit"><tr><th colspan="2" class="inherit">Fields inherited from <a href="../Foowd/foowd_text_plain.html">foowd_text_plain</a></th></tr><tr><td class="inherit"><a href="../Foowd/foowd_text_plain.html#$body">$body</a> </td></tr></table><br /><table width="100%" cellspacing="0" class="inherit"><tr><th colspan="2" class="inherit">Fields inherited from <a href="../Foowd/foowd_object.html">foowd_object</a></th></tr><tr><td class="inherit"><a href="../Foowd/foowd_object.html#$foowd_vars_meta">$foowd_vars_meta</a> <a href="../Foowd/foowd_object.html#$foowd_indexes">$foowd_indexes</a> <a href="../Foowd/foowd_object.html#$foowd_original_access_vars">$foowd_original_access_vars</a> <a href="../Foowd/foowd_object.html#$foowd_source">$foowd_source</a> <a href="../Foowd/foowd_object.html#$foowd_changed">$foowd_changed</a> <a href="../Foowd/foowd_object.html#$foowd_update">$foowd_update</a> <a href="../Foowd/foowd_object.html#$title">$title</a> <a href="../Foowd/foowd_object.html#$objectid">$objectid</a> <a href="../Foowd/foowd_object.html#$version">$version</a> <a href="../Foowd/foowd_object.html#$classid">$classid</a> <a href="../Foowd/foowd_object.html#$workspaceid">$workspaceid</a> <a href="../Foowd/foowd_object.html#$created">$created</a> <a href="../Foowd/foowd_object.html#$creatorid">$creatorid</a> <a href="../Foowd/foowd_object.html#$creatorName">$creatorName</a> <a href="../Foowd/foowd_object.html#$updated">$updated</a> <a href="../Foowd/foowd_object.html#$updatorid">$updatorid</a> <a href="../Foowd/foowd_object.html#$updatorName">$updatorName</a> <a href="../Foowd/foowd_object.html#$permissions">$permissions</a> </td></tr></table>
<br />
<a name="summary_method"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th colspan="2" class="title">Method Summary</th></tr>
</table>

<table width="100%" cellspacing="0" class="body"><tr><td class="type">public void</td><td class="description"><a href="#foowd_text_xml">foowd_text_xml</a><br />Constructs a new XML text object. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#__wakeup">__wakeup</a><br />Serliaisation wakeup method. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#validateXML">validateXML</a><br />Validate the XML string against the schema. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#class_create">class_create</a><br />Output an object creation form and process its input. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#method_view">method_view</a><br />Output the object. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#method_edit">method_edit</a><br />Output an edit form and process its input </td></tr><tr><td class="type">public void</td><td class="description"><a href="#method_raw">method_raw</a><br />Output the object content in a raw format. </td></tr></table><br /><table width="100%" cellspacing="0" class="inherit"><tr><th colspan="2" class="inherit">Methods inherited from <a href="../Foowd/foowd_text_plain.html">foowd_text_plain</a></th></tr><tr><td class="inherit"><a href="../Foowd/foowd_text_plain.html#foowd_text_plain">foowd_text_plain</a>, <a href="../Foowd/foowd_text_plain.html#__wakeup">__wakeup</a>, <a href="../Foowd/foowd_text_plain.html#view">view</a>, <a href="../Foowd/foowd_text_plain.html#processContent">processContent</a>, <a href="../Foowd/foowd_text_plain.html#edit">edit</a>, <a href="../Foowd/foowd_text_plain.html#diff">diff</a>, <a href="../Foowd/foowd_text_plain.html#class_create">class_create</a>, <a href="../Foowd/foowd_text_plain.html#method_edit">method_edit</a>, <a href="../Foowd/foowd_text_plain.html#method_history">method_history</a>, <a href="../Foowd/foowd_text_plain.html#method_diff">method_diff</a></td></tr></table><br /><table width="100%" cellspacing="0" class="inherit"><tr><th colspan="2" class="inherit">Methods inherited from <a href="../Foowd/foowd_object.html">foowd_object</a></th></tr><tr><td class="inherit"><a href="../Foowd/foowd_object.html#foowd_object">foowd_object</a>, <a href="../Foowd/foowd_object.html#__sleep">__sleep</a>, <a href="../Foowd/foowd_object.html#__wakeup">__wakeup</a>, <a href="../Foowd/foowd_object.html#method">method</a>, <a href="../Foowd/foowd_object.html#classMethod">classMethod</a>, <a href="../Foowd/foowd_object.html#getTitle">getTitle</a>, <a href="../Foowd/foowd_object.html#get">get</a>, <a href="../Foowd/foowd_object.html#set">set</a>, <a href="../Foowd/foowd_object.html#setArray">setArray</a>, <a href="../Foowd/foowd_object.html#newVersion">newVersion</a>, <a href="../Foowd/foowd_object.html#update">update</a>, <a href="../Foowd/foowd_object.html#save">save</a>, <a href="../Foowd/foowd_object.html#delete">delete</a>, <a href="../Foowd/foowd_object.html#tidyArchive">tidyArchive</a>, <a href="../Foowd/foowd_object.html#addFormItemsToAdminForm">addFormItemsToAdminForm</a>, <a href="../Foowd/foowd_object.html#view">view</a>, <a href="../Foowd/foowd_object.html#clone">clone</a>, <a href="../Foowd/foowd_object.html#addPermissionDropdowns">addPermissionDropdowns</a>, <a href="../Foowd/foowd_object.html#getWorkspaceList">getWorkspaceList</a>, <a href="../Foowd/foowd_object.html#vars2XML">vars2XML</a>, <a href="../Foowd/foowd_object.html#getMethods">getMethods</a>, <a href="../Foowd/foowd_object.html#class_create">class_create</a>, <a href="../Foowd/foowd_object.html#method_view">method_view</a>, <a href="../Foowd/foowd_object.html#method_history">method_history</a>, <a href="../Foowd/foowd_object.html#method_admin">method_admin</a>, <a href="../Foowd/foowd_object.html#method_revert">method_revert</a>, <a href="../Foowd/foowd_object.html#method_delete">method_delete</a>, <a href="../Foowd/foowd_object.html#method_clone">method_clone</a>, <a href="../Foowd/foowd_object.html#method_permissions">method_permissions</a>, <a href="../Foowd/foowd_object.html#method_xml">method_xml</a></td></tr></table>
<br />
<hr />
<br />


<a name="detail_field"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th class="title">Field Detail</th></tr>
</table>

<a name="$schema"></a><h2>schema</h2> <code>public int <strong>$schema</strong></code><br /><p>ID of XML schema object to use for this XML object. </p><p></p><hr />
<a name="detail_method"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th class="title">Method Detail</th></tr>
</table>

<a name="foowd_text_xml"></a><h2>foowd_text_xml()</h2> <code>public void <strong>foowd_text_xml</strong>(object foowd, str title, int schema, str body, str viewGroup, str adminGroup, str deleteGroup, str editGroup)</code><br /><p>Constructs a new XML text object. </p><p></p><dl><dt>Parameters:</dt><dd><code>foowd</code> - The foowd environment object. </dd><dd><code>title</code> - The objects title. </dd><dd><code>schema</code> - The ID of the XML schema object to use for this XML object. </dd><dd><code>body</code> - The text content body. </dd><dd><code>viewGroup</code> - The user group for viewing the object. </dd><dd><code>adminGroup</code> - The user group for administrating the object. </dd><dd><code>deleteGroup</code> - The user group for deleting the object. </dd><dd><code>editGroup</code> - The user group for editing the object. </dd></dl><hr /><a name="__wakeup"></a><h2>__wakeup()</h2> <code>public void <strong>__wakeup</strong>()</code><br /><p>Serliaisation wakeup method. </p><p>Re-create Foowd meta arrays not stored when object was serialized. </p><hr /><a name="validateXML"></a><h2>validateXML()</h2> <code>public str <strong>validateXML</strong>(str xml, array schema)</code><br /><p>Validate the XML string against the schema. </p><p></p><dl><dt>Parameters:</dt><dd><code>xml</code> - The XML string to validate. </dd><dd><code>schema</code> - The XML schema array. </dd></dl><dl><dt>Returns:</dt><dd>An error string or FALSE on success. </dd></dl><hr /><a name="class_create"></a><h2>class_create()</h2> <code>public void <strong>class_create</strong>(object foowd, str className)</code><br /><p>Output an object creation form and process its input. </p><p></p><dl><dt>Parameters:</dt><dd><code>foowd</code> - The foowd environment object. </dd><dd><code>className</code> - The name of the class. </dd></dl><hr /><a name="method_view"></a><h2>method_view()</h2> <code>public void <strong>method_view</strong>()</code><br /><p>Output the object. </p><p></p><hr /><a name="method_edit"></a><h2>method_edit()</h2> <code>public void <strong>method_edit</strong>()</code><br /><p>Output an edit form and process its input </p><hr /><a name="method_raw"></a><h2>method_raw()</h2> <code>public void <strong>method_raw</strong>()</code><br /><p>Output the object content in a raw format. </p><p></p><hr />
<table width="100%" cellpadding="0" class="header">
<tr><td class="header">
<a href="../overview-summary.html">Overview</a>
<a href="package-summary.html">Package</a>
<a href="package-tree.html">Tree</a></td><td class="short_title">
FOOWD</td></tr>
</table>

<table width="100%" cellpadding="0" class="small_links">
<tr>
<td><a href="../index.html" target="_top">FRAMES</a> <a href="foowd_text_xml.html" target="_top">NO FRAMES</a></td>
</tr>
<tr>
<td>SUMMARY: <a href="#summary_field">FIELD</a> <a href="#summary_method">METHOD</a></td>
<td>DETAIL: <a href="#detail_field">FIELD</a> <a href="#detail_method">METHOD</a></td>
</tr>
</table>

<hr />

<p class="footer">This document was generated by <a href="http://phpdoctor.sourceforge.net/">PHPDoctor: The PHP Documentation Creator</a>.</p>
</body>
</html>
Return current item: FOOWD