VuFind API Documentation

HarvestOaiCommand extends HarvesterCommand
in package

Console command: VuFind-specific customizations to OAI-PMH harvest command

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

Table of Contents

$pathResolver  : PathResolver
Config file path resolver
__construct()  : mixed
Constructor
checkLocalSetting()  : void
Warn the user if VUFIND_LOCAL_DIR is not set.
execute()  : int
Run the command.

Properties

Methods

__construct()

Constructor

public __construct([Client $client = null ][, string $harvestRoot = null ][, HarvesterFactory $factory = null ][, bool $silent = false ][, string|null $name = null ][, PathResolver $pathResolver = null ]) : mixed
Parameters
$client : Client = null

HTTP client (omit for default)

$harvestRoot : string = null

Root directory for harvesting (omit for default)

$factory : HarvesterFactory = null

Harvester factory (omit for default)

$silent : bool = false

Should we suppress output?

$name : string|null = null

The name of the command; passing null means it must be set in configure()

$pathResolver : PathResolver = null

Config file path resolver

Return values
mixed —

checkLocalSetting()

Warn the user if VUFIND_LOCAL_DIR is not set.

protected checkLocalSetting(OutputInterface $output) : void
Parameters
$output : OutputInterface

Output object

Return values
void —

execute()

Run the command.

protected execute(InputInterface $input, OutputInterface $output) : int
Parameters
$input : InputInterface

Input object

$output : OutputInterface

Output object

Return values
int —

0 for success

Search results