PHP Class MonographDAO, omp

Inheritance: extends DAO
Show file Open project: pkp/omp Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor.
_fromRow ( $row ) : Monograph Internal function to return an Monograph object from a row.
addCategory ( $monographId, $categoryId ) Associate a category with a monograph.
categoryAssociationExists ( $monographId, $categoryId ) : boolean Check if an monograph exists with the specified ID.
deleteById ( $submissionId )
getAdditionalFieldNames ( ) : array Get a list of additional fields that do not have dedicated accessors.
getByPressId ( $pressId ) : DAOResultFactory Get all monographs for a press.
getCategories ( $monographId, $pressId = null ) : DAOResultFactory Get the categories associated with a given monograph.
getLocaleFieldNames ( ) : array Get a list of fields for which localized data is supported
getUnassignedCategories ( $monographId, $pressId = null ) : DAOResultFactory Get the categories not associated with a given monograph.
getUnpublishedMonographsByPressId ( $pressId ) : DAOResultFactory Get unpublished monographs for a press.
insertObject ( $monograph ) : Monograph inserts a new monograph into submissions table
newDataObject ( ) : Monograph Get a new data object representing the monograph.
removeCategories ( $monographId ) Unassociate all categories.
removeCategory ( $monographId, $categoryId ) Unassociate a category with a monograph.
removeMonographsFromSeries ( $seriesId ) Remove all monographs from an series.
updateObject ( $monograph ) updates a monograph

Protected Methods

Method Description
getCompletionConditions ( $completed )
getFetchColumns ( )
getFetchJoins ( )
getFetchParameters ( )
getGroupByColumns ( )
getSubEditorJoin ( )

Method Details

__construct() public method

Constructor.
public __construct ( )

_fromRow() public method

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

addCategory() public method

Associate a category with a monograph.
public addCategory ( $monographId, $categoryId )
$monographId int
$categoryId int

categoryAssociationExists() public method

Check if an monograph exists with the specified ID.
public categoryAssociationExists ( $monographId, $categoryId ) : boolean
$monographId int
return boolean

deleteById() public method

public deleteById ( $submissionId )

getAdditionalFieldNames() public method

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

getByPressId() public method

Get all monographs for a press.
public getByPressId ( $pressId ) : DAOResultFactory
$pressId int
return DAOResultFactory containing matching Monographs

getCategories() public method

Get the categories associated with a given monograph.
public getCategories ( $monographId, $pressId = null ) : DAOResultFactory
$monographId int The monograph id.
$pressId int (optional) The monograph press id.
return DAOResultFactory

getCompletionConditions() protected method

protected getCompletionConditions ( $completed )

getFetchColumns() protected method

protected getFetchColumns ( )

getFetchJoins() protected method

protected getFetchJoins ( )

getFetchParameters() protected method

protected getFetchParameters ( )

getGroupByColumns() protected method

protected getGroupByColumns ( )

getLocaleFieldNames() public method

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

getSubEditorJoin() protected method

protected getSubEditorJoin ( )

getUnassignedCategories() public method

Get the categories not associated with a given monograph.
public getUnassignedCategories ( $monographId, $pressId = null ) : DAOResultFactory
$monographId int
return DAOResultFactory

getUnpublishedMonographsByPressId() public method

Get unpublished monographs for a press.
public getUnpublishedMonographsByPressId ( $pressId ) : DAOResultFactory
$pressId int
return DAOResultFactory containing matching Monographs

insertObject() public method

inserts a new monograph into submissions table
public insertObject ( $monograph ) : Monograph
return Monograph Id int

newDataObject() public method

Get a new data object representing the monograph.
public newDataObject ( ) : Monograph
return Monograph

removeCategories() public method

Unassociate all categories.
public removeCategories ( $monographId )
$monographId int

removeCategory() public method

Unassociate a category with a monograph.
public removeCategory ( $monographId, $categoryId )
$monographId int
$categoryId int

removeMonographsFromSeries() public method

Remove all monographs from an series.
public removeMonographsFromSeries ( $seriesId )
$seriesId int

updateObject() public method

updates a monograph
public updateObject ( $monograph )