PHP Class OJSCompletedPayment, ojs

Inheritance: extends Payment
Mostrar archivo Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$journalId
$paperId
$payMethod
$timestamp
$type

Public Methods

Method Description
__construct ( ) Constructor
getAssocDescription ( ) : String Get some information about the assocId for display.
getDescription ( ) : string Returns the description of the CompletedPayment.
getJournalId ( ) : integer Get the journal ID of the payment.
getName ( ) : string Returns the description of the CompletedPayment.
getPayMethodPluginName ( ) : String Get the method of payment.
getTimestamp ( ) : integer Get the row id of the payment.
getType ( ) Set the Payment Type
isMembership ( ) : boolean Check if the type is a membership
isSubscription ( ) : boolean Check if the type is a subscription
setJournalId ( $journalId ) Set the journal ID of the payment.
setPayMethodPluginName ( $payMethod ) Set the method of payment.
setTimestamp ( $timestamp ) Set the id of payment
setType ( $type ) Set the Payment Type

Method Details

__construct() public method

Constructor
public __construct ( )

getAssocDescription() public method

Get some information about the assocId for display.
public getAssocDescription ( ) : String
return String

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

getPayMethodPluginName() public method

Get the method of payment.
public getPayMethodPluginName ( ) : String
return String

getTimestamp() public method

Get the row id of the payment.
public getTimestamp ( ) : integer
return integer

getType() public method

Set the Payment Type
public getType ( )

isMembership() public method

Check if the type is a membership
public isMembership ( ) : boolean
return boolean

isSubscription() public method

Check if the type is a subscription
public isSubscription ( ) : boolean
return boolean

setJournalId() public method

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

setPayMethodPluginName() public method

Set the method of payment.
public setPayMethodPluginName ( $payMethod )

setTimestamp() public method

Set the id of payment
public setTimestamp ( $timestamp )

setType() public method

Set the Payment Type
public setType ( $type )
$type int

Property Details

$journalId public_oe property

public $journalId

$paperId public_oe property

public $paperId

$payMethod public_oe property

public $payMethod

$timestamp public_oe property

public $timestamp

$type public_oe property

public $type