Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
OJSSwordDeposit Class Reference

Public Member Functions

 _addFile (&$file)
 
 addEditorial ()
 
 addGalleys ()
 
 cleanup ()
 
 createPackage ()
 
 deposit ($url, $username, $password)
 
 OJSSwordDeposit (&$article)
 
 setMetadata ()
 

Detailed Description

Class providing a SWORD deposit wrapper for OJS articles.

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

Member Function Documentation

OJSSwordDeposit::_addFile ( $file)

Add a file to a package. Used internally.

Definition at line 102 of file OJSSwordDeposit.inc.php.

Referenced by addEditorial(), and addGalleys().

OJSSwordDeposit::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 121 of file OJSSwordDeposit.inc.php.

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

OJSSwordDeposit::addGalleys ( )

Add all article galleys to the deposit package.

Definition at line 111 of file OJSSwordDeposit.inc.php.

References _addFile().

OJSSwordDeposit::cleanup ( )

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

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

OJSSwordDeposit::createPackage ( )

Build the package.

Definition at line 158 of file OJSSwordDeposit.inc.php.

OJSSwordDeposit::deposit (   $url,
  $username,
  $password 
)

Deposit the package.

Parameters
$urlstring SWORD deposit URL
$usernamestring SWORD deposit username (i.e. email address for DSPACE)
$passwordstring SWORD deposit password

Definition at line 168 of file OJSSwordDeposit.inc.php.

OJSSwordDeposit::OJSSwordDeposit ( $article)

Constructor. Create a SWORD deposit object for an OJS article.

Definition at line 40 of file OJSSwordDeposit.inc.php.

References DAORegistry\getDAO().

OJSSwordDeposit::setMetadata ( )

Register the article's metadata with the SWORD deposit.

Definition at line 73 of file OJSSwordDeposit.inc.php.

References PluginRegistry\loadPlugin().


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