Issue Class Reference

Inheritance diagram for Issue:

Public Member Functions
	getAccessStatus ()
	getBestIssueId ()
	getCoverImage ($locale)
	getCoverImageAltText ($locale)
	getCoverImageUrls ()
	getCurrent ()
	getDAO ()
	getDateNotified ()
	getDatePublished ()
	getDescription ($locale)
	getIssueIdentification ($force=array(), $locale=null)
	getIssueSeries ()
	getJournalId ()
	getLastModified ()
	getLocalizedCoverImage ()
	getLocalizedCoverImageAltText ()
	getLocalizedCoverImageUrl ()
	getLocalizedDescription ()
	getLocalizedTitle ()
	getNumArticles ()
	getNumber ()
	getOpenAccessDate ()
	getPublished ()
	getShowNumber ()
	getShowTitle ()
	getShowVolume ()
	getShowYear ()
	getStoredPubId ($pubIdType)
	getTitle ($locale)
	getVolume ()
	getYear ()
	hasDescription ()
	setAccessStatus ($accessStatus)
	setCoverImage ($coverImage, $locale)
	setCoverImageAltText ($coverImageAltText, $locale)
	setCurrent ($current)
	setDateNotified ($dateNotified)
	setDatePublished ($datePublished)
	setDescription ($description, $locale)
	setJournalId ($journalId)
	setLastModified ($lastModified)
	setNumber ($number)
	setOpenAccessDate ($openAccessDate)
	setPublished ($published)
	setShowNumber ($showNumber)
	setShowTitle ($showTitle)
	setShowVolume ($showVolume)
	setShowYear ($showYear)
	setStoredPubId ($pubIdType, $pubId)
	setTitle ($title, $locale)
	setVolume ($volume)
	setYear ($year)
	stampModified ()
Public Member Functions inherited from DataObject
	__construct ()
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
&	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

Class for Issue.

See also

IssueDAO

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

Member Function Documentation

getAccessStatus()

Issue::getAccessStatus

(

)

get access status (ISSUE_ACCESS_...)

Returns

int

Definition at line 207 of file Issue.inc.php.

References DataObject\getData().

Referenced by APP\Services\IssueService\userHasAccessToGalleys().

getBestIssueId()

Issue::getBestIssueId

(

)

Return the "best" issue ID – If a public issue ID is set, use it; otherwise use the internal issue Id.

Returns

string

Definition at line 541 of file Issue.inc.php.

References DataObject\getData(), and DataObject\getId().

getCoverImage()

Issue::getCoverImage

(

$locale

)

Get issue cover image file name

Parameters

$locale

string

Returns

string|array

Definition at line 360 of file Issue.inc.php.

References DataObject\getData().

Referenced by getCoverImageUrls().

getCoverImageAltText()

Issue::getCoverImageAltText

(

$locale

)

Get issue cover image alternate text

Parameters

$locale

string

Returns

string

Definition at line 386 of file Issue.inc.php.

References DataObject\getData().

getCoverImageUrls()

Issue::getCoverImageUrls

(

)

Get the full URL to all localized cover images

Returns

array

Definition at line 414 of file Issue.inc.php.

References PKPApplication\get(), and getCoverImage().

getCurrent()

Issue::getCurrent

(

)

get current

Returns

int

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

References DataObject\getData().

getDAO()

Issue::getDAO

(

)

Get DAO class name for this object.

Returns

DAO

Reimplemented from DataObject.

Definition at line 559 of file Issue.inc.php.

References DAORegistry\getDAO().

getDateNotified()

Issue::getDateNotified

(

)

get date the users were last notified

Returns

date

Definition at line 168 of file Issue.inc.php.

References DataObject\getData().

getDatePublished()

Issue::getDatePublished

(

)

get date published

Returns

date

Definition at line 152 of file Issue.inc.php.

References DataObject\getData().

getDescription()

Issue::getDescription

(

$locale

)

get description

Parameters

$locale

string

Returns

string

Definition at line 248 of file Issue.inc.php.

References DataObject\getData().

getIssueIdentification()

Issue::getIssueIdentification	(		$force = array(),
			$locale = null
	)

Return the string of the issue identification based label format

Parameters

$force	array force show/hide of data components
$locale	string use spcific non-default locale

Returns

string

Definition at line 448 of file Issue.inc.php.

References DataObject\getData(), AppLocale\getLocale(), getLocalizedTitle(), getTitle(), AppLocale\requireComponents(), and PKPLocale\translate().

Referenced by getIssueSeries().

getIssueSeries()

Issue::getIssueSeries

(

)

Return the string of the issue series identification eg: Vol 1 No 1 (2000)

Returns

string

Definition at line 520 of file Issue.inc.php.

References getIssueIdentification(), getShowNumber(), getShowVolume(), and getShowYear().

getJournalId()

Issue::getJournalId

(

)

get journal id

Returns

int

Definition at line 30 of file Issue.inc.php.

References DataObject\getData().

Referenced by getLocalizedCoverImageUrl().

getLastModified()

Issue::getLastModified

(

)

get date the issue was last modified

Returns

date

Definition at line 184 of file Issue.inc.php.

References DataObject\getData().

getLocalizedCoverImage()

Issue::getLocalizedCoverImage

(

)

Get the localized issue cover image file name

Returns

string

Definition at line 351 of file Issue.inc.php.

References DataObject\getLocalizedData().

Referenced by getLocalizedCoverImageUrl().

getLocalizedCoverImageAltText()

Issue::getLocalizedCoverImageAltText

(

)

Get the localized issue cover image alternate text

Returns

string

Definition at line 377 of file Issue.inc.php.

References DataObject\getLocalizedData().

getLocalizedCoverImageUrl()

Issue::getLocalizedCoverImageUrl

(

)

Get a full URL to the localized cover image

Returns

string

Definition at line 395 of file Issue.inc.php.

References PKPApplication\get(), getJournalId(), and getLocalizedCoverImage().

getLocalizedDescription()

Issue::getLocalizedDescription

(

)

Get the localized description

Returns

string

Definition at line 239 of file Issue.inc.php.

References DataObject\getLocalizedData().

Referenced by hasDescription().

getLocalizedTitle()

Issue::getLocalizedTitle

(

)

Get the localized title

Returns

string

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

References DataObject\getLocalizedData().

Referenced by getIssueIdentification().

getNumArticles()

Issue::getNumArticles

(

)

Get number of articles in this issue.

Returns

int

Definition at line 531 of file Issue.inc.php.

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

getNumber()

Issue::getNumber

(

)

get number

Returns

string

Definition at line 88 of file Issue.inc.php.

References DataObject\getData().

getOpenAccessDate()

Issue::getOpenAccessDate

(

)

get open access date

Returns

date

Definition at line 223 of file Issue.inc.php.

References DataObject\getData().

getPublished()

Issue::getPublished

(

)

get published

Returns

int

Definition at line 120 of file Issue.inc.php.

References DataObject\getData().

getShowNumber()

Issue::getShowNumber

(

)

get show issue number

Returns

int

Definition at line 303 of file Issue.inc.php.

References DataObject\getData().

Referenced by getIssueSeries().

getShowTitle()

Issue::getShowTitle

(

)

get show issue title

Returns

int

Definition at line 335 of file Issue.inc.php.

References DataObject\getData().

getShowVolume()

Issue::getShowVolume

(

)

get show issue volume

Returns

int

Definition at line 287 of file Issue.inc.php.

References DataObject\getData().

Referenced by getIssueSeries().

getShowYear()

Issue::getShowYear

(

)

get show issue year

Returns

int

Definition at line 319 of file Issue.inc.php.

References DataObject\getData().

Referenced by getIssueSeries().

getStoredPubId()

Issue::getStoredPubId

(

$pubIdType

)

Get stored public ID of the issue.

Parameters

$pubIdType

string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).

Returns

string

Definition at line 268 of file Issue.inc.php.

References DataObject\getData().

getTitle()

Issue::getTitle

(

$locale

)

get title

Parameters

$locale

string

Returns

string

Definition at line 55 of file Issue.inc.php.

References DataObject\getData().

Referenced by getIssueIdentification().

getVolume()

Issue::getVolume

(

)

get volume

Returns

int

Definition at line 72 of file Issue.inc.php.

References DataObject\getData().

getYear()

Issue::getYear

(

)

get year

Returns

int

Definition at line 104 of file Issue.inc.php.

References DataObject\getData().

hasDescription()

Issue::hasDescription

(

)

Check whether a description exists for this issue

Returns

bool

Definition at line 551 of file Issue.inc.php.

References getLocalizedDescription().

setAccessStatus()

Issue::setAccessStatus

(

$accessStatus

)

set access status (ISSUE_ACCESS_...)

Parameters

$accessStatus

int

Definition at line 215 of file Issue.inc.php.

References DataObject\setData().

setCoverImage()

Issue::setCoverImage	(		$coverImage,
			$locale
	)

Set issue cover image file name

Parameters

$coverImage	string|array
$locale	string

Definition at line 369 of file Issue.inc.php.

References DataObject\setData().

setCoverImageAltText()

Issue::setCoverImageAltText	(		$coverImageAltText,
			$locale
	)

Set issue cover image alternate text

Parameters

$coverImageAltText	string
$locale	string

Definition at line 438 of file Issue.inc.php.

References DataObject\setData().

setCurrent()

Issue::setCurrent

(

$current

)

set current

Parameters

$current

int

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

References DataObject\setData().

setDateNotified()

Issue::setDateNotified

(

$dateNotified

)

set date the users were last notified

Parameters

$dateNotified

date

Definition at line 176 of file Issue.inc.php.

References DataObject\setData().

setDatePublished()

Issue::setDatePublished

(

$datePublished

)

set date published

Parameters

$datePublished

date

Definition at line 160 of file Issue.inc.php.

References DataObject\setData().

setDescription()

Issue::setDescription	(		$description,
			$locale
	)

set description

Parameters

$description	string
$locale	string

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

References DataObject\setData().

setJournalId()

Issue::setJournalId

(

$journalId

)

set journal id

Parameters

$journalId

int

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

References DataObject\setData().

setLastModified()

Issue::setLastModified

(

$lastModified

)

set date the issue was last modified

Parameters

$lastModified

date

Definition at line 192 of file Issue.inc.php.

References DataObject\setData().

Referenced by stampModified().

setNumber()

Issue::setNumber

(

$number

)

set number

Parameters

$number

string

Definition at line 96 of file Issue.inc.php.

References DataObject\setData().

setOpenAccessDate()

Issue::setOpenAccessDate

(

$openAccessDate

)

set open access date

Parameters

$openAccessDate

date

Definition at line 231 of file Issue.inc.php.

References DataObject\setData().

setPublished()

Issue::setPublished

(

$published

)

set published

Parameters

$published

int

Definition at line 128 of file Issue.inc.php.

References DataObject\setData().

setShowNumber()

Issue::setShowNumber

(

$showNumber

)

set show issue number

Parameters

$showNumber

int

Definition at line 311 of file Issue.inc.php.

References DataObject\setData().

setShowTitle()

Issue::setShowTitle

(

$showTitle

)

set show issue title

Parameters

$showTitle

int

Definition at line 343 of file Issue.inc.php.

References DataObject\setData().

setShowVolume()

Issue::setShowVolume

(

$showVolume

)

set show issue volume

Parameters

$showVolume

int

Definition at line 295 of file Issue.inc.php.

References DataObject\setData().

setShowYear()

Issue::setShowYear

(

$showYear

)

set show issue year

Parameters

$showYear

int

Definition at line 327 of file Issue.inc.php.

References DataObject\setData().

setStoredPubId()

Issue::setStoredPubId	(		$pubIdType,
			$pubId
	)

Set stored public issue id.

Parameters

$pubIdType	string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).
$pubId	string

Definition at line 279 of file Issue.inc.php.

References DataObject\setData().

setTitle()

Issue::setTitle	(		$title,
			$locale
	)

set title

Parameters

$title	string
$locale	string

Definition at line 64 of file Issue.inc.php.

References DataObject\setData().

setVolume()

Issue::setVolume

(

$volume

)

set volume

Parameters

$volume

int

Definition at line 80 of file Issue.inc.php.

References DataObject\setData().

setYear()

Issue::setYear

(

$year

)

set year

Parameters

$year

int

Definition at line 112 of file Issue.inc.php.

References DataObject\setData().

stampModified()

Issue::stampModified

(

)

Stamp the date of the last modification to the current time.

Definition at line 199 of file Issue.inc.php.

References Core\getCurrentDate(), and setLastModified().

---

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

• Issue.inc.php