238 lines
14 KiB
HTML
238 lines
14 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: oaidp-config.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>oaidp-config.php File Reference</h1>
|
|
<p>Configuration file of current data provider.
|
|
<a href="#_details">More...</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Constants</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="oaidp-config_8php.html#a2d07c29fad973dae16d991239170ff2d">SHOW_QUERY_ERROR</a> </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="oaidp-config_8php.html#a9f5f084db962d47cfd18de99129571a7">CONTENT_TYPE</a> </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="oaidp-config_8php.html#ab7ebb1d3d7394f242a35aedb9811aa77">MAXRECORDS</a> </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="oaidp-config_8php.html#a35044ef78083407dff11647b61742c92">MAXIDS</a> </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="oaidp-config_8php.html#a9b86d040a36908866c7a1a615e0d541d">TOKEN_VALID</a> </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="oaidp-config_8php.html#afe2c0dd686a18d4fa494746964b6eb16">TOKEN_PREFIX</a> </td></tr>
|
|
<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="oaidp-config_8php.html#aa51e14dc8b7351ea30e82829cb69d504">$identifyResponse</a> = array()</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="oaidp-config_8php.html#a99cfcd818d46c54bb56d6100a25f8442">$compression</a> = null</td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>This is the configuration file for the PHP OAI Data Provider. Please read through the WHOLE file, there are several things, that need to be adjusted.</p>
|
|
<p>The response may may be compressed for better performace:</p>
|
|
<ul>
|
|
<li>Compression : a compression encoding supported by the repository. The recommended values are those defined for the Content-Encoding header in Section 14.11 of RFC 2616 describing HTTP 1.1. A compression element should not be included for the identity encoding, which is implied.</li>
|
|
</ul>
|
|
<p>Some other used variables:</p>
|
|
<ul>
|
|
<li><b>$adminEmail</b>: the e-mail addresses of administrators of the repository.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>$repositoryIdentifier</b> : For a data provider there is only one. For repositories to comply with the oai format it has to be unique identifiers for items records. Basically using domainname will be fine. See: <a href="http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm.">http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm.</a></li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>$SETS</b>: An array with key words . List of supported SETs.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>$METADATAFORMATS</b>: List of supported metadata formats. It is a two-dimensional array with keys. Each supported format is one element of this array at the first dimension. The key is the name of a metadata format. The exact number of items within each format associated array depends on the nature of a metadata format. Most definitions are done here but handlers themselves are defined in separated files because only the names of PHP script are listed here.<ul>
|
|
<li>metadataPrefix</li>
|
|
<li>schema</li>
|
|
<li>metadataNamespace</li>
|
|
<li>myhandler</li>
|
|
<li>other optional items: record_prefix, record_namespace and etc.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>$SQL</b>: Settings for database and queries from database</li>
|
|
</ul>
|
|
<ul>
|
|
<li><b>$DSN</b>: DSN for connecting your database. Reference PDO for details.</li>
|
|
</ul>
|
|
<p>The rest of settings will not normally need to be adjusted. Read source code for details. </p>
|
|
<hr/><h2>Constant Documentation</h2>
|
|
<a class="anchor" id="a2d07c29fad973dae16d991239170ff2d"></a><!-- doxytag: member="oaidp-config.php::SHOW_QUERY_ERROR" ref="a2d07c29fad973dae16d991239170ff2d" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="oaidp-config_8php.html#a2d07c29fad973dae16d991239170ff2d">SHOW_QUERY_ERROR</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Whether to show error message for dubug. For installation, testing and debuging set SHOW_QUERY_ERROR to TRUE If set to TRUE, application will die and display query and database error message as soon as there is a problem. Do not set this to TRUE on a production site, since it will show error messages to everybody. If set FALSE, will create XML-output, no matter what happens. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9f5f084db962d47cfd18de99129571a7"></a><!-- doxytag: member="oaidp-config.php::CONTENT_TYPE" ref="a9f5f084db962d47cfd18de99129571a7" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="oaidp-config_8php.html#a9f5f084db962d47cfd18de99129571a7">CONTENT_TYPE</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>The content-type the WWW-server delivers back. For debug-puposes, "text/plain" is easier to view. On a production site you should use "text/xml". </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab7ebb1d3d7394f242a35aedb9811aa77"></a><!-- doxytag: member="oaidp-config.php::MAXRECORDS" ref="ab7ebb1d3d7394f242a35aedb9811aa77" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="oaidp-config_8php.html#ab7ebb1d3d7394f242a35aedb9811aa77">MAXRECORDS</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Maximum mumber of the records to deliver (verb is ListRecords) If there are more records to deliver a ResumptionToken will be generated. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a35044ef78083407dff11647b61742c92"></a><!-- doxytag: member="oaidp-config.php::MAXIDS" ref="a35044ef78083407dff11647b61742c92" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="oaidp-config_8php.html#a35044ef78083407dff11647b61742c92">MAXIDS</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Maximum mumber of identifiers to deliver (verb is ListIdentifiers) If there are more identifiers to deliver a ResumptionToken will be generated. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9b86d040a36908866c7a1a615e0d541d"></a><!-- doxytag: member="oaidp-config.php::TOKEN_VALID" ref="a9b86d040a36908866c7a1a615e0d541d" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="oaidp-config_8php.html#a9b86d040a36908866c7a1a615e0d541d">TOKEN_VALID</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>After 24 hours resumptionTokens become invalid. Unit is second. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afe2c0dd686a18d4fa494746964b6eb16"></a><!-- doxytag: member="oaidp-config.php::TOKEN_PREFIX" ref="afe2c0dd686a18d4fa494746964b6eb16" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="oaidp-config_8php.html#afe2c0dd686a18d4fa494746964b6eb16">TOKEN_PREFIX</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Where token is saved and path is included </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Variable Documentation</h2>
|
|
<a class="anchor" id="aa51e14dc8b7351ea30e82829cb69d504"></a><!-- doxytag: member="oaidp-config.php::$identifyResponse" ref="aa51e14dc8b7351ea30e82829cb69d504" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$identifyResponse = array()</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Identifier settings. It needs to have proper values to reflect the settings of the data provider.</p>
|
|
<ul>
|
|
<li>$identifyResponse['repositoryName'] : compulsory. A human readable name for the repository;</li>
|
|
<li>$identifyResponse['baseURL'] : compulsory. The base URL of the repository;</li>
|
|
<li>$identifyResponse['protocolVersion'] : compulsory. The version of the OAI-PMH supported by the repository;</li>
|
|
<li>$identifyResponse['earliestDatestamp'] : compulsory. A UTCdatetime that is the guaranteed lower limit of all datestamps recording changes, modifications, or deletions in the repository. A repository must not use datestamps lower than the one specified by the content of the earliestDatestamp element. earliestDatestamp must be expressed at the finest granularity supported by the repository.</li>
|
|
<li>$identifyResponse['deletedRecord'] : the manner in which the repository supports the notion of deleted records. Legitimate values are no ; transient ; persistent with meanings defined in the section on deletion.</li>
|
|
<li>$identifyResponse['granularity'] : the finest harvesting granularity supported by the repository. The legitimate values are YYYY-MM-DD and YYYY-MM-DDThh:mm:ssZ with meanings as defined in ISO8601. </li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a99cfcd818d46c54bb56d6100a25f8442"></a><!-- doxytag: member="oaidp-config.php::$compression" ref="a99cfcd818d46c54bb56d6100a25f8442" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">$compression = null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Compression methods supported. Optional (multiple). Default: null.</p>
|
|
<p>Currently only gzip is supported (you need output buffering turned on, and php compiled with libgz). The client MUST send "Accept-Encoding: gzip" to actually receive </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>
|