Inheritance diagram for SubscriptionType:

Public Member Functions
	getCost ()

	getCurrencyCodeAlpha ()

	getCurrencyString ()

	getCurrencyStringShort ()

	getDescription ($locale)

	getDisablePublicDisplay ()

	getDuration ()

	getDurationYearsMonths ($locale=null)

	getFormat ()

	getFormatString ()

	getInstitutional ()

	getJournalId ()

	getLocalizedDescription ()

	getLocalizedName ()

	getMembership ()

	getName ($locale)

	getNonExpiring ()

	getSequence ()

	getSummaryString ()

	setCost ($cost)

	setCurrencyCodeAlpha ($currencyCodeAlpha)

	setDescription ($description, $locale)

	setDisablePublicDisplay ($disablePublicDisplay)

	setDuration ($duration)

	setFormat ($format)

	setInstitutional ($institutional)

	setJournalId ($journalId)

	setMembership ($membership)

	setName ($name, $locale)

	setSequence ($sequence)

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

Definition at line 25 of file SubscriptionType.inc.php.

Member Function Documentation

◆ getCost()

SubscriptionType::getCost ( )

Get subscription type cost.

Returns: float

Definition at line 102 of file SubscriptionType.inc.php.

References DataObject\getData().

Referenced by getSummaryString().

◆ getCurrencyCodeAlpha()

SubscriptionType::getCurrencyCodeAlpha ( )

Get subscription type currency code.

Returns: string

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

References DataObject\getData().

◆ getCurrencyString()

SubscriptionType::getCurrencyString ( )

Get subscription type currency string.

Returns: string

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

References DataObject\getData().

◆ getCurrencyStringShort()

SubscriptionType::getCurrencyStringShort ( )

Get subscription type currency abbreviated string.

Returns: int

Definition at line 144 of file SubscriptionType.inc.php.

References DataObject\getData().

Referenced by getSummaryString().

◆ getDescription()

SubscriptionType::getDescription ( $locale )

Get subscription type description.

Parameters

$locale string

Returns: string

Definition at line 85 of file SubscriptionType.inc.php.

References DataObject\getData().

◆ getDisablePublicDisplay()

SubscriptionType::getDisablePublicDisplay ( )

Check if this subscription type should be publicly visible.

Returns: boolean

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

References DataObject\getData().

◆ getDuration()

SubscriptionType::getDuration ( )

Get subscription type duration.

Returns: int

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

References DataObject\getData().

Referenced by getDurationYearsMonths(), and getNonExpiring().

◆ getDurationYearsMonths()

SubscriptionType::getDurationYearsMonths ( $locale = null )

Get subscription type duration in years and months.

Parameters

$locale string

Returns: string

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

References getDuration().

Referenced by getSummaryString().

◆ getFormat()

SubscriptionType::getFormat ( )

Get subscription type format.

Returns: int

Definition at line 209 of file SubscriptionType.inc.php.

References DataObject\getData().

◆ getFormatString()

SubscriptionType::getFormatString ( )

Get subscription type format locale key.

Returns: string

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

References DataObject\getData().

◆ getInstitutional()

SubscriptionType::getInstitutional ( )

Check if this subscription type is for an institution.

Returns: boolean

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

References DataObject\getData().

◆ getJournalId()

SubscriptionType::getJournalId ( )

Get the journal ID of the subscription type.

Returns: int

Definition at line 34 of file SubscriptionType.inc.php.

References DataObject\getData().

◆ getLocalizedDescription()

SubscriptionType::getLocalizedDescription ( )

Get the localized subscription type description

Returns: string

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

References DataObject\getLocalizedData().

◆ getLocalizedName()

SubscriptionType::getLocalizedName ( )

Get the localized subscription type name

Returns: string

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

References DataObject\getLocalizedData().

Referenced by getSummaryString().

◆ getMembership()

SubscriptionType::getMembership ( )

