PHP Class ArticleDAO, ojs

Afficher le fichier Open project: pkp/ojs Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( ) Constructor.
_fromRow ( $row ) : Article Internal function to return an Article object from a row.
changeStatus ( $articleId, $status ) Change the status of the article
deleteById ( $submissionId )
flushCache ( )
getBySetting ( $settingName, $settingValue, $journalId = null, $rangeInfo = null ) : array Find articles by querying article settings.
getJournalId ( $articleId ) : integer Get the ID of the journal an article is in.
getLocaleFieldNames ( ) : array Get a list of fields for which localized data is supported
insertObject ( $article ) Insert a new Article.
newDataObject ( ) : Article Return a new data object.
removeArticlesFromSection ( $sectionId ) Removes articles from a section by section ID
updateObject ( $article ) Update an existing article.
updateSetting ( $articleId, $name, $value, $type, $isLocalized = false ) Add/update an article setting.

Méthodes protégées

Méthode Description
getCompletionConditions ( $completed )
getCompletionJoins ( )
getFetchColumns ( )
getFetchJoins ( )
getFetchParameters ( )
getGroupByColumns ( )
getSubEditorJoin ( )

Method Details

__construct() public méthode

Constructor.
public __construct ( )

_fromRow() public méthode

Internal function to return an Article object from a row.
public _fromRow ( $row ) : Article
$row array
Résultat Article

changeStatus() public méthode

Change the status of the article
public changeStatus ( $articleId, $status )
$articleId int
$status int

deleteById() public méthode

public deleteById ( $submissionId )

flushCache() public méthode

public flushCache ( )

getBySetting() public méthode

Find articles by querying article settings.
public getBySetting ( $settingName, $settingValue, $journalId = null, $rangeInfo = null ) : array
$settingName string
$settingValue mixed
$journalId int optional
$rangeInfo DBResultRange optional
Résultat array The articles identified by setting. WARNING: This query is selectively indexed for PostgreSQL. Ensure that the settings you wish to query are specified in dbscripts/xml/indexes.xml to avoid a potentially costly query.

getCompletionConditions() protected méthode

protected getCompletionConditions ( $completed )

getCompletionJoins() protected méthode

protected getCompletionJoins ( )

getFetchColumns() protected méthode

protected getFetchColumns ( )

getFetchJoins() protected méthode

protected getFetchJoins ( )

getFetchParameters() protected méthode

protected getFetchParameters ( )

getGroupByColumns() protected méthode

protected getGroupByColumns ( )

getJournalId() public méthode

Get the ID of the journal an article is in.
public getJournalId ( $articleId ) : integer
$articleId int
Résultat integer

getLocaleFieldNames() public méthode

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

getSubEditorJoin() protected méthode

protected getSubEditorJoin ( )

insertObject() public méthode

Insert a new Article.
public insertObject ( $article )
$article Article

newDataObject() public méthode

Return a new data object.
public newDataObject ( ) : Article
Résultat Article

removeArticlesFromSection() public méthode

Removes articles from a section by section ID
public removeArticlesFromSection ( $sectionId )
$sectionId int

updateObject() public méthode

Update an existing article.
public updateObject ( $article )
$article Article

updateSetting() public méthode

Add/update an article setting.
public updateSetting ( $articleId, $name, $value, $type, $isLocalized = false )
$articleId int
$name string
$value mixed
$type string Data type of the setting.
$isLocalized boolean