PHP Class JournalDAO, ojs

Inheritance: extends DAO
显示文件 Open project: pkp/ojs Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor
_fromRow ( $row ) : Journal Internal function to return a Journal object from a row.
anyPubIdExists ( $journalId, $pubIdType, $pubId, $assocType = ASSOC_TYPE_ANY, $assocId, $forSameType = false ) : boolean Check whether the given public ID exists for any publishing object in a journal.
deleteAllPubIds ( $journalId, $pubIdType ) Delete the public IDs of all publishing objects in a journal.
deleteById ( $journalId ) Delete a journal by ID, INCLUDING ALL DEPENDENT ITEMS.
getTitles ( $enabledOnly = false ) : array Retrieve the IDs and titles of all journals in an associative array.
newDataObject ( ) : DataObject Construct a new Journal.
updateObject ( $journal ) Update an existing journal.

Protected Methods

Method Description
_getPrimaryKeyColumn ( ) : string Get the name of the primary key column for this context.
_getSettingsTableName ( ) : string Get the table name for this context's settings table.
_getTableName ( ) : string Get the table name for this context.

Method Details

__construct() public method

Constructor
public __construct ( )

_fromRow() public method

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

_getPrimaryKeyColumn() protected method

Get the name of the primary key column for this context.
protected _getPrimaryKeyColumn ( ) : string
return string

_getSettingsTableName() protected method

Get the table name for this context's settings table.
protected _getSettingsTableName ( ) : string
return string

_getTableName() protected method

Get the table name for this context.
protected _getTableName ( ) : string
return string

anyPubIdExists() public method

Check whether the given public ID exists for any publishing object in a journal.
public anyPubIdExists ( $journalId, $pubIdType, $pubId, $assocType = ASSOC_TYPE_ANY, $assocId, $forSameType = false ) : boolean
$journalId int
$pubIdType string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see ).
$pubId string
$assocType int The object type of an object to be excluded from the search. Identified by one of the ASSOC_TYPE_* constants.
$assocId int The id of an object to be excluded from the search.
$forSameType boolean Whether only the same objects should be considered.
return boolean

deleteAllPubIds() public method

Delete the public IDs of all publishing objects in a journal.
public deleteAllPubIds ( $journalId, $pubIdType )
$journalId int
$pubIdType string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see ).

deleteById() public method

Delete a journal by ID, INCLUDING ALL DEPENDENT ITEMS.
public deleteById ( $journalId )
$journalId int

getTitles() public method

Retrieve the IDs and titles of all journals in an associative array.
public getTitles ( $enabledOnly = false ) : array
return array

newDataObject() public method

Construct a new Journal.
public newDataObject ( ) : DataObject
return DataObject

updateObject() public method

Update an existing journal.
public updateObject ( $journal )
$journal Journal