PHP Class IssueGalleyDAO, ojs

Inheritance: extends DAO
Exibir arquivo Open project: pkp/ojs

Public Methods

Method Description
__construct ( ) Constructor.
_fromRow ( $row ) : IssueGalley Internal function to return an IssueGalley object from a row.
deleteById ( $galleyId, $issueId = null ) Delete a galley by ID.
deleteByIssueId ( $issueId ) Delete galleys by issue.
deleteObject ( $galley ) Delete an IssueGalley.
getAdditionalFieldNames ( ) : array Get a list of additional fields that do not have dedicated accessors.
getByBestId ( $galleyId, $issueId ) : ArticleGalley Retrieve issue galley by public galley id or, failing that, internal galley ID; public galley ID takes precedence.
getById ( $galleyId, $issueId = null ) : IssueGalley Retrieve a galley by ID.
getByIssueId ( $issueId ) : array Retrieve all galleys for an issue.
getByPubId ( $pubIdType, $pubId, $issueId ) : IssueGalley Retrieve a galley by ID.
getInsertId ( ) : integer Get the ID of the last inserted gallery.
getLocaleFieldNames ( ) : array Get the list of fields for which data is localized.
getNextGalleySequence ( $issueId ) : integer Get the the next sequence number for an issue's galleys (i.e., current max + 1).
insertObject ( $galley ) Insert a new IssueGalley.
newDataObject ( ) : IssueGalley Construct a new issue galley.
pubIdExists ( $pubIdType, $pubId, $galleyId, $journalId ) : boolean Checks if public identifier exists (other than for the specified galley ID, which is treated as an exception).
resequence ( $issueId ) Sequentially renumber galleys for an issue in their sequence order.
updateLocaleFields ( $galley ) Update the localized fields for this galley.
updateObject ( $galley ) Update an existing IssueGalley.

Method Details

__construct() public method

Constructor.
public __construct ( )

_fromRow() public method

Internal function to return an IssueGalley object from a row.
public _fromRow ( $row ) : IssueGalley
$row array
return IssueGalley

deleteById() public method

Delete a galley by ID.
public deleteById ( $galleyId, $issueId = null )
$galleyId int
$issueId int optional

deleteByIssueId() public method

NOTE that this will not delete issue_file entities or the respective files.
public deleteByIssueId ( $issueId )
$issueId int

deleteObject() public method

Delete an IssueGalley.
public deleteObject ( $galley )
$galley IssueGalley

getAdditionalFieldNames() public method

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

getByBestId() public method

Retrieve issue galley by public galley id or, failing that, internal galley ID; public galley ID takes precedence.
public getByBestId ( $galleyId, $issueId ) : ArticleGalley
$galleyId string
$issueId int
return ArticleGalley object

getById() public method

Retrieve a galley by ID.
public getById ( $galleyId, $issueId = null ) : IssueGalley
$galleyId int
$issueId int optional
return IssueGalley

getByIssueId() public method

Retrieve all galleys for an issue.
public getByIssueId ( $issueId ) : array
$issueId int
return array IssueGalleys

getByPubId() public method

Retrieve a galley by ID.
public getByPubId ( $pubIdType, $pubId, $issueId ) : IssueGalley
$pubIdType string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see ).
$pubId string
$issueId int
return IssueGalley

getInsertId() public method

Get the ID of the last inserted gallery.
public getInsertId ( ) : integer
return integer

getLocaleFieldNames() public method

Get the list of fields for which data is localized.
public getLocaleFieldNames ( ) : array
return array

getNextGalleySequence() public method

Get the the next sequence number for an issue's galleys (i.e., current max + 1).
public getNextGalleySequence ( $issueId ) : integer
$issueId int
return integer

insertObject() public method

Insert a new IssueGalley.
public insertObject ( $galley )
$galley IssueGalley

newDataObject() public method

Construct a new issue galley.
public newDataObject ( ) : IssueGalley
return IssueGalley

pubIdExists() public method

Checks if public identifier exists (other than for the specified galley ID, which is treated as an exception).
public pubIdExists ( $pubIdType, $pubId, $galleyId, $journalId ) : boolean
$pubIdType string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see ).
$pubId string
$galleyId int An ID to be excluded from the search.
$journalId int
return boolean

resequence() public method

Sequentially renumber galleys for an issue in their sequence order.
public resequence ( $issueId )
$issueId int

updateLocaleFields() public method

Update the localized fields for this galley.
public updateLocaleFields ( $galley )
$galley

updateObject() public method

Update an existing IssueGalley.
public updateObject ( $galley )
$galley IssueGalley