[Phpxd-commits] CVS: phpXD/doc DOMWriter.html,NONE,1.1 Document.html,1.3,1.4 allclasses-frame.html,1
Status: Beta
Brought to you by:
growbal
From: Thomas D. <th...@us...> - 2002-03-04 16:58:46
|
Update of /cvsroot/phpxd/phpXD/doc In directory usw-pr-cvs1:/tmp/cvs-serv14473/doc Modified Files: Document.html allclasses-frame.html Added Files: DOMWriter.html Log Message: --- NEW FILE: DOMWriter.html --- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc on Mon Mar 04 17:54:31 CET 2002 --> <TITLE> phpXMLDOM: API Documentation - Class DOMWriter </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> </HEAD> <BODY BGCOLOR="white"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_top"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="DOMParser.html"><B>PREV CLASS</B></A> <A HREF="DTDParser.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="DOMWriter.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> Class DOMWriter</H2> <PRE> <B>DOMWriter</B> </PRE> <HR> <DL> <DT>public class <B>DOMWriter</B></DL> <P> Class representing the DOMWriter interface. <P> <HR> <P> <!-- ======== INNER CLASS SUMMARY ======== --> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Field Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> string</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#$encoding">$encoding</A></B></CODE> <BR> The character encoding in which the output will be written. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> string</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#$errorHandler">$errorHandler</A></B></CODE> <BR> The error handler that will receive error notifications during serialization. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private string</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#$lastEncoding">$lastEncoding</A></B></CODE> <BR> The actual character encoding that was last used by this formatter. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private array</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#$namedFeatures">$namedFeatures</A></B></CODE> <BR> An array for saving DOMWriter's names features. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> string</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#$newLine">$newLine</A></B></CODE> <BR> The end-of-line sequence of characters to be used in the XML being written out. </TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="DOMWriter.html#DOMWriter()">DOMWriter</A></B>()</CODE> <BR> Constructor of the class.<br></TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#canRecognizeFeatureName(var)">canRecognizeFeatureName</A></B>(var $name)</CODE> <BR> Returns true if the feature could be successfully set.<br></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#canSetFeature(var, var)">canSetFeature</A></B>(var $name, var $state)</CODE> <BR> Returns true if the feature could be successfully set to the specified value.<br> DOM-Level 3</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#getFeature(var)">getFeature</A></B>(var $name)</CODE> <BR> Returns the current state of the feature (true or false).<br> DOM-Level 3</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private string</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#printIndent(var)">printIndent</A></B>(var $indent)</CODE> <BR> Print indents for pretty format<br></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#setFeature(var, var)">setFeature</A></B>(var $name, var $state)</CODE> <BR> Returns true if the feature could be successfully set to the specified value.<br> DOM-Level 3</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#writeNode(var, var)">writeNode</A></B>(var $destination, var $wnode)</CODE> <BR> Write out the specified node in the description of DOMWriter. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> string</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#writeToString(var)">writeToString</A></B>(var $wnode)</CODE> <BR> Serialize the specified node in the description of DOMWriter.<br> DOM-Level 3</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>private void</CODE></FONT></TD> <TD><CODE><B><A HREF="DOMWriter.html#writeToString2(var, var, var, var)">writeToString2</A></B>(var $dom, var $trim, var $indent, var $text)</CODE> <BR> Serialize the specified node in the description of DOMWriter.<br></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Field Detail</B></FONT></TD> </TR> </TABLE> <A NAME="$namedFeatures"><!-- --></A><H3> $namedFeatures</H3> <PRE> private array <B>$namedFeatures</B></PRE> <DL> <DD>An array for saving DOMWriter's names features. The array keys are the feature names. The array values are the feature states (true or false).<br> DOM-Level 3</DL> <HR> <A NAME="$encoding"><!-- --></A><H3> $encoding</H3> <PRE> public string <B>$encoding</B></PRE> <DL> <DD>The character encoding in which the output will be written. The encoding to use when writing is determined as follows: <br><ul> <li>If the encoding attribute has been set, that value will be used. <br> <li>If the encoding attribute is null or empty, but the item to be written includes an encoding declaration, that value will be used.<br> <li>If neither of the above provides an encoding name, a default encoding of "UTF-8" will be used. </ul><br> DOM-Level 3</DL> <HR> <A NAME="$lastEncoding"><!-- --></A><H3> $lastEncoding</H3> <PRE> private string <B>$lastEncoding</B></PRE> <DL> <DD>The actual character encoding that was last used by this formatter. This convenience method allows the encoding that was used when serializing a document to be directly obtained.<br> DOM-Level 3</DL> <HR> <A NAME="$errorHandler"><!-- --></A><H3> $errorHandler</H3> <PRE> public string <B>$errorHandler</B></PRE> <DL> <DD>The error handler that will receive error notifications during serialization. The node where the error occured is passed to this error handler, any modification to nodes from within an error callback should be avoided since this will result in undefined, implementation dependent behavior.<br> DOM-Level 3</DL> <HR> <A NAME="$newLine"><!-- --></A><H3> $newLine</H3> <PRE> public string <B>$newLine</B></PRE> <DL> <DD>The end-of-line sequence of characters to be used in the XML being written out. The only permitted values are these: <br><ul> <li>null <li>CR <li>CR-LF <li>LF</ul><br> DOM-Level 3</DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TD> </TR> </TABLE> <A NAME="DOMWriter()"><!-- --></A><H3> DOMWriter</H3> <PRE> public <B>DOMWriter</B>()</PRE> <DL> <DD>Constructor of the class.<br></DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT></TD> </TR> </TABLE> <A NAME="setFeature(var, var)"><!-- --></A><H3> setFeature</H3> <PRE> public void <B>setFeature</B>(var $name, var $state)</PRE> <DL> <DD>Returns true if the feature could be successfully set to the specified value.<br> DOM-Level 3<DD><DL> <DT><B>Parameters:</B><DD><CODE>$name</CODE> - <code>string</code><DD><CODE>$state</CODE> - <code>boolean</code></DL> </DD> </DL> <HR> <A NAME="canRecognizeFeatureName(var)"><!-- --></A><H3> canRecognizeFeatureName</H3> <PRE> private boolean <B>canRecognizeFeatureName</B>(var $name)</PRE> <DL> <DD>Returns true if the feature could be successfully set.<br><DD><DL> <DT><B>Parameters:</B><DD><CODE>$name</CODE> - <code>string</code></DL> </DD> </DL> <HR> <A NAME="canSetFeature(var, var)"><!-- --></A><H3> canSetFeature</H3> <PRE> public boolean <B>canSetFeature</B>(var $name, var $state)</PRE> <DL> <DD>Returns true if the feature could be successfully set to the specified value.<br> DOM-Level 3<DD><DL> <DT><B>Parameters:</B><DD><CODE>$name</CODE> - <code>string</code><DD><CODE>$state</CODE> - <code>boolean</code></DL> </DD> </DL> <HR> <A NAME="getFeature(var)"><!-- --></A><H3> getFeature</H3> <PRE> public boolean <B>getFeature</B>(var $name)</PRE> <DL> <DD>Returns the current state of the feature (true or false).<br> DOM-Level 3<DD><DL> <DT><B>Parameters:</B><DD><CODE>$name</CODE> - <code>string</code></DL> </DD> </DL> <HR> <A NAME="writeNode(var, var)"><!-- --></A><H3> writeNode</H3> <PRE> public boolean <B>writeNode</B>(var $destination, var $wnode)</PRE> <DL> <DD>Write out the specified node in the description of DOMWriter. Destination can be in these PHP supported output:<ul> <li> "/home/rasmus/file.xml" <li> "ftp:/ /user:pas...@ex.../file.xml" <li> "php:/ /stdout", or "php:/ /stderr"</ul> On the Windows platform, be careful to escape any backslashes used in the path to the file, or use forward slashes: "c:\\data\\file.xml".<br> DOM-Level 3<DD><DL> <DT><B>Parameters:</B><DD><CODE>$destination</CODE> - <code>string</code><DD><CODE>$wnode</CODE> - <code>Node</code></DL> </DD> </DL> <HR> <A NAME="writeToString(var)"><!-- --></A><H3> writeToString</H3> <PRE> public string <B>writeToString</B>(var $wnode)</PRE> <DL> <DD>Serialize the specified node in the description of DOMWriter.<br> DOM-Level 3<DD><DL> <DT><B>Parameters:</B><DD><CODE>$wnode</CODE> - <code>Node</code></DL> </DD> </DL> <HR> <A NAME="printIndent(var)"><!-- --></A><H3> printIndent</H3> <PRE> private string <B>printIndent</B>(var $indent)</PRE> <DL> <DD>Print indents for pretty format<br><DD><DL> <DT><B>Parameters:</B><DD><CODE>$indent</CODE> - <code>int</code></DL> </DD> </DL> <HR> <A NAME="writeToString2(var, var, var, var)"><!-- --></A><H3> writeToString2</H3> <PRE> private void <B>writeToString2</B>(var $dom, var $trim, var $indent, var $text)</PRE> <DL> <DD>Serialize the specified node in the description of DOMWriter.<br><DD><DL> <DT><B>Parameters:</B><DD><CODE>$dom</CODE> - <code>Node</code><DD><CODE>$trim</CODE> - <code>boolean</code><DD><CODE>$indent</CODE> - <code>string</code><DD><CODE>&$text</CODE> - <code>string</code><DD><CODE>$dom</CODE> - is passed by reference<DD><CODE>$text</CODE> - is passed by reference</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="DOMParser.html"><B>PREV CLASS</B></A> <A HREF="DTDParser.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="DOMWriter.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> </BODY> </HTML> Index: Document.html =================================================================== RCS file: /cvsroot/phpxd/phpXD/doc/Document.html,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -r1.3 -r1.4 *** Document.html 9 Feb 2002 17:56:15 -0000 1.3 --- Document.html 4 Mar 2002 16:58:42 -0000 1.4 *************** *** 3,9 **** <HTML> <HEAD> ! <!-- Generated by javadoc on Sat Feb 09 18:40:34 CET 2002 --> <TITLE> ! phpXMLDOM: API Documentation - Class Document </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> --- 3,9 ---- <HTML> <HEAD> ! <!-- Generated by javadoc on Mon Mar 04 17:56:34 CET 2002 --> <TITLE> ! phpXMLDOM: API Documentation - Class Document </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> *************** *** 450,454 **** <DD>Creates an Attribute node.<br> DOM-Level 1<DD><DL> ! <DT><B>Parameters:</B><DD><CODE>$name</CODE> - <code>string</code><DD><CODE>$value</CODE> - <code>string</code></DL> </DD> </DL> --- 450,454 ---- <DD>Creates an Attribute node.<br> DOM-Level 1<DD><DL> ! <DT><B>Parameters:</B><DD><CODE>$name</CODE> - <code>string</code></DL> </DD> </DL> *************** *** 462,466 **** <DD>Creates a CDataSection node.<br> DOM-Level 1<DD><DL> ! <DT><B>Parameters:</B><DD><CODE>$data</CODE> - </DL> </DD> </DL> --- 462,466 ---- <DD>Creates a CDataSection node.<br> DOM-Level 1<DD><DL> ! <DT><B>Parameters:</B><DD><CODE>$data</CODE> - <code>string</code></DL> </DD> </DL> Index: allclasses-frame.html =================================================================== RCS file: /cvsroot/phpxd/phpXD/doc/allclasses-frame.html,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -r1.3 -r1.4 *** allclasses-frame.html 9 Feb 2002 17:56:15 -0000 1.3 --- allclasses-frame.html 4 Mar 2002 16:58:42 -0000 1.4 *************** *** 3,9 **** <HTML> <HEAD> ! <!-- Generated by javadoc on Sat Feb 09 18:40:34 CET 2002 --> <TITLE> ! phpXMLDOM: API Documentation - All Classes </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> --- 3,9 ---- <HTML> <HEAD> ! <!-- Generated by javadoc on Mon Mar 04 17:54:31 CET 2002 --> <TITLE> ! All Classes </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> *************** *** 33,36 **** --- 33,40 ---- <BR> <A HREF="DOMParser.html" TARGET="classFrame">DOMParser</A> + <BR> + <A HREF="DOMWriter.html" TARGET="classFrame">DOMWriter</A> + <BR> + <A HREF="DTDParser.html" TARGET="classFrame">DTDParser</A> <BR> <A HREF="Element.html" TARGET="classFrame">Element</A> |