PKPSwordDeposit Class Reference

Public Member Functions
	__construct ($submission)
	_addFile ($submissionFile)
	addEditorial ()
	addGalleys ()
	cleanup ()
	createPackage ()
	deposit ($url, $username, $password, $apikey=null)
	setMetadata ($request)

Protected Attributes
	$_article = null
	$_context = null
	$_issue = null
	$_outPath = null
	$_package = null
	$_section = null

Detailed Description

Class providing a SWORD deposit wrapper for submissions.

Definition at line 20 of file PKPSwordDeposit.inc.php.

Constructor & Destructor Documentation

__construct()

PKPSwordDeposit::__construct

(

$submission

)

Constructor. Create a SWORD deposit object for a submission

Parameters

$submission

Submission

Definition at line 62 of file PKPSwordDeposit.inc.php.

References DAORegistry\getDAO().

Member Function Documentation

_addFile()

PKPSwordDeposit::_addFile

(

$submissionFile

)

Add a file to a package. Used internally.

Parameters

$submissionFile

SubmissionFile

Definition at line 120 of file PKPSwordDeposit.inc.php.

Referenced by addEditorial(), and addGalleys().

addEditorial()

PKPSwordDeposit::addEditorial

(

)

Add the single most recent editorial file to the deposit package.

Returns

boolean true iff a file was successfully added to the package

Definition at line 139 of file PKPSwordDeposit.inc.php.

References _addFile(), and DAORegistry\getDAO().

addGalleys()

PKPSwordDeposit::addGalleys

(

)

Add all article galleys to the deposit package.

Definition at line 129 of file PKPSwordDeposit.inc.php.

References _addFile().

cleanup()

PKPSwordDeposit::cleanup

(

)

Clean up after a deposit, i.e. removing all created files.

Definition at line 202 of file PKPSwordDeposit.inc.php.

createPackage()

PKPSwordDeposit::createPackage

(

)

Build the package.

Definition at line 173 of file PKPSwordDeposit.inc.php.

deposit()

PKPSwordDeposit::deposit	(		$url,
			$username,
			$password,
			$apikey = null
	)

Deposit the package.

Parameters

$url	string SWORD deposit URL
$username	string SWORD deposit username (i.e. email address for DSPACE)
$password	string SWORD deposit password

Definition at line 183 of file PKPSwordDeposit.inc.php.

setMetadata()

PKPSwordDeposit::setMetadata

(

$request

)

Register the article's metadata with the SWORD deposit.

Parameters

$request

PKPRequest

Definition at line 95 of file PKPSwordDeposit.inc.php.

Field Documentation

$_article

Article PKPSwordDeposit::$_article = null

protected

Definition at line 55 of file PKPSwordDeposit.inc.php.

$_context

Journal PKPSwordDeposit::$_context = null

protected

Definition at line 37 of file PKPSwordDeposit.inc.php.

$_issue

Issue PKPSwordDeposit::$_issue = null

protected

Definition at line 49 of file PKPSwordDeposit.inc.php.

$_outPath

Complete PKPSwordDeposit::$_outPath = null

protected

path and directory name to use for package creation files

Definition at line 31 of file PKPSwordDeposit.inc.php.

$_package

SWORD PKPSwordDeposit::$_package = null

protected

deposit METS package

Definition at line 25 of file PKPSwordDeposit.inc.php.

$_section

Section PKPSwordDeposit::$_section = null

protected

Definition at line 43 of file PKPSwordDeposit.inc.php.

---

The documentation for this class was generated from the following file:

• PKPSwordDeposit.inc.php