Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Subscription Class Reference
Inheritance diagram for Subscription:
DataObject IndividualSubscription InstitutionalSubscription

Public Member Functions

 getDateEnd ()
 
 getDateStart ()
 
 getJournalId ()
 
 getMembership ()
 
 getNotes ()
 
 getReferenceNumber ()
 
 getStatus ()
 
 getStatusString ()
 
 getSubscriptionId ()
 
 getSubscriptionTypeInstitutional ()
 
 getSubscriptionTypeName ()
 
 getSubscriptionTypeSummaryString ()
 
 getTypeId ()
 
 getUserEmail ()
 
 getUserFullName ()
 
 getUserId ()
 
 isExpired ()
 
 isNonExpiring ()
 
 isValid ($check=SUBSCRIPTION_DATE_BOTH, $checkDate=null)
 
 setDateEnd ($dateEnd)
 
 setDateStart ($dateStart)
 
 setJournalId ($journalId)
 
 setMembership ($membership)
 
 setNotes ($notes)
 
 setReferenceNumber ($referenceNumber)
 
 setStatus ($status)
 
 setSubscriptionId ($subscriptionId)
 
 setTypeId ($typeId)
 
 setUserId ($userId)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Basic class describing a subscription.

See Also
SubscriptionDAO

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

Member Function Documentation

Subscription::getDateEnd ( )

Get subscription end date.

Returns
date (YYYY-MM-DD)

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

References DataObject\getData().

Subscription::getDateStart ( )

Get subscription start date.

Returns
date (YYYY-MM-DD)

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

References DataObject\getData().

Subscription::getJournalId ( )

Get the journal ID of the subscription.

Returns
int

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

References DataObject\getData().

Subscription::getMembership ( )

Get subscription membership.

Returns
string

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

References DataObject\getData().

Subscription::getNotes ( )

Get subscription notes.

Returns
string

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

References DataObject\getData().

Subscription::getReferenceNumber ( )

Get subscription reference number.

Returns
string

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

References DataObject\getData().

Subscription::getStatus ( )

Get subscription status.

Returns
int

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

References DataObject\getData().

Subscription::getStatusString ( )

Get subscription status string.

Returns
int

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

References DataObject\getData().

Subscription::getSubscriptionId ( )

Get the ID of the subscription.

Returns
int

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

References DataObject\getId(), and Config\getVar().

Subscription::getSubscriptionTypeInstitutional ( )

Get the subscription type institutional flag for the subscription.

Returns
string

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

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

Subscription::getSubscriptionTypeName ( )

Get the subscription type name of the subscription.

Returns
string

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

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

Subscription::getSubscriptionTypeSummaryString ( )

Get the subscription type name of the subscription.

Returns
string

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

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

Subscription::getTypeId ( )

Get the subscription type ID of the subscription.

Returns
int

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

References DataObject\getData().

Subscription::getUserEmail ( )

Get the user's email of the subscription.

Returns
string

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

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

Subscription::getUserFullName ( )

Get the user's full name of the subscription.

Returns
string

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

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

Subscription::getUserId ( )

Get the user ID of the subscription.

Returns
int

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

References DataObject\getData().

Subscription::isExpired ( )

Check whether subscription is expired

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

References DataObject\getData().

Subscription::isNonExpiring ( )

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

Returns
string

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

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

Subscription::isValid (   $check = SUBSCRIPTION_DATE_BOTH,
  $checkDate = null 
)

Check whether subscription is valid

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

Subscription::setDateEnd (   $dateEnd)

Set subscription end date.

Parameters
$dateEnddate (YYYY-MM-DD)

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

References DataObject\setData().

Subscription::setDateStart (   $dateStart)

Set subscription start date.

Parameters
$dateStartdate (YYYY-MM-DD)

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

References DataObject\setData().

Subscription::setJournalId (   $journalId)

Set the journal ID of the subscription.

Parameters
$journalIdint

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

References DataObject\setData().

Subscription::setMembership (   $membership)

Set subscription membership.

Parameters
$membershipstring

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

References DataObject\setData().

Subscription::setNotes (   $notes)

Set subscription notes.

Parameters
$notesstring

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

References DataObject\setData().

Subscription::setReferenceNumber (   $referenceNumber)

Set subscription reference number.

Parameters
$referenceNumberstring

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

References DataObject\setData().

Subscription::setStatus (   $status)

Set subscription status.

Parameters
$statusint

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

References DataObject\setData().

Subscription::setSubscriptionId (   $subscriptionId)

Set the ID of the subscription.

Parameters
$subscriptionIdint

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

References Config\getVar(), and DataObject\setId().

Subscription::setTypeId (   $typeId)

Set the subscription type ID of the subscription.

Parameters
$typeIdint

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

References DataObject\setData().

Subscription::setUserId (   $userId)

Set the user ID of the subscription.

Parameters
$userIdint

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

References DataObject\setData().


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