Check if this subscription type requires a membership.

Returns: boolean

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

References DataObject\getData().

◆ getName()

SubscriptionType::getName ( $locale )

Get subscription type name.

Parameters

$locale string

Returns: string

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

References DataObject\getData().

◆ getNonExpiring()

SubscriptionType::getNonExpiring ( )

Get subscription type nonExpiring.

Returns: boolean

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

References getDuration().

◆ getSequence()

SubscriptionType::getSequence ( )

Get subscription type display sequence.

Returns: float

Definition at line 290 of file SubscriptionType.inc.php.

References DataObject\getData().

◆ getSummaryString()

SubscriptionType::getSummaryString ( )

Get subscription type summary in the form: TypeName - Duration - Cost (CurrencyShort).

Returns: string

Definition at line 306 of file SubscriptionType.inc.php.

References getCost(), getCurrencyStringShort(), DAORegistry\getDAO(), getDurationYearsMonths(), and getLocalizedName().

◆ setCost()

SubscriptionType::setCost ( $cost )

Set subscription type cost.

Parameters

$cost float

Definition at line 110 of file SubscriptionType.inc.php.

References DataObject\setData().

◆ setCurrencyCodeAlpha()

SubscriptionType::setCurrencyCodeAlpha ( $currencyCodeAlpha )

Set subscription type currency code.

Parameters

$currencyCodeAlpha string

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

References DataObject\setData().

◆ setDescription()

SubscriptionType::setDescription	(	$description,
		$locale
	)

Set subscription type description.

Parameters

$description	string
$locale	string

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

References DataObject\setData().

◆ setDisablePublicDisplay()

SubscriptionType::setDisablePublicDisplay ( $disablePublicDisplay )

Set whether or not this subscription type should be publicly visible.

Parameters

$disablePublicDisplay boolean

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

References DataObject\setData().

◆ setDuration()

SubscriptionType::setDuration ( $duration )

Set subscription type duration.

Parameters

$duration int

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

References DataObject\setData().

◆ setFormat()

SubscriptionType::setFormat ( $format )

Set subscription type format.

Parameters

$format int

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

References DataObject\setData().

◆ setInstitutional()

SubscriptionType::setInstitutional ( $institutional )

Set whether or not this subscription type is for an institution.

Parameters

$institutional boolean

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

References DataObject\setData().

◆ setJournalId()

SubscriptionType::setJournalId ( $journalId )

Set the journal ID of the subscription type.

Parameters

$journalId int

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

References DataObject\setData().

◆ setMembership()

SubscriptionType::setMembership ( $membership )

Set whether or not this subscription type requires a membership.

Parameters

$membership boolean

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

References DataObject\setData().

◆ setName()

SubscriptionType::setName	(	$name,
		$locale
	)

Set subscription type name.

Parameters

$name	string
$locale	string

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

References DataObject\setData().

◆ setSequence()

SubscriptionType::setSequence ( $sequence )

Set subscription type display sequence.

Parameters

$sequence float

Definition at line 298 of file SubscriptionType.inc.php.

References DataObject\setData().

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

SubscriptionType.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCost()

◆ getCurrencyCodeAlpha()

◆ getCurrencyString()

◆ getCurrencyStringShort()

◆ getDescription()

◆ getDisablePublicDisplay()

◆ getDuration()

◆ getDurationYearsMonths()

◆ getFormat()

◆ getFormatString()

◆ getInstitutional()

◆ getJournalId()

◆ getLocalizedDescription()

◆ getLocalizedName()

◆ getMembership()

◆ getName()

◆ getNonExpiring()

◆ getSequence()

◆ getSummaryString()

◆ setCost()

◆ setCurrencyCodeAlpha()

◆ setDescription()

◆ setDisablePublicDisplay()

◆ setDuration()

◆ setFormat()

◆ setInstitutional()

◆ setJournalId()

◆ setMembership()

◆ setName()

◆ setSequence()