PHP Class Subscription, ojs

Author: Faizan Ayubi

Inheritance: extends Shared\Model

Mostrar archivo Open project: pkp/ojs Class Usage Examples

Public Methods

Method	Description
__construct ( )
getDateEnd ( ) : date	Get subscription end date.
getDateStart ( ) : date	Get subscription start date.
getJournalId ( ) : integer	Get the journal ID of the subscription.
getMembership ( ) : string	Get subscription membership.
getNotes ( ) : string	Get subscription notes.
getReferenceNumber ( ) : string	Get subscription reference number.
getStatus ( ) : integer	Get subscription status.
getStatusString ( ) : integer	Get subscription status string.
getSubscriptionTypeInstitutional ( ) : string	Get the subscription type institutional flag for the subscription.
getSubscriptionTypeName ( ) : string	Get the subscription type name of the subscription.
getSubscriptionTypeSummaryString ( ) : string	Get the subscription type name of the subscription.
getTypeId ( ) : integer	Get the subscription type ID of the subscription.
getUserEmail ( ) : string	Get the user's email of the subscription.
getUserFullName ( ) : string	Get the user's full name of the subscription.
getUserId ( ) : integer	Get the user ID of the subscription.
isExpired ( )	Check whether subscription is expired
isNonExpiring ( ) : boolean	Check whether the subscription type is non-expiring for the subscription.
isValid ( $check = SUBSCRIPTION_DATE_BOTH, $checkDate = null )	Check whether subscription is valid
setDateEnd ( $dateEnd )	Set subscription end date.
setDateStart ( $dateStart )	Set subscription start date.
setJournalId ( $journalId )	Set the journal ID of the subscription.
setMembership ( $membership )	Set subscription membership.
setNotes ( $notes )	Set subscription notes.
setReferenceNumber ( $referenceNumber )	Set subscription reference number.
setStatus ( $status )	Set subscription status.
setTypeId ( $typeId )	Set the subscription type ID of the subscription.
setUserId ( $userId )	Set the user ID of the subscription.

Method Details

__construct() public method

public __construct ( )

getDateEnd() public method

Get subscription end date.

public getDateEnd ( ) : date
return	date	(YYYY-MM-DD)

getDateStart() public method

Get subscription start date.

public getDateStart ( ) : date
return	date	(YYYY-MM-DD)

getJournalId() public method

Get the journal ID of the subscription.

public getJournalId ( ) : integer
return	integer

getMembership() public method

Get subscription membership.

public getMembership ( ) : string
return	string

getNotes() public method

Get subscription notes.

public getNotes ( ) : string
return	string

getReferenceNumber() public method

Get subscription reference number.

public getReferenceNumber ( ) : string
return	string

getStatus() public method

Get subscription status.

public getStatus ( ) : integer
return	integer

getStatusString() public method

Get subscription status string.

public getStatusString ( ) : integer
return	integer

getSubscriptionTypeInstitutional() public method

Get the subscription type institutional flag for the subscription.

public getSubscriptionTypeInstitutional ( ) : string
return	string

getSubscriptionTypeName() public method

Get the subscription type name of the subscription.

public getSubscriptionTypeName ( ) : string
return	string

getSubscriptionTypeSummaryString() public method

Get the subscription type name of the subscription.

public getSubscriptionTypeSummaryString ( ) : string
return	string

getTypeId() public method

Get the subscription type ID of the subscription.

public getTypeId ( ) : integer
return	integer

getUserEmail() public method

Get the user's email of the subscription.

public getUserEmail ( ) : string
return	string

getUserFullName() public method

Get the user's full name of the subscription.

public getUserFullName ( ) : string
return	string

getUserId() public method

Get the user ID of the subscription.

public getUserId ( ) : integer
return	integer

isExpired() public method

Check whether subscription is expired

public isExpired ( )

isNonExpiring() public method

Check whether the subscription type is non-expiring for the subscription.

public isNonExpiring ( ) : boolean
return	boolean

isValid() public method

Check whether subscription is valid

public isValid ( $check = SUBSCRIPTION_DATE_BOTH, $checkDate = null )

setDateEnd() public method

Set subscription end date.

public setDateEnd ( $dateEnd )
$dateEnd		date (YYYY-MM-DD)

setDateStart() public method

Set subscription start date.

public setDateStart ( $dateStart )
$dateStart		date (YYYY-MM-DD)

setJournalId() public method

Set the journal ID of the subscription.

public setJournalId ( $journalId )
$journalId		int

setMembership() public method

Set subscription membership.

public setMembership ( $membership )
$membership		string

setNotes() public method

Set subscription notes.

public setNotes ( $notes )
$notes		string

setReferenceNumber() public method

Set subscription reference number.

public setReferenceNumber ( $referenceNumber )
$referenceNumber		string

setStatus() public method

Set subscription status.

public setStatus ( $status )
$status		int

setTypeId() public method

Set the subscription type ID of the subscription.

public setTypeId ( $typeId )
$typeId		int

setUserId() public method

Set the user ID of the subscription.

public setUserId ( $userId )
$userId		int