PHP Class OJSSwordDeposit, ojs

Mostrar archivo Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$article Article
$issue Issue
$journal Journal
$outPath path and directory name to use for package creation files
$package deposit METS package
$section Section

Public Methods

Method Description
__construct ( $article ) Constructor.
_addFile ( $file ) Add a file to a package. Used internally.
addEditorial ( ) : boolean Add the single most recent editorial file to the deposit package.
addGalleys ( ) Add all article galleys to the deposit package.
cleanup ( ) Clean up after a deposit, i.e. removing all created files.
createPackage ( ) Build the package.
deposit ( $url, $username, $password ) Deposit the package.
setMetadata ( ) Register the article's metadata with the SWORD deposit.

Method Details

__construct() public method

Create a SWORD deposit object for an OJS article.
public __construct ( $article )
$article Article

_addFile() public method

Add a file to a package. Used internally.
public _addFile ( $file )

addEditorial() public method

Add the single most recent editorial file to the deposit package.
public addEditorial ( ) : boolean
return boolean true iff a file was successfully added to the package

addGalleys() public method

Add all article galleys to the deposit package.
public addGalleys ( )

cleanup() public method

Clean up after a deposit, i.e. removing all created files.
public cleanup ( )

createPackage() public method

Build the package.
public createPackage ( )

deposit() public method

Deposit the package.
public deposit ( $url, $username, $password )
$url string SWORD deposit URL
$username string SWORD deposit username (i.e. email address for DSPACE)
$password string SWORD deposit password

setMetadata() public method

Register the article's metadata with the SWORD deposit.
public setMetadata ( )

Property Details

$article public_oe property

public Article $article
return Article

$issue public_oe property

public Issue $issue
return Issue

$journal public_oe property

public Journal $journal
return Journal

$outPath public_oe property

path and directory name to use for package creation files
public $outPath

$package public_oe property

deposit METS package
public $package

$section public_oe property

public Section $section
return Section