oaidp-config.php File Reference

Configuration file of current data provider. More...

Constants
enum	SHOW_QUERY_ERROR
enum	CONTENT_TYPE
enum	MAXRECORDS
enum	MAXIDS
enum	TOKEN_VALID
enum	TOKEN_PREFIX
Variables
	$identifyResponse = array()
	$compression = null

---

Detailed Description

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.

The response may may be compressed for better performace:

• 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.

Some other used variables:

• $adminEmail: the e-mail addresses of administrators of the repository.

• $repositoryIdentifier : 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: http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm.

• $SETS: An array with key words . List of supported SETs.

• $METADATAFORMATS: 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.
  • metadataPrefix
  • schema
  • metadataNamespace
  • myhandler
  • other optional items: record_prefix, record_namespace and etc.

• $SQL: Settings for database and queries from database

• $DSN: DSN for connecting your database. Reference PDO for details.

The rest of settings will not normally need to be adjusted. Read source code for details.

---

Constant Documentation

enum SHOW_QUERY_ERROR

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.

enum CONTENT_TYPE

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".

enum MAXRECORDS

Maximum mumber of the records to deliver (verb is ListRecords) If there are more records to deliver a ResumptionToken will be generated.

enum MAXIDS

Maximum mumber of identifiers to deliver (verb is ListIdentifiers) If there are more identifiers to deliver a ResumptionToken will be generated.

enum TOKEN_VALID

After 24 hours resumptionTokens become invalid. Unit is second.

enum TOKEN_PREFIX

Where token is saved and path is included

---

Variable Documentation

$identifyResponse = array()

Identifier settings. It needs to have proper values to reflect the settings of the data provider.

• $identifyResponse['repositoryName'] : compulsory. A human readable name for the repository;
• $identifyResponse['baseURL'] : compulsory. The base URL of the repository;
• $identifyResponse['protocolVersion'] : compulsory. The version of the OAI-PMH supported by the repository;
• $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.
• $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.
• $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.

$compression = null

Compression methods supported. Optional (multiple). Default: null.

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