<!-- 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_Response_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_Response_XML Class Reference</h1><!-- doxytag: class="ANDS_Response_XML" --><!-- doxytag: inherits="ANDS_XML" --><div class="dynheader"> Inheritance diagram for ANDS_Response_XML:</div> <div class="dynsection"> <div class="center"> <img src="classANDS__Response__XML.png" usemap="#ANDS_Response_XML_map" alt=""/> <map id="ANDS_Response_XML_map" name="ANDS_Response_XML_map"> <area href="classANDS__XML.html" alt="ANDS_XML" shape="rect" coords="0,0,143,24"/> </map> </div> </div> <p><a href="classANDS__Response__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__Response__XML.html#aa5810a8e1e9d6e96127aee831a77148c">add2_verbNode</a> ($nodeName, $value=null)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__Response__XML.html#ac10e8025ad1f60b05428d62bb790a4c9">create_record</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__Response__XML.html#a671a47ccec90341997a2fa0b402d50e6">create_header</a> ($identifier, $timestamp, $ands_class, $add_to_node=null)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__Response__XML.html#a699029918e25f67dbbe623a12585646a">create_metadata</a> ($mom_record_node)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__Response__XML.html#ad3a7689a916a5bb43618ea530808ed91">create_resumpToken</a> ($token, $expirationdatetime, $num_rows, $cursor=null)</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__Response__XML.html#a2398236734301326da1276557fc3752d">$verbNode</a></td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classANDS__Response__XML.html#a42a2bd785c53ffcddbe3d1f9da57d67d">$verb</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Generate an XML response to a request if no error has occured</p> <p>This is the class to further develop to suits a publication need </p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa5810a8e1e9d6e96127aee831a77148c"></a><!-- doxytag: member="ANDS_Response_XML::add2_verbNode" ref="aa5810a8e1e9d6e96127aee831a77148c" args="($nodeName, $value=null)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_Response_XML::add2_verbNode </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"> <em>nodeName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>value</em> = <code>null</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Add direct child nodes to verb node (OAI-PMH), e.g. response to ListMetadataFormats. Different verbs can have different required child nodes. </p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classANDS__Response__XML.html#ac10e8025ad1f60b05428d62bb790a4c9">create_record</a>, <a class="el" href="classANDS__Response__XML.html#a671a47ccec90341997a2fa0b402d50e6">create_header</a> </dd> <dd> <a href="http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm.">http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm.</a></dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>$nodeName</em> </td><td>Type: string. The name of appending node. </td></tr> <tr><td valign="top"></td><td valign="top"><em>$value</em> </td><td>Type: string. The content of appending node. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ac10e8025ad1f60b05428d62bb790a4c9"></a><!-- doxytag: member="ANDS_Response_XML::create_record" ref="ac10e8025ad1f60b05428d62bb790a4c9" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_Response_XML::create_record </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create an empty <record> node. Other nodes will be appended to it later. </p> </div> </div> <a class="anchor" id="a671a47ccec90341997a2fa0b402d50e6"></a><!-- doxytag: member="ANDS_Response_XML::create_header" ref="a671a47ccec90341997a2fa0b402d50e6" args="($identifier, $timestamp, $ands_class, $add_to_node=null)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_Response_XML::create_header </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"> <em>identifier</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>timestamp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>ands_class</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>add_to_node</em> = <code>null</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Headers are enclosed inside of <record> to the query of ListRecords, ListIdentifiers and etc.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>$identifier</em> </td><td>Type: string. The identifier string for node <identifier>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>$timestamp</em> </td><td>Type: timestamp. Timestapme in UTC format for node <datastamp>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>$ands_class</em> </td><td>Type: mix. Can be an array or just a string. Content of <setSpec>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>$add_to_node</em> </td><td>Type: DOMElement. Default value is null. In normal cases, $add_to_node is the <record> node created previously. When it is null, the newly created header node is attatched to $this->verbNode. Otherwise it will be attatched to the desired node defined in $add_to_node. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a699029918e25f67dbbe623a12585646a"></a><!-- doxytag: member="ANDS_Response_XML::create_metadata" ref="a699029918e25f67dbbe623a12585646a" args="($mom_record_node)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_Response_XML::create_metadata </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"> <em>mom_record_node</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create metadata node for holding metadata. This is always added to <record> 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>$mom_record_node</em> </td><td>DOMElement. A node acts as the parent node.</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>$meta_node Type: DOMElement. The newly created registryObject node which will be used for further expansion. metadata node itself is maintained by internally by the Class. </dd></dl> </div> </div> <a class="anchor" id="ad3a7689a916a5bb43618ea530808ed91"></a><!-- doxytag: member="ANDS_Response_XML::create_resumpToken" ref="ad3a7689a916a5bb43618ea530808ed91" args="($token, $expirationdatetime, $num_rows, $cursor=null)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_Response_XML::create_resumpToken </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"> <em>token</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>expirationdatetime</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>num_rows</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"> <em>cursor</em> = <code>null</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>If there are too many records request could not finished a resumpToken is generated to let harvester know</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>$token</em> </td><td>Type: string. A random number created somewhere? </td></tr> <tr><td valign="top"></td><td valign="top"><em>$expirationdatetime</em> </td><td>Type: string. A string representing time. </td></tr> <tr><td valign="top"></td><td valign="top"><em>$num_rows</em> </td><td>Type: integer. Number of records retrieved. </td></tr> <tr><td valign="top"></td><td valign="top"><em>$cursor</em> </td><td>Type: string. Cursor can be used for database to retrieve next time. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a2398236734301326da1276557fc3752d"></a><!-- doxytag: member="ANDS_Response_XML::$verbNode" ref="a2398236734301326da1276557fc3752d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_Response_XML::$verbNode</td> </tr> </table> </div> <div class="memdoc"> <p>Type: DOMElement. Verb node itself. </p> </div> </div> <a class="anchor" id="a42a2bd785c53ffcddbe3d1f9da57d67d"></a><!-- doxytag: member="ANDS_Response_XML::$verb" ref="a42a2bd785c53ffcddbe3d1f9da57d67d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ANDS_Response_XML::$verb<code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Type: string. The verb in the request </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>