PHP 클래스 IssueDAO, ojs

상속: extends DAO, implements PKPPubIdPluginDAO
파일 보기 프로젝트 열기: pkp/ojs 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$caches

공개 메소드들

메소드 설명
_cacheMiss ( $cache, $id ) : Issue Handle a cache miss.
_getCache ( $cacheId ) : GenericCache Get an issue cache by cache ID.
_returnIssueFromRow ( $row ) : Issue creates and returns an issue object from a row
changePubId ( $issueId, $pubIdType, $pubId )
customIssueOrderingExists ( $journalId ) : boolean Check if a journal has custom issue ordering.
deleteAllPubIds ( $journalId, $pubIdType )
deleteByJournalId ( $journalId ) Delete issues by journal id. Deletes dependent entities.
deleteCustomIssueOrdering ( $journalId ) Delete the custom ordering of a published issue.
deleteObject ( $issue ) Delete issue. Deletes associated issue galleys, cover pages, and published articles.
deletePubId ( $issueId, $pubIdType )
flushCache ( ) Flush the issue cache.
getAdditionalFieldNames ( ) : array Get a list of additional fields that do not have dedicated accessors.
getByBestId ( $issueId, $journalId = null, $useCache = false ) : Issue Retrieve Issue by "best" issue id -- public ID if it exists, falling back on the internal issue ID otherwise.
getById ( $issueId, $journalId = null, $useCache = false ) : Issue Retrieve Issue by issue id
getByPubId ( $pubIdType, $pubId, $journalId = null, $useCache = false ) : Issue Retrieve Issue by public issue id
getBySetting ( $settingName, $settingValue, $journalId = null ) : array Find issues by querying issue settings.
getCurrent ( $journalId, $useCache = false ) : Issue Retrieve current issue
getCustomIssueOrder ( $journalId, $issueId ) : integer Get the custom issue order of a journal.
getExportable ( $contextId, $pubIdType = null, $pubIdSettingName = null, $pubIdSettingValue = null, $rangeInfo = null ) : DAOResultFactory Get all published issues (eventually with a pubId assigned and) matching the specified settings.
getInsertId ( ) : integer Get the ID of the last inserted issue.
getIssueByArticleId ( $articleId, $journalId = null ) : Issue Get issue by article id
getIssues ( $journalId, $rangeInfo = null ) : ItemIterator Get all issues organized by published date
getIssuesByIdentification ( $journalId, $volume = null, $number = null, $year = null, $titles = [] ) : DAOResultFactory Retrieve Issues by identification
getLocaleFieldNames ( ) : array Get a list of fields for which localized data is supported
getNumArticles ( $issueId ) : integer Return number of articles assigned to an issue.
getPublishedIssues ( $journalId, $rangeInfo = null ) : ItemIterator Get published issues organized by published date
getPublishedIssuesByNumber ( $journalId, $volume = null, $number = null, $year = null ) : Iterator Retrieve Issue by some combination of volume, number, and year
getUnpublishedIssues ( $journalId, $rangeInfo = null ) : ItemIterator Get unpublished issues organized by published date
insertCustomIssueOrder ( $journalId, $issueId, $seq ) INTERNAL USE ONLY: Insert a custom issue ordering
insertObject ( $issue ) : Issue inserts a new issue into issues table
issueExists ( $journalId, $volume, $number, $year, $issueId ) : boolean Check if volume, number and year have already been issued
issueIdExists ( $issueId, $journalId ) : boolean Checks if issue exists
moveCustomIssueOrder ( $journalId, $issueId, $newPos ) Move a custom issue ordering up or down, resequencing as necessary.
newDataObject ( ) : Issue Construct a new data object.
pubIdExists ( $pubIdType, $pubId, $issueId, $journalId )
resequenceCustomIssueOrders ( $journalId ) Sequentially renumber custom issue orderings in their sequence order.
setDefaultCustomIssueOrders ( $journalId ) Import the current issue orders into the specified journal as custom issue orderings.
updateCurrent ( $journalId, $issue = null ) : Issue update current issue
updateLocaleFields ( &$issue ) Update the localized fields for this object.
updateObject ( $issue ) updates an issue

메소드 상세

_cacheMiss() 공개 메소드

Handle a cache miss.
public _cacheMiss ( $cache, $id ) : Issue
$cache GenericCache
$id string
리턴 Issue

_getCache() 공개 메소드

Get an issue cache by cache ID.
public _getCache ( $cacheId ) : GenericCache
$cacheId string
리턴 GenericCache

_returnIssueFromRow() 공개 메소드

creates and returns an issue object from a row
public _returnIssueFromRow ( $row ) : Issue
$row array
리턴 Issue object

changePubId() 공개 메소드

public changePubId ( $issueId, $pubIdType, $pubId )

customIssueOrderingExists() 공개 메소드

Check if a journal has custom issue ordering.
public customIssueOrderingExists ( $journalId ) : boolean
$journalId int
리턴 boolean

deleteAllPubIds() 공개 메소드

public deleteAllPubIds ( $journalId, $pubIdType )

deleteByJournalId() 공개 메소드

Delete issues by journal id. Deletes dependent entities.
public deleteByJournalId ( $journalId )
$journalId int

deleteCustomIssueOrdering() 공개 메소드

Delete the custom ordering of a published issue.
public deleteCustomIssueOrdering ( $journalId )
$journalId int

deleteObject() 공개 메소드

Delete issue. Deletes associated issue galleys, cover pages, and published articles.
public deleteObject ( $issue )
$issue object issue

deletePubId() 공개 메소드

public deletePubId ( $issueId, $pubIdType )

flushCache() 공개 메소드

Flush the issue cache.
public flushCache ( )

getAdditionalFieldNames() 공개 메소드

Get a list of additional fields that do not have dedicated accessors.
public getAdditionalFieldNames ( ) : array
리턴 array

getByBestId() 공개 메소드

Retrieve Issue by "best" issue id -- public ID if it exists, falling back on the internal issue ID otherwise.
public getByBestId ( $issueId, $journalId = null, $useCache = false ) : Issue
$issueId string
$journalId int optional
$useCache boolean optional
리턴 Issue object

getById() 공개 메소드

Retrieve Issue by issue id
public getById ( $issueId, $journalId = null, $useCache = false ) : Issue
$issueId int
$journalId int optional
$useCache boolean optional
리턴 Issue object

getByPubId() 공개 메소드

Retrieve Issue by public issue id
public getByPubId ( $pubIdType, $pubId, $journalId = null, $useCache = false ) : Issue
$pubIdType string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see ).
$pubId string
$journalId int optional
$useCache boolean optional
리턴 Issue object

getBySetting() 공개 메소드

Find issues by querying issue settings.
public getBySetting ( $settingName, $settingValue, $journalId = null ) : array
$settingName string
$settingValue mixed
$journalId int optional
리턴 array The issues identified by setting.

getCurrent() 공개 메소드

Retrieve current issue
public getCurrent ( $journalId, $useCache = false ) : Issue
$journalId int
$useCache boolean optional
리턴 Issue object

getCustomIssueOrder() 공개 메소드

Get the custom issue order of a journal.
public getCustomIssueOrder ( $journalId, $issueId ) : integer
$journalId int
$issueId int
리턴 integer

getExportable() 공개 메소드

Get all published issues (eventually with a pubId assigned and) matching the specified settings.
public getExportable ( $contextId, $pubIdType = null, $pubIdSettingName = null, $pubIdSettingValue = null, $rangeInfo = null ) : DAOResultFactory
$contextId integer optional
$pubIdType string
$pubIdSettingName string optional (e.g. crossref::registeredDoi)
$pubIdSettingValue string optional
$rangeInfo DBResultRange optional
리턴 DAOResultFactory

getInsertId() 공개 메소드

Get the ID of the last inserted issue.
public getInsertId ( ) : integer
리턴 integer

getIssueByArticleId() 공개 메소드

Get issue by article id
public getIssueByArticleId ( $articleId, $journalId = null ) : Issue
리턴 Issue object

getIssues() 공개 메소드

Get all issues organized by published date
public getIssues ( $journalId, $rangeInfo = null ) : ItemIterator
$journalId int
$rangeInfo object DBResultRange (optional)
리턴 ItemIterator

getIssuesByIdentification() 공개 메소드

Retrieve Issues by identification
public getIssuesByIdentification ( $journalId, $volume = null, $number = null, $year = null, $titles = [] ) : DAOResultFactory
$journalId int
$volume int
$number string
$year int
$titles array
리턴 DAOResultFactory

getLocaleFieldNames() 공개 메소드

Get a list of fields for which localized data is supported
public getLocaleFieldNames ( ) : array
리턴 array

getNumArticles() 공개 메소드

Return number of articles assigned to an issue.
public getNumArticles ( $issueId ) : integer
$issueId int
리턴 integer

getPublishedIssues() 공개 메소드

Get published issues organized by published date
public getPublishedIssues ( $journalId, $rangeInfo = null ) : ItemIterator
$journalId int
$rangeInfo object DBResultRange
리턴 ItemIterator

getPublishedIssuesByNumber() 공개 메소드

Retrieve Issue by some combination of volume, number, and year
public getPublishedIssuesByNumber ( $journalId, $volume = null, $number = null, $year = null ) : Iterator
$journalId int
$volume int
$number int
$year int
리턴 Iterator object

getUnpublishedIssues() 공개 메소드

Get unpublished issues organized by published date
public getUnpublishedIssues ( $journalId, $rangeInfo = null ) : ItemIterator
$journalId int
$rangeInfo object DBResultRange
리턴 ItemIterator

insertCustomIssueOrder() 공개 메소드

INTERNAL USE ONLY: Insert a custom issue ordering
public insertCustomIssueOrder ( $journalId, $issueId, $seq )
$journalId int
$issueId int
$seq int

insertObject() 공개 메소드

inserts a new issue into issues table
public insertObject ( $issue ) : Issue
리턴 Issue Id int

issueExists() 공개 메소드

Check if volume, number and year have already been issued
public issueExists ( $journalId, $volume, $number, $year, $issueId ) : boolean
$journalId int
$volume int
$number int
$year int
$issueId int Issue ID to exclude from results
리턴 boolean

issueIdExists() 공개 메소드

Checks if issue exists
public issueIdExists ( $issueId, $journalId ) : boolean
$issueId int
$journalId int
리턴 boolean

moveCustomIssueOrder() 공개 메소드

Move a custom issue ordering up or down, resequencing as necessary.
public moveCustomIssueOrder ( $journalId, $issueId, $newPos )
$journalId int
$issueId int
$newPos int The new position (0-based) of this section

newDataObject() 공개 메소드

Construct a new data object.
public newDataObject ( ) : Issue
리턴 Issue

pubIdExists() 공개 메소드

public pubIdExists ( $pubIdType, $pubId, $issueId, $journalId )

resequenceCustomIssueOrders() 공개 메소드

Sequentially renumber custom issue orderings in their sequence order.
public resequenceCustomIssueOrders ( $journalId )
$journalId int

setDefaultCustomIssueOrders() 공개 메소드

Import the current issue orders into the specified journal as custom issue orderings.
public setDefaultCustomIssueOrders ( $journalId )
$journalId int

updateCurrent() 공개 메소드

update current issue
public updateCurrent ( $journalId, $issue = null ) : Issue
리턴 Issue object

updateLocaleFields() 공개 메소드

Update the localized fields for this object.
public updateLocaleFields ( &$issue )
$issue

updateObject() 공개 메소드

updates an issue
public updateObject ( $issue )

프로퍼티 상세

$caches 공개적으로 프로퍼티

public $caches