PHP Class ExternalFeedDAO, ojs

Inheritance: extends DAO
Datei anzeigen Open project: pkp/ojs

Public Properties

Property Type Description
$parentPluginName Name of parent plugin

Public Methods

Method Description
__construct ( $parentPluginName ) Constructor
_returnExternalFeedFromRow ( $row ) : ExternalFeed Internal function to return ExternalFeed object from a row.
deleteExternalFeed ( $externalFeed ) : boolean Delete external feed.
deleteExternalFeedById ( $feedId ) : boolean Delete external feed by ID.
deleteExternalFeedsByJournalId ( $journalId ) Delete external_feed by journal ID.
getExternalFeed ( $feedId ) : ExternalFeed Retrieve an ExternalFeed by ID.
getExternalFeedJournalId ( $feedId ) : integer Retrieve external feed journal ID by feed ID.
getExternalFeedsByJournalId ( $journalId, $rangeInfo = null ) : object Retrieve external feeds matching a particular journal ID.
getInsertId ( ) : integer Get the ID of the last inserted external feed.
getLocaleFieldNames ( ) : array Get a list of fields for which localized data is supported
insertExternalFeed ( &$externalFeed ) : integer Insert a new external feed.
resequenceExternalFeeds ( $journalId ) Sequentially renumber external feeds in their sequence order.
updateExternalFeed ( &$externalFeed ) : boolean Update an existing external feed.
updateLocaleFields ( &$externalFeed ) Update the localized fields for this object.

Method Details

__construct() public method

Constructor
public __construct ( $parentPluginName )

_returnExternalFeedFromRow() public method

Internal function to return ExternalFeed object from a row.
public _returnExternalFeedFromRow ( $row ) : ExternalFeed
$row array
return ExternalFeed

deleteExternalFeed() public method

Delete external feed.
public deleteExternalFeed ( $externalFeed ) : boolean
$externalFeed ExternalFeed
return boolean

deleteExternalFeedById() public method

Delete external feed by ID.
public deleteExternalFeedById ( $feedId ) : boolean
$feedId int
return boolean

deleteExternalFeedsByJournalId() public method

Delete external_feed by journal ID.
public deleteExternalFeedsByJournalId ( $journalId )
$journalId int

getExternalFeed() public method

Retrieve an ExternalFeed by ID.
public getExternalFeed ( $feedId ) : ExternalFeed
$feedId int
return ExternalFeed

getExternalFeedJournalId() public method

Retrieve external feed journal ID by feed ID.
public getExternalFeedJournalId ( $feedId ) : integer
$feedId int
return integer

getExternalFeedsByJournalId() public method

Retrieve external feeds matching a particular journal ID.
public getExternalFeedsByJournalId ( $journalId, $rangeInfo = null ) : object
$journalId int
$rangeInfo object DBRangeInfo object describing range of results to return
return object DAOResultFactory containing matching ExternalFeeds

getInsertId() public method

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

getLocaleFieldNames() public method

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

insertExternalFeed() public method

Insert a new external feed.
public insertExternalFeed ( &$externalFeed ) : integer
$externalFeed ExternalFeed
return integer

resequenceExternalFeeds() public method

Sequentially renumber external feeds in their sequence order.
public resequenceExternalFeeds ( $journalId )

updateExternalFeed() public method

Update an existing external feed.
public updateExternalFeed ( &$externalFeed ) : boolean
$externalFeed ExternalFeed
return boolean

updateLocaleFields() public method

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

Property Details

$parentPluginName public_oe property

Name of parent plugin
public $parentPluginName