PHP Class OJSQueuedPayment, ojs

Inheritance: extends QueuedPayment
Show file Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$journalId journal ID this payment applies to
$requestUrl URL associated with this payment
$type PAYMENT_TYPE_...

Public Methods

Method Description
__construct ( $amount, $currencyCode, $userId = null, $assocId = null )
getDescription ( ) : string Returns the description of the QueuedPayment.
getJournalId ( ) : integer Get the journal ID of the payment.
getName ( ) : string Returns the name of the QueuedPayment.
getRequestUrl ( ) : string Get the request URL.
getType ( ) : integer Get the type of this payment (PAYMENT_TYPE_.
setJournalId ( $journalId ) Set the journal ID of the payment.
setRequestUrl ( $url ) : string Set the request URL.
setType ( $type ) : integer Set the type for this payment (PAYMENT_TYPE_.

Method Details

__construct() public method

public __construct ( $amount, $currencyCode, $userId = null, $assocId = null )

getDescription() public method

Pulled from Journal Settings if present, or from locale file otherwise. For subscriptions, pulls subscription type name.
public getDescription ( ) : string
return string

getJournalId() public method

Get the journal ID of the payment.
public getJournalId ( ) : integer
return integer

getName() public method

Pulled from Journal Settings if present, or from locale file otherwise. For subscriptions, pulls subscription type name.
public getName ( ) : string
return string

getRequestUrl() public method

Get the request URL.
public getRequestUrl ( ) : string
return string

getType() public method

..)
public getType ( ) : integer
return integer PAYMENT_TYPE_...

setJournalId() public method

Set the journal ID of the payment.
public setJournalId ( $journalId )
$journalId int

setRequestUrl() public method

Set the request URL.
public setRequestUrl ( $url ) : string
$url string
return string New URL

setType() public method

..)
public setType ( $type ) : integer
$type int PAYMENT_TYPE_...
return integer New payment type

Property Details

$journalId public property

journal ID this payment applies to
public $journalId

$requestUrl public property

URL associated with this payment
public $requestUrl

$type public property

PAYMENT_TYPE_...
public $type