131 lines
7.5 KiB
HTML
131 lines
7.5 KiB
HTML
|
<!-- 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: oai2.php File 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><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
||
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="contents">
|
||
|
|
<h1>oai2.php File Reference</h1>
|
||
|
|
<p>OAI Data Provider command processor.
|
||
|
|
<a href="#_details">More...</a></p>
|
||
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
||
|
|
<tr><td colspan="2"><h2>Variables</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="oai2_8php.html#ab24faf4aa647cdcee494fc48524ad4ff">$errors</a> = array()</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="oai2_8php.html#ac2912df3957f91d84a9e751d0e99c93d">$attribs</a> = array ('from', 'identifier', 'metadataPrefix', 'set', 'resumptionToken', 'until')</td></tr>
|
||
|
|
</table>
|
||
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||
|
|
<p>OAI Data Provider is not designed for human to retrieve data.</p>
|
||
|
|
<p>This is an implementation of OAI Data Provider version 2.0. </p>
|
||
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm">http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm</a></dd></dl>
|
||
|
|
<p>It needs other files:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a class="el" href="oaidp-config_8php.html" title="Configuration file of current data provider.">oaidp-config.php</a> : Configuration of provider</li>
|
||
|
|
<li><a class="el" href="oaidp-util_8php.html" title="Utilities for the OAI Data Provider.">oaidp-util.php</a> : Utility functions</li>
|
||
|
|
<li><a class="el" href="xml__creater_8php.html" title="functions and class related to generating XML response file.">xml_creater.php</a> : XML generating functions</li>
|
||
|
|
<li>Actions:<ul>
|
||
|
|
<li><a class="el" href="identify_8php.html" title="Response to Verb Identify.">identify.php</a> : About the provider</li>
|
||
|
|
<li><a class="el" href="listmetadataformats_8php.html" title="Response to Verb ListMetadataFormats.">listmetadataformats.php</a> : List supported metadata formats</li>
|
||
|
|
<li><a class="el" href="listrecords_8php.html" title="Response to Verb ListRecords.">listrecords.php</a> : List identifiers and records</li>
|
||
|
|
<li><a class="el" href="listsets_8php.html" title="Response to Verb ListSets.">listsets.php</a> : List sets</li>
|
||
|
|
<li><a class="el" href="getrecord_8php.html" title="Response to Verb GetRecord.">getrecord.php</a> : Get a record<ul>
|
||
|
|
<li>Your own implementation for providing metadata records.</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p>It also initiates:</p>
|
||
|
|
<ul>
|
||
|
|
<li>PDO datbase connection object $db.</li>
|
||
|
|
<li><a class="el" href="classANDS__XML.html">ANDS_XML</a> XML document handler $outputObj.</li>
|
||
|
|
</ul>
|
||
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd><b>Remember:</b> to define your own classess for generating metadata records. In common cases, you have to implement your own code to act fully and correctly. For generic usage, you can try the <a class="el" href="classANDS__Response__XML.html">ANDS_Response_XML</a> defined in <a class="el" href="xml__creater_8php.html" title="functions and class related to generating XML response file.">xml_creater.php</a>. </dd></dl>
|
||
|
|
<hr/><h2>Variable Documentation</h2>
|
||
|
|
<a class="anchor" id="ab24faf4aa647cdcee494fc48524ad4ff"></a><!-- doxytag: member="oai2.php::$errors" ref="ab24faf4aa647cdcee494fc48524ad4ff" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">$errors = array()</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>An array for collecting erros which can be reported later. It will be checked before a new action is taken. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ac2912df3957f91d84a9e751d0e99c93d"></a><!-- doxytag: member="oai2.php::$attribs" ref="ac2912df3957f91d84a9e751d0e99c93d" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">$attribs = array ('from', 'identifier', 'metadataPrefix', 'set', 'resumptionToken', 'until')</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Supported attributes associate to verbs. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</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>
|