Open Journal Systems  3.3.0
Subscription Class Reference
Inheritance diagram for Subscription:
DataObject IndividualSubscription InstitutionalSubscription

Public Member Functions

 getDateEnd ()
 
 getDateStart ()
 
 getJournalId ()
 
 getMembership ()
 
 getNotes ()
 
 getReferenceNumber ()
 
 getStatus ()
 
 getStatusString ()
 
 getSubscriptionTypeInstitutional ()
 
 getSubscriptionTypeName ()
 
 getSubscriptionTypeSummaryString ()
 
 getTypeId ()
 
 getUserEmail ()
 
 getUserFullName ()
 
 getUserId ()
 
 isExpired ()
 
 isNonExpiring ()
 
 setDateEnd ($dateEnd)
 
 setDateStart ($dateStart)
 
 setJournalId ($journalId)
 
 setMembership ($membership)
 
 setNotes ($notes)
 
 setReferenceNumber ($referenceNumber)
 
 setStatus ($status)
 
 setTypeId ($typeId)
 
 setUserId ($userId)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Basic class describing a subscription.

See also
SubscriptionDAO

Definition at line 32 of file Subscription.inc.php.

Member Function Documentation

◆ getDateEnd()

Subscription::getDateEnd ( )

Get subscription end date.

Returns
date (YYYY-MM-DD)

Definition at line 162 of file Subscription.inc.php.

References DataObject\getData().

◆ getDateStart()

Subscription::getDateStart ( )

Get subscription start date.

Returns
date (YYYY-MM-DD)

Definition at line 146 of file Subscription.inc.php.

References DataObject\getData().

◆ getJournalId()

Subscription::getJournalId ( )

Get the journal ID of the subscription.

Returns
int

Definition at line 42 of file Subscription.inc.php.

References DataObject\getData().

◆ getMembership()

Subscription::getMembership ( )

Get subscription membership.

Returns
string

Definition at line 217 of file Subscription.inc.php.

References DataObject\getData().

◆ getNotes()

Subscription::getNotes ( )

Get subscription notes.

Returns
string

Definition at line 249 of file Subscription.inc.php.

References DataObject\getData().

◆ getReferenceNumber()

Subscription::getReferenceNumber ( )

Get subscription reference number.

Returns
string

Definition at line 233 of file Subscription.inc.php.

References DataObject\getData().

◆ getStatus()

Subscription::getStatus ( )

Get subscription status.

Returns
int SUBSCRIPTION_STATUS_...

Definition at line 178 of file Subscription.inc.php.

References DataObject\getData().

◆ getStatusString()

Subscription::getStatusString ( )

Get subscription status string.

Returns
string

Definition at line 194 of file Subscription.inc.php.

References DataObject\getData().

◆ getSubscriptionTypeInstitutional()

Subscription::getSubscriptionTypeInstitutional ( )

Get the subscription type institutional flag for the subscription.

Returns
string

Definition at line 127 of file Subscription.inc.php.

References DAORegistry\getDAO(), and DataObject\getData().

◆ getSubscriptionTypeName()

Subscription::getSubscriptionTypeName ( )

Get the subscription type name of the subscription.

Returns
string

Definition at line 108 of file Subscription.inc.php.

References DAORegistry\getDAO(), and DataObject\getData().

◆ getSubscriptionTypeSummaryString()

Subscription::getSubscriptionTypeSummaryString ( )

Get the subscription type name of the subscription.

Returns
string

Definition at line 117 of file Subscription.inc.php.

References DAORegistry\getDAO(), and DataObject\getData().

◆ getTypeId()

Subscription::getTypeId ( )

Get the subscription type ID of the subscription.

Returns
int

Definition at line 92 of file Subscription.inc.php.

References DataObject\getData().

Referenced by isNonExpiring().

◆ getUserEmail()

Subscription::getUserEmail ( )

Get the user's email of the subscription.

Returns
string

Definition at line 83 of file Subscription.inc.php.

References DAORegistry\getDAO(), and DataObject\getData().

◆ getUserFullName()

Subscription::getUserFullName ( )

Get the user's full name of the subscription.

Returns
string

Definition at line 74 of file Subscription.inc.php.

References DAORegistry\getDAO(), and DataObject\getData().

◆ getUserId()

Subscription::getUserId ( )

Get the user ID of the subscription.

Returns
int

Definition at line 58 of file Subscription.inc.php.

References DataObject\getData().

◆ isExpired()

Subscription::isExpired ( )

Check whether subscription is expired

Returns
boolean

Definition at line 265 of file Subscription.inc.php.

References DataObject\getData().

◆ isNonExpiring()

Subscription::isNonExpiring ( )

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

Returns
boolean

Definition at line 136 of file Subscription.inc.php.

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

◆ setDateEnd()

Subscription::setDateEnd (   $dateEnd)

Set subscription end date.

Parameters
$dateEnddate (YYYY-MM-DD)

Definition at line 170 of file Subscription.inc.php.

References DataObject\setData().

◆ setDateStart()

Subscription::setDateStart (   $dateStart)

Set subscription start date.

Parameters
$dateStartdate (YYYY-MM-DD)

Definition at line 154 of file Subscription.inc.php.

References DataObject\setData().

◆ setJournalId()

Subscription::setJournalId (   $journalId)

Set the journal ID of the subscription.

Parameters
$journalIdint

Definition at line 50 of file Subscription.inc.php.

References DataObject\setData().

◆ setMembership()

Subscription::setMembership (   $membership)

Set subscription membership.

Parameters
$membershipstring

Definition at line 225 of file Subscription.inc.php.

References DataObject\setData().

◆ setNotes()

Subscription::setNotes (   $notes)

Set subscription notes.

Parameters
$notesstring

Definition at line 257 of file Subscription.inc.php.

References DataObject\setData().

◆ setReferenceNumber()

Subscription::setReferenceNumber (   $referenceNumber)

Set subscription reference number.

Parameters
$referenceNumberstring

Definition at line 241 of file Subscription.inc.php.

References DataObject\setData().

◆ setStatus()

Subscription::setStatus (   $status)

Set subscription status.

Parameters
$statusint SUBSCRIPTION_STATUS_...

Definition at line 186 of file Subscription.inc.php.

References DataObject\setData().

◆ setTypeId()

Subscription::setTypeId (   $typeId)

Set the subscription type ID of the subscription.

Parameters
$typeIdint

Definition at line 100 of file Subscription.inc.php.

References DataObject\setData().

◆ setUserId()

Subscription::setUserId (   $userId)

Set the user ID of the subscription.

Parameters
$userIdint

Definition at line 66 of file Subscription.inc.php.

References DataObject\setData().


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