|
CWIS Developer Documentation
|
Public Member Functions | |
| OAIClient ($ServerUrl, $Cache=NULL) | |
| Class constructor. More... | |
| ServerUrl ($NewValue=NULL) | |
| Get or set URL of target OAI repository server. More... | |
| MetadataPrefix ($NewValue=NULL) | |
| Get or set metadata schema for records being retrieved. More... | |
| SetSpec ($NewValue="X-NOSETSPECVALUE-X") | |
| Get or set specification of subset of records to be retrieved. More... | |
| GetIdentification () | |
| Retrieve identification information from repository server. More... | |
| GetFormats () | |
| Retrieve list of available metadata formats from repository server. More... | |
| GetRecords ($StartDate=NULL, $EndDate=NULL) | |
| Retrieve records from repository server. More... | |
| GetRecord ($Id) | |
| Get a single record from a repositry server. More... | |
| MoreRecordsAvailable () | |
| Check whether more records are available after last GetRecords(). More... | |
| ResetRecordPointer () | |
| Clear any additional records available after last GetRecords(). More... | |
| SetDebugLevel ($NewLevel) | |
| Set current debug output level. More... | |
Definition at line 38 of file OAIClient.php.
| OAIClient::GetFormats | ( | ) |
Retrieve list of available metadata formats from repository server.
Definition at line 155 of file OAIClient.php.
| OAIClient::GetIdentification | ( | ) |
Retrieve identification information from repository server.
Information is returned as associative array with the following indexes: "Name", "Email", "URL".
Definition at line 125 of file OAIClient.php.
| OAIClient::GetRecord | ( | $Id | ) |
Get a single record from a repositry server.
NOTE: due to the history and politics involved, it is generally preferable to use GetRecords() to pull a full dump from the remote provider and then filter that to get a subset. The thinking here is that pulling in batches will result in fewer queries to the remote, which is kinder to their hardware. Pull single records with caution, when only a small number of them are required.
| mixed | $Id | The unique identifier of the desired record |
Definition at line 260 of file OAIClient.php.
| OAIClient::GetRecords | ( | $StartDate = NULL, |
|
$EndDate = NULL |
|||
| ) |
Retrieve records from repository server.
| string | $StartDate | start of date range for retrieval (optional) |
| string | $EndDate | end of date range for retrieval (optional) |
Definition at line 195 of file OAIClient.php.
References SetSpec().
| OAIClient::MetadataPrefix | ( | $NewValue = NULL | ) |
Get or set metadata schema for records being retrieved.
| string | $NewValue | new metadata prefix (optional) |
Definition at line 94 of file OAIClient.php.
Referenced by OAIClient().

| OAIClient::MoreRecordsAvailable | ( | ) |
Check whether more records are available after last GetRecords().
Definition at line 277 of file OAIClient.php.
| OAIClient::OAIClient | ( | $ServerUrl, | |
$Cache = NULL |
|||
| ) |
Class constructor.
| string | $ServerUrl | URL of target OAI repository server |
| string | $Cache | name of directory to use to store cached content |
Definition at line 48 of file OAIClient.php.
References MetadataPrefix(), ServerUrl(), and SetSpec().
| OAIClient::ResetRecordPointer | ( | ) |
Clear any additional records available after last GetRecords().
Definition at line 285 of file OAIClient.php.
| OAIClient::ServerUrl | ( | $NewValue = NULL | ) |
Get or set URL of target OAI repository server.
| string | $NewValue | new URL of target OAI repository server (optional) |
Definition at line 79 of file OAIClient.php.
Referenced by OAIClient().

| OAIClient::SetDebugLevel | ( | $NewLevel | ) |
Set current debug output level.
| int | $NewLevel | numerical debugging output level (0-9) |
Definition at line 296 of file OAIClient.php.
| OAIClient::SetSpec | ( | $NewValue = "X-NOSETSPECVALUE-X" | ) |
Get or set specification of subset of records to be retrieved.
| string | $NewValue | new set specification (optional) |
Definition at line 109 of file OAIClient.php.
Referenced by GetRecords(), and OAIClient().
