<!-- This comment will put IE 6, 7 and 8 in quirks mode --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>OAI PHP: ANDS_XML Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javaScript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.6.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <img id="MSearchSelect" src="search/search.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </div> </li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>ANDS_XML Class Reference</h1><!-- doxytag: class="ANDS_XML" --><div class="dynheader"> Inheritance diagram for ANDS_XML:</div> <div class="dynsection"> <div class="center"> <img src="classANDS__XML.png" usemap="#ANDS_XML_map" alt=""/> <map id="ANDS_XML_map" name="ANDS_XML_map"> <area href="classANDS__Error__XML.html" alt="ANDS_Error_XML" shape="rect" coords="0,56,143,80"/> <area href="classANDS__Response__XML.html" alt="ANDS_Response_XML" shape="rect" coords="153,56,296,80"/> </map> </div> </div> <p><a href="classANDS__XML-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__XML.html#ac47c882e27ad59397e9126db1b0ebe93">__construct</a> ($par_array)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__XML.html#ad80d9ee16cb34385e820ade499ca2817">addChild</a> ($mom_node, $name, $value='')</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__XML.html#aff69b89d257af01edc84e99c87c3faee">create_request</a> ($par_array)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__XML.html#a6339abd522cdcd180708251096f69fa4">display</a> ()</td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__XML.html#a338a63911354073419234f28beb36c66">$doc</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A wraper of DOMDocument for data provider </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac47c882e27ad59397e9126db1b0ebe93"></a><!-- doxytag: member="ANDS_XML::__construct" ref="ac47c882e27ad59397e9126db1b0ebe93" args="($par_array)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_XML::__construct </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"> <em>par_array</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructs an <a class="el" href="classANDS__XML.html">ANDS_XML</a> object.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>$par_array</em> </td><td>Type: array. Array of request parameters for creating an <a class="el" href="classANDS__XML.html">ANDS_XML</a> object. </td></tr> </table> </dd> </dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classANDS__XML.html#aff69b89d257af01edc84e99c87c3faee">create_request</a>. </dd></dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ad80d9ee16cb34385e820ade499ca2817"></a><!-- doxytag: member="ANDS_XML::addChild" ref="ad80d9ee16cb34385e820ade499ca2817" args="($mom_node, $name, $value='')" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_XML::addChild </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"> <em>mom_node</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>value</em> = <code>''</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Add a child node to a parent node on a XML Doc: a worker function.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>$mom_node</em> </td><td>Type: DOMNode. The target node.</td></tr> <tr><td valign="top"></td><td valign="top"><em>$name</em> </td><td>Type: string. The name of child nade is being added</td></tr> <tr><td valign="top"></td><td valign="top"><em>$value</em> </td><td>Type: string. Text for the adding node if it is a text node.</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>DOMElement $added_node The newly created node, can be used for further expansion. If no further expansion is expected, return value can be igored. </dd></dl> </div> </div> <a class="anchor" id="aff69b89d257af01edc84e99c87c3faee"></a><!-- doxytag: member="ANDS_XML::create_request" ref="aff69b89d257af01edc84e99c87c3faee" args="($par_array)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_XML::create_request </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"> <em>par_array</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create an OAI request node.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>$par_array</em> </td><td>Type: array The attributes of a request node. They describe the verb of the request and other associated parameters used in the request. Keys of the array define attributes, and values are their content. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a6339abd522cdcd180708251096f69fa4"></a><!-- doxytag: member="ANDS_XML::display" ref="a6339abd522cdcd180708251096f69fa4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_XML::display </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Display a doc in a readable, well-formatted way for display or saving </p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a338a63911354073419234f28beb36c66"></a><!-- doxytag: member="ANDS_XML::$doc" ref="a338a63911354073419234f28beb36c66" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_XML::$doc</td> </tr> </table> </div> <div class="memdoc"> <p>Type: DOMDocument. Handle of current XML Document object </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="xml__creater_8php.html">xml_creater.php</a></li> </ul> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jun 16 12:49:22 2011 for OAI PHP by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>