Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
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 ()
 
 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 an institutional subscription.

See Also
InstitutionalSubscriptionDAO

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

Member Function Documentation

InstitutionalSubscription::getDomain ( )

Get institutionalSubscription domain string.

Returns
string

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

References DataObject\getData().

InstitutionalSubscription::getInstitutionMailingAddress ( )

Get the mailing address of the institutionalSubscription.

Returns
string

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

References DataObject\getData().

InstitutionalSubscription::getInstitutionName ( )

Get the institution name of the institutionalSubscription.

Returns
string

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

References DataObject\getData().

InstitutionalSubscription::getIPRanges ( )

Get institutionalSubscription ip ranges.

Returns
array

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

References DataObject\getData().

InstitutionalSubscription::getIPRangesString ( )

Get institutionalSubscription ip ranges string.

Returns
string

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

References DataObject\getData().

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

Check whether subscription is valid

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

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

InstitutionalSubscription::setDomain (   $domain)

Set institutionalSubscription domain string.

Parameters
$domainstring

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

References DataObject\setData().

InstitutionalSubscription::setInstitutionMailingAddress (   $mailingAddress)

Set the mailing address of the institutionalSubscription.

Parameters
$mailingAddressstring

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

References DataObject\setData().

InstitutionalSubscription::setInstitutionName (   $institutionName)

Set the institution name of the institutionalSubscription.

Parameters
$institutionNamestring

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

References DataObject\setData().

InstitutionalSubscription::setIPRanges (   $ipRanges)

Set institutionalSubscription ip ranges.

Parameters
ipRangesarray

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

References DataObject\setData().


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