PHP Class Ojs\JournalBundle\Entity\Issue

Inheritance: extends Prezent\Doctrine\Translatable\Entity\AbstractTranslatable, implements Ojs\JournalBundle\Entity\JournalItemInterface, use trait Ojs\CoreBundle\Entity\GenericEntityTrait, use trait Ojs\CoreBundle\Entity\AnalyticsTrait
Show file Open project: ojs/ojs Class Usage Examples

Protected Properties

Property Type Description
$id integer
$translations

Public Methods

Method Description
__construct ( )
__toString ( ) : string Return formatted issue title and id eg. : "Issue title [#id]"
addArticle ( Article $article ) : Issue Add article
addCatalog ( Catalog $catalog ) : Issue Add catalog
addIssueFile ( IssueFile $issueFile )
addSection ( Ojs\JournalBundle\Entity\Section $section ) Add section to issue
getArticles ( ) : ArrayCollection | Article[] Get articles
getCatalogs ( ) : Doctrine\Common\Collections\Collection Get catalogs
getCover ( ) : string Get cover image path
getDatePublished ( ) : DateTime Get datePublished
getDescription ( ) : string Get description
getDisplayMode ( ) : integer
getFullFile ( ) : string
getHeader ( ) : string
getId ( ) : integer Get id
getInPress ( ) : integer
getIssueFiles ( ) : ArrayCollection | IssueFile[]
getJournal ( ) : Journal Get journal
getNumber ( ) : string Get number
getNumerator ( ) : integer
getPublicURI ( ) : string
getSections ( ) : ArrayCollection | Ojs\JournalBundle\Entity\Section[] Get sections
getSpecial ( ) : boolean is special
getStatistics ( ) : ArrayCollection | Ojs\AnalyticsBundle\Entity\IssueStatistic[]
getSupplement ( ) : boolean Get supplement
getTitle ( boolean $withLocale = false ) : string Get title
getTitleTranslations ( ) : string Get title translations
getTotalArticleDownload ( ) : integer
getTotalArticleView ( ) : integer
getVolume ( ) : string Get volume
getYear ( ) : DateTime Get year
isLastIssue ( ) : boolean
isPublic ( ) : boolean
isPublished ( ) : boolean
isSpecial ( )
isSupplement ( ) : boolean
removeArticle ( Article $article ) : Issue Remove article
removeCatalog ( Catalog $catalog ) Remove catalog
removeSection ( Ojs\JournalBundle\Entity\Section $section ) Remove section from issue
setCover ( string $cover ) : Issue Set cover image path
setCreated ( DateTime $created ) : Issue Set created
setDatePublished ( DateTime $datePublished ) : Issue Set datePublished
setDescription ( string $description ) : Issue Set description
setDisplayMode ( integer $displayMode ) : Issue
setFullFile ( string $fullFile )
setHeader ( string $header )
setInPress ( integer $inPress ) : Issue
setJournal ( Journal $journal ) : Issue Set journal
setLastIssue ( boolean $lastIssue )
setNumber ( string $number ) : Issue Set number
setNumerator ( integer $numerator )
setPublic ( boolean $public )
setPublicURI ( string $publicURI )
setPublished ( boolean $published )
setSpecial ( boolean $special ) : Issue Set is special
setStatistics ( ArrayCollection | Ojs\AnalyticsBundle\Entity\IssueStatistic[] $statistics )
setSupplement ( boolean $supplement )
setTitle ( string $title ) : Issue Set title
setTotalArticleDownload ( integer $totalArticleDownload )
setTotalArticleView ( integer $totalArticleView )
setUpdated ( DateTime $updated ) : Issue Set updated
setVolume ( string $volume ) : Issue Set volume
setYear ( DateTime $year ) : Issue Set year
translate ( null $locale = null ) : mixed | null | Ojs\JournalBundle\Entity\IssueTranslation Translation helper method

Method Details

__construct() public method

public __construct ( )

__toString() public method

Return formatted issue title and id eg. : "Issue title [#id]"
public __toString ( ) : string
return string

addArticle() public method

Add article
public addArticle ( Article $article ) : Issue
$article Article
return Issue

addCatalog() public method

Add catalog
public addCatalog ( Catalog $catalog ) : Issue
$catalog Catalog
return Issue

addIssueFile() public method

public addIssueFile ( IssueFile $issueFile )
$issueFile IssueFile

addSection() public method

Add section to issue
public addSection ( Ojs\JournalBundle\Entity\Section $section )
$section Ojs\JournalBundle\Entity\Section

getArticles() public method

Get articles
public getArticles ( ) : ArrayCollection | Article[]
return Doctrine\Common\Collections\ArrayCollection | Article[]

getCatalogs() public method

Get catalogs
public getCatalogs ( ) : Doctrine\Common\Collections\Collection
return Doctrine\Common\Collections\Collection

getCover() public method

Get cover image path
public getCover ( ) : string
return string

getDatePublished() public method

Get datePublished
public getDatePublished ( ) : DateTime
return DateTime

getDescription() public method

Get description
public getDescription ( ) : string
return string

getDisplayMode() public method

public getDisplayMode ( ) : integer
return integer

getFullFile() public method

public getFullFile ( ) : string
return string

getHeader() public method

public getHeader ( ) : string
return string

getId() public method

Get id
public getId ( ) : integer
return integer

getInPress() public method

public getInPress ( ) : integer
return integer

getIssueFiles() public method

public getIssueFiles ( ) : ArrayCollection | IssueFile[]
return Doctrine\Common\Collections\ArrayCollection | IssueFile[]

getJournal() public method

Get journal
public getJournal ( ) : Journal
return Journal

getNumber() public method

Get number
public getNumber ( ) : string
return string

getNumerator() public method

public getNumerator ( ) : integer
return integer

getPublicURI() public method

public getPublicURI ( ) : string
return string

getSections() public method

Get sections
public getSections ( ) : ArrayCollection | Ojs\JournalBundle\Entity\Section[]
return Doctrine\Common\Collections\ArrayCollection | Ojs\JournalBundle\Entity\Section[]

getSpecial() public method

is special
public getSpecial ( ) : boolean
return boolean

getStatistics() public method

public getStatistics ( ) : ArrayCollection | Ojs\AnalyticsBundle\Entity\IssueStatistic[]
return Doctrine\Common\Collections\ArrayCollection | Ojs\AnalyticsBundle\Entity\IssueStatistic[]

getSupplement() public method

Get supplement
public getSupplement ( ) : boolean
return boolean

getTitle() public method

Get title
public getTitle ( boolean $withLocale = false ) : string
$withLocale boolean
return string

getTitleTranslations() public method

Get title translations
public getTitleTranslations ( ) : string
return string

getTotalArticleDownload() public method

public getTotalArticleDownload ( ) : integer
return integer

getTotalArticleView() public method

public getTotalArticleView ( ) : integer
return integer

getVolume() public method

Get volume
public getVolume ( ) : string
return string

getYear() public method

Get year
public getYear ( ) : DateTime
return DateTime

isLastIssue() public method

public isLastIssue ( ) : boolean
return boolean

isPublic() public method

public isPublic ( ) : boolean
return boolean

isPublished() public method

public isPublished ( ) : boolean
return boolean

isSpecial() public method

public isSpecial ( )

isSupplement() public method

public isSupplement ( ) : boolean
return boolean

removeArticle() public method

Remove article
public removeArticle ( Article $article ) : Issue
$article Article
return Issue

removeCatalog() public method

Remove catalog
public removeCatalog ( Catalog $catalog )
$catalog Catalog

removeSection() public method

Remove section from issue
public removeSection ( Ojs\JournalBundle\Entity\Section $section )
$section Ojs\JournalBundle\Entity\Section

setCover() public method

Set cover image path
public setCover ( string $cover ) : Issue
$cover string
return Issue

setCreated() public method

Set created
public setCreated ( DateTime $created ) : Issue
$created DateTime
return Issue

setDatePublished() public method

Set datePublished
public setDatePublished ( DateTime $datePublished ) : Issue
$datePublished DateTime
return Issue

setDescription() public method

Set description
public setDescription ( string $description ) : Issue
$description string
return Issue

setDisplayMode() public method

public setDisplayMode ( integer $displayMode ) : Issue
$displayMode integer
return Issue

setFullFile() public method

public setFullFile ( string $fullFile )
$fullFile string

setHeader() public method

public setHeader ( string $header )
$header string

setInPress() public method

public setInPress ( integer $inPress ) : Issue
$inPress integer
return Issue

setJournal() public method

Set journal
public setJournal ( Journal $journal ) : Issue
$journal Journal
return Issue

setLastIssue() public method

public setLastIssue ( boolean $lastIssue )
$lastIssue boolean

setNumber() public method

Set number
public setNumber ( string $number ) : Issue
$number string
return Issue

setNumerator() public method

public setNumerator ( integer $numerator )
$numerator integer

setPublic() public method

public setPublic ( boolean $public )
$public boolean

setPublicURI() public method

public setPublicURI ( string $publicURI )
$publicURI string

setPublished() public method

public setPublished ( boolean $published )
$published boolean

setSpecial() public method

Set is special
public setSpecial ( boolean $special ) : Issue
$special boolean
return Issue

setStatistics() public method

public setStatistics ( ArrayCollection | Ojs\AnalyticsBundle\Entity\IssueStatistic[] $statistics )
$statistics Doctrine\Common\Collections\ArrayCollection | Ojs\AnalyticsBundle\Entity\IssueStatistic[]

setSupplement() public method

public setSupplement ( boolean $supplement )
$supplement boolean

setTitle() public method

Set title
public setTitle ( string $title ) : Issue
$title string
return Issue

setTotalArticleDownload() public method

public setTotalArticleDownload ( integer $totalArticleDownload )
$totalArticleDownload integer

setTotalArticleView() public method

public setTotalArticleView ( integer $totalArticleView )
$totalArticleView integer

setUpdated() public method

Set updated
public setUpdated ( DateTime $updated ) : Issue
$updated DateTime
return Issue

setVolume() public method

Set volume
public setVolume ( string $volume ) : Issue
$volume string
return Issue

setYear() public method

Set year
public setYear ( DateTime $year ) : Issue
$year DateTime
return Issue

translate() public method

Translation helper method
public translate ( null $locale = null ) : mixed | null | Ojs\JournalBundle\Entity\IssueTranslation
$locale null
return mixed | null | Ojs\JournalBundle\Entity\IssueTranslation

Property Details

$id protected property

protected int $id
return integer

$translations protected property

protected $translations