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

Public Member Functions

 getAccessStatus ()
 
 getAuthorString ($lastOnly=false, $separator= ', ')
 
 getBestIssueId ($journal=null)
 
 getCoverPageAltText ($locale)
 
 getCoverPageDescription ($locale)
 
 getCurrent ()
 
 getDateNotified ()
 
 getDatePublished ()
 
 getDescription ($locale)
 
 getFileName ($locale)
 
 getHeight ($locale)
 
 getHideCoverPageArchives ($locale)
 
 getHideCoverPageCover ($locale)
 
 getIssueId ()
 
 getIssueIdentification ($default=false, $breadcrumb=false, $long=false)
 
 getJournalId ()
 
 getLastModified ()
 
 getLocalizedCoverPageAltText ()
 
 getLocalizedCoverPageDescription ()
 
 getLocalizedDescription ()
 
 getLocalizedFileName ()
 
 getLocalizedHeight ()
 
 getLocalizedOriginalFileName ()
 
 getLocalizedShowCoverPage ()
 
 getLocalizedTitle ()
 
 getLocalizedWidth ()
 
 getNumArticles ()
 
 getNumber ()
 
 getOpenAccessDate ()
 
 getOriginalFileName ($locale)
 
 getOriginalStyleFileName ()
 
 getPublished ()
 
 getShowCoverPage ($locale)
 
 getShowNumber ()
 
 getShowTitle ()
 
 getShowVolume ()
 
 getShowYear ()
 
 getStoredPubId ($pubIdType)
 
 getStyleFileName ()
 
 getTitle ($locale)
 
 getVolume ()
 
 getWidth ($locale)
 
 getYear ()
 
 setAccessStatus ($accessStatus)
 
 setCoverPageAltText ($coverPageAltText, $locale)
 
 setCoverPageDescription ($coverPageDescription, $locale)
 
 setCurrent ($current)
 
 setDateNotified ($dateNotified)
 
 setDatePublished ($datePublished)
 
 setDescription ($description, $locale)
 
 setFileName ($fileName, $locale)
 
 setHeight ($height, $locale)
 
 setHideCoverPageArchives ($hideCoverPageArchives, $locale)
 
 setHideCoverPageCover ($hideCoverPageCover, $locale)
 
 setIssueId ($issueId)
 
 setJournalId ($journalId)
 
 setLastModified ($lastModified)
 
 setNumber ($number)
 
 setOpenAccessDate ($openAccessDate)
 
 setOriginalFileName ($originalFileName, $locale)
 
 setOriginalStyleFileName ($originalStyleFileName)
 
 setPublished ($published)
 
 setShowCoverPage ($showCoverPage, $locale)
 
 setShowNumber ($showNumber)
 
 setShowTitle ($showTitle)
 
 setShowVolume ($showVolume)
 
 setShowYear ($showYear)
 
 setStoredPubId ($pubIdType, $pubId)
 
 setStyleFileName ($styleFileName)
 
 setTitle ($title, $locale)
 
 setVolume ($volume)
 
 setWidth ($width, $locale)
 
 setYear ($year)
 
 stampModified ()
 
- 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

Class for Issue.

See Also
IssueDAO

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

Member Function Documentation

Issue::getAccessStatus ( )

get access status (ISSUE_ACCESS_...)

Returns
int

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

References DataObject\getData().

Issue::getAuthorString (   $lastOnly = false,
  $separator = ',
 
)

Return string of author names, separated by the specified token

Parameters
$lastOnlyboolean return list of lastnames only (default false)
$separatorstring separator for names (default comma+space)
Returns
string

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

Issue::getBestIssueId (   $journal = null)

Return the "best" issue ID – If a public issue ID is set, use it; otherwise use the internal issue Id. (Checks the journal settings to ensure that the public ID feature is enabled.)

Parameters
$journalobject The journal this issue is in
Returns
string

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

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

Issue::getCoverPageAltText (   $locale)

Get issue cover image alternate text

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Issue::getCoverPageDescription (   $locale)

get cover page description

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Issue::getCurrent ( )

get current

Returns
int

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

References DataObject\getData().

Issue::getDateNotified ( )

get date the users were last notified

Returns
date

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

References DataObject\getData().

Issue::getDatePublished ( )

get date published

Returns
date

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

References DataObject\getData().

Issue::getDescription (   $locale)

get description

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Issue::getFileName (   $locale)

Get issue cover image file name

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Issue::getHeight (   $locale)

get height of cover page image

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Issue::getHideCoverPageArchives (   $locale)

get hide cover page in archives

Parameters
$localestring
Returns
int

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

References DataObject\getData().

Issue::getHideCoverPageCover (   $locale)

get hide cover page prior to ToC

Parameters
$localestring
Returns
int

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

References DataObject\getData().

Issue::getIssueId ( )

get issue id

Returns
int

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

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

Issue::getIssueIdentification (   $default = false,
  $breadcrumb = false,
  $long = false 
)

Return the string of the issue identification based label format

Parameters
$defaultbool labelFormat type
$breadcrumbbool return type of label
$longbool long format of label
Returns
string

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

References DataObject\getData(), DataObject\getLocalizedData(), and AppLocale\requireComponents().

Issue::getJournalId ( )

get journal id

Returns
int

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

References DataObject\getData().

Referenced by getBestIssueId().

Issue::getLastModified ( )

get date the issue was last modified

Returns
date

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

References DataObject\getData().

Issue::getLocalizedCoverPageAltText ( )

Get the localized issue cover alternate text

Returns
string

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

References DataObject\getLocalizedData().

Issue::getLocalizedCoverPageDescription ( )

Get the localized issue cover description

Returns
string

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

References DataObject\getLocalizedData().

Issue::getLocalizedDescription ( )

Get the localized description

Returns
string

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

References DataObject\getLocalizedData().

Issue::getLocalizedFileName ( )

Get the localized issue cover filename

Returns
string

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

References DataObject\getLocalizedData().

Issue::getLocalizedHeight ( )

Get the localized issue cover height

Returns
string

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

References DataObject\getLocalizedData().

Issue::getLocalizedOriginalFileName ( )

Get the localized issue cover filename on the uploader's computer

Returns
string

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

References DataObject\getLocalizedData().

Issue::getLocalizedShowCoverPage ( )

Get the localized issue cover enable/disable flag

Returns
string

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

References DataObject\getLocalizedData().

Issue::getLocalizedTitle ( )

Get the localized title

Returns
string

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

References DataObject\getLocalizedData().

Issue::getLocalizedWidth ( )

Get the localized issue cover width

Returns
string

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

References DataObject\getLocalizedData().

Issue::getNumArticles ( )

Get number of articles in this issue.

Returns
int

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

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

Issue::getNumber ( )

get number

Returns
string

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

References DataObject\getData().

Issue::getOpenAccessDate ( )

get open access date

Returns
date

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

References DataObject\getData().

Issue::getOriginalFileName (   $locale)

Get original issue cover image file name

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Issue::getOriginalStyleFileName ( )

get original style file name

Returns
string

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

References DataObject\getData().

Issue::getPublished ( )

get published

Returns
int

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

References DataObject\getData().

Issue::getShowCoverPage (   $locale)

Get show issue cover image flag

Parameters
$localestring
Returns
int

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

References DataObject\getData().

Issue::getShowNumber ( )

get show issue number

Returns
int

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

References DataObject\getData().

Issue::getShowTitle ( )

get show issue title

Returns
int

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

References DataObject\getData().

Issue::getShowVolume ( )

get show issue volume

Returns
int

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

References DataObject\getData().

Issue::getShowYear ( )

get show issue year

Returns
int

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

References DataObject\getData().

Issue::getStoredPubId (   $pubIdType)

Get stored public ID of the issue.

Parameters
$pubIdTypestring 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 322 of file Issue.inc.php.

References DataObject\getData().

Issue::getStyleFileName ( )

get style file name

Returns
string

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

References DataObject\getData().

Issue::getTitle (   $locale)

get title

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Issue::getVolume ( )

get volume

Returns
int

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

References DataObject\getData().

Issue::getWidth (   $locale)

get width of cover page image

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Issue::getYear ( )

get year

Returns
int

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

References DataObject\getData().

Issue::setAccessStatus (   $accessStatus)

set access status (ISSUE_ACCESS_...)

Parameters
$accessStatusint

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

References DataObject\setData().

Issue::setCoverPageAltText (   $coverPageAltText,
  $locale 
)

Set issue cover image alternate text

Parameters
$coverPageAltTextstring
$localestring

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

References DataObject\setData().

Issue::setCoverPageDescription (   $coverPageDescription,
  $locale 
)

set cover page description

Parameters
$coverPageDescriptionstring
$localestring

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

References DataObject\setData().

Issue::setCurrent (   $current)

set current

Parameters
$currentint

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

References DataObject\setData().

Issue::setDateNotified (   $dateNotified)

set date the users were last notified

Parameters
$dateNotifieddate

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

References DataObject\setData().

Issue::setDatePublished (   $datePublished)

set date published

Parameters
$datePublisheddate

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

References DataObject\setData().

Issue::setDescription (   $description,
  $locale 
)

set description

Parameters
$descriptionstring
$localestring

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

References DataObject\setData().

Issue::setFileName (   $fileName,
  $locale 
)

set file name

Parameters
$fileNamestring
$localestring

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

References DataObject\setData().

Issue::setHeight (   $height,
  $locale 
)

set height of cover page image

Parameters
$localestring
$heightint

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

References DataObject\setData().

Issue::setHideCoverPageArchives (   $hideCoverPageArchives,
  $locale 
)

set hide cover page in archives

Parameters
$hideCoverPageArchivesint
$localestring

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

References DataObject\setData().

Issue::setHideCoverPageCover (   $hideCoverPageCover,
  $locale 
)

set hide cover page prior to ToC

Parameters
$hideCoverPageCoverint
$localestring

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

References DataObject\setData().

Issue::setIssueId (   $issueId)

set issue id

Parameters
$issueIdint

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

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

Issue::setJournalId (   $journalId)

set journal id

Parameters
$journalIdint

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

References DataObject\setData().

Issue::setLastModified (   $lastModified)

set date the issue was last modified

Parameters
$lastModifieddate

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

References DataObject\setData().

Referenced by stampModified().

Issue::setNumber (   $number)

set number

Parameters
$numberstring

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

References DataObject\setData().

Issue::setOpenAccessDate (   $openAccessDate)

set open access date

Parameters
$openAccessDatedate

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

References DataObject\setData().

Issue::setOriginalFileName (   $originalFileName,
  $locale 
)

set original file name

Parameters
$originalFileNamestring
$localestring

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

References DataObject\setData().

Issue::setOriginalStyleFileName (   $originalStyleFileName)

set original style file name

Parameters
$originalStyleFileNamestring

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

References DataObject\setData().

Issue::setPublished (   $published)

set published

Parameters
$publishedint

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

References DataObject\setData().

Issue::setShowCoverPage (   $showCoverPage,
  $locale 
)

Set show issue cover image flag

Parameters
$showCoverPageint
$localestring

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

References DataObject\setData().

Issue::setShowNumber (   $showNumber)

set show issue number

Parameters
$showNumberint

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

References DataObject\setData().

Issue::setShowTitle (   $showTitle)

set show issue title

Parameters
$showTitleint

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

References DataObject\setData().

Issue::setShowVolume (   $showVolume)

set show issue volume

Parameters
$showVolumeint

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

References DataObject\setData().

Issue::setShowYear (   $showYear)

set show issue year

Parameters
$showYearint

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

References DataObject\setData().

Issue::setStoredPubId (   $pubIdType,
  $pubId 
)

Set stored public issue id.

Parameters
$pubIdTypestring 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).
$pubIdstring

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

References DataObject\setData().

Issue::setStyleFileName (   $styleFileName)

set style file name

Parameters
$styleFileNamestring

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

References DataObject\setData().

Issue::setTitle (   $title,
  $locale 
)

set title

Parameters
$titlestring
$localestring

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

References DataObject\setData().

Issue::setVolume (   $volume)

set volume

Parameters
$volumeint

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

References DataObject\setData().

Issue::setWidth (   $width,
  $locale 
)

set width of cover page image

Parameters
$localestring
$widthint

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

References DataObject\setData().

Issue::setYear (   $year)

set year

Parameters
$yearint

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

References DataObject\setData().

Issue::stampModified ( )

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

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

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


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