SetLoader
in package
Uses
WriterAwareTrait
OAI-PMH Harvest Tool
Tags
Table of Contents
- $communicator : Communicator
- Low-level OAI-PMH communicator
- $outputWriter : WriterInterface
- Writer helper
- __construct() : mixed
- Constructor.
- getNames() : array<string|int, mixed>
- Load set list from the server.
- setOutputWriter() : void
- Set an object to accept console output messages.
- sendRequest() : object
- Make an OAI-PMH request. Die if there is an error; return a SimpleXML object on success.
- write() : void
- Write a string to the console output writer (if set).
- writeLine() : void
- Write a string w/newline to the console output writer (if set).
Properties
$communicator
Low-level OAI-PMH communicator
protected
Communicator
$communicator
$outputWriter
Writer helper
protected
WriterInterface
$outputWriter
= null
Methods
__construct()
Constructor.
public
__construct(Communicator $communicator) : mixed
Parameters
- $communicator : Communicator
-
Low-level API client
Return values
mixed —getNames()
Load set list from the server.
public
getNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —setOutputWriter()
Set an object to accept console output messages.
public
setOutputWriter(WriterInterface $writer) : void
Parameters
- $writer : WriterInterface
-
Writer object
Return values
void —sendRequest()
Make an OAI-PMH request. Die if there is an error; return a SimpleXML object on success.
protected
sendRequest(string $verb[, array<string|int, mixed> $params = [] ]) : object
Parameters
- $verb : string
-
OAI-PMH verb to execute.
- $params : array<string|int, mixed> = []
-
GET parameters for ListRecords method.
Return values
object —SimpleXML-formatted response.
write()
Write a string to the console output writer (if set).
protected
write(string $str) : void
Parameters
- $str : string
-
String to write.
Return values
void —writeLine()
Write a string w/newline to the console output writer (if set).
protected
writeLine(string $str) : void
Parameters
- $str : string
-
String to write.