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

Public Member Functions

 getDomain ()
 
 getInstitutionMailingAddress ()
 
 getInstitutionName ()
 
 getIPRanges ()
 
 getIPRangesString ()
 
 isValid ($domain, $IP, $check=SUBSCRIPTION_DATE_BOTH, $checkDate=null)
 
 setDomain ($domain)
 
 setInstitutionMailingAddress ($mailingAddress)
 
 setInstitutionName ($institutionName)
 
 setIPRanges ($ipRanges)
 
- Public Member Functions inherited from Subscription
 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 an institutional subscription.

See also
InstitutionalSubscriptionDAO

Definition at line 28 of file InstitutionalSubscription.inc.php.

Member Function Documentation

◆ getDomain()

InstitutionalSubscription::getDomain ( )

Get institutionalSubscription domain string.

Returns
string

Definition at line 70 of file InstitutionalSubscription.inc.php.

References DataObject\getData().

◆ getInstitutionMailingAddress()

InstitutionalSubscription::getInstitutionMailingAddress ( )

Get the mailing address of the institutionalSubscription.

Returns
string

Definition at line 54 of file InstitutionalSubscription.inc.php.

References DataObject\getData().

◆ getInstitutionName()

InstitutionalSubscription::getInstitutionName ( )

Get the institution name of the institutionalSubscription.

Returns
string

Definition at line 38 of file InstitutionalSubscription.inc.php.

References DataObject\getData().

◆ getIPRanges()

InstitutionalSubscription::getIPRanges ( )

Get institutionalSubscription ip ranges.

Returns
array

Definition at line 86 of file InstitutionalSubscription.inc.php.

References DataObject\getData().

◆ getIPRangesString()

InstitutionalSubscription::getIPRangesString ( )

Get institutionalSubscription ip ranges string.

Returns
string

Definition at line 94 of file InstitutionalSubscription.inc.php.

References DataObject\getData().

◆ isValid()

InstitutionalSubscription::isValid (   $domain,
  $IP,
  $check = SUBSCRIPTION_DATE_BOTH,
  $checkDate = null 
)

Check whether subscription is valid

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

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

◆ setDomain()

InstitutionalSubscription::setDomain (   $domain)

Set institutionalSubscription domain string.

Parameters
$domainstring

Definition at line 78 of file InstitutionalSubscription.inc.php.

References DataObject\setData().

◆ setInstitutionMailingAddress()

InstitutionalSubscription::setInstitutionMailingAddress (   $mailingAddress)

Set the mailing address of the institutionalSubscription.

Parameters
$mailingAddressstring

Definition at line 62 of file InstitutionalSubscription.inc.php.

References DataObject\setData().

◆ setInstitutionName()

InstitutionalSubscription::setInstitutionName (   $institutionName)

Set the institution name of the institutionalSubscription.

Parameters
$institutionNamestring

Definition at line 46 of file InstitutionalSubscription.inc.php.

References DataObject\setData().

◆ setIPRanges()

InstitutionalSubscription::setIPRanges (   $ipRanges)

Set institutionalSubscription ip ranges.

Parameters
ipRangesarray

Definition at line 111 of file InstitutionalSubscription.inc.php.

References DataObject\setData().


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