Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
ArticleFileDAO Class Reference
Inheritance diagram for ArticleFileDAO:
PKPFileDAO DAO

Public Member Functions

_returnArticleFileFromRow (&$row)
 
 deleteArticleFile (&$articleFile)
 
 deleteArticleFileById ($fileId, $revision=null)
 
 deleteArticleFiles ($articleId)
 
getArticleFile ($fileId, $revision=null, $articleId=null)
 
getArticleFileRevisions ($fileId, $round=null)
 
getArticleFileRevisionsInRange ($fileId, $start=1, $end=null)
 
getArticleFilesByArticle ($articleId)
 
getArticleFilesByAssocId ($assocId, $fileStage)
 
 getInsertArticleFileId ()
 
getRevisionNumber ($fileId)
 
 insertArticleFile (&$articleFile)
 
 updateArticleFile (&$articleFile)
 
- Public Member Functions inherited from PKPFileDAO
 isInlineable ($file)
 
 PKPFileDAO ()
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource (&$dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 

Additional Inherited Members

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying ArticleFile objects.

See Also
ArticleFile

Definition at line 21 of file ArticleFileDAO.inc.php.

Member Function Documentation

& ArticleFileDAO::_returnArticleFileFromRow ( $row)

Internal function to return an ArticleFile object from a row.

Parameters
$rowarray
Returns
ArticleFile

Definition at line 229 of file ArticleFileDAO.inc.php.

References HookRegistry\call(), and DAO\datetimeFromDB().

Referenced by getArticleFile(), getArticleFileRevisions(), getArticleFileRevisionsInRange(), getArticleFilesByArticle(), and getArticleFilesByAssocId().

ArticleFileDAO::deleteArticleFile ( $articleFile)

Delete an article file.

Parameters
$articleArticleFile

Definition at line 340 of file ArticleFileDAO.inc.php.

References deleteArticleFileById().

ArticleFileDAO::deleteArticleFileById (   $fileId,
  $revision = null 
)

Delete an article file by ID.

Parameters
$articleIdint
$revisionint

Definition at line 349 of file ArticleFileDAO.inc.php.

References DAO\update().

Referenced by deleteArticleFile().

ArticleFileDAO::deleteArticleFiles (   $articleId)

Delete all article files for an article.

Parameters
$articleIdint

Definition at line 365 of file ArticleFileDAO.inc.php.

References DAO\update().

& ArticleFileDAO::getArticleFile (   $fileId,
  $revision = null,
  $articleId = null 
)

Retrieve an article by ID.

Parameters
$fileIdint
$revisionint optional, if omitted latest revision is used
$articleIdint optional
Returns
ArticleFile

Definition at line 30 of file ArticleFileDAO.inc.php.

References _returnArticleFileFromRow(), DAO\retrieve(), and DAO\retrieveLimit().

& ArticleFileDAO::getArticleFileRevisions (   $fileId,
  $round = null 
)

Retrieve all revisions of an article file.

Parameters
$articleIdint
Returns
ArticleFile

Definition at line 80 of file ArticleFileDAO.inc.php.

References _returnArticleFileFromRow(), and DAO\retrieve().

& ArticleFileDAO::getArticleFileRevisionsInRange (   $fileId,
  $start = 1,
  $end = null 
)

Retrieve revisions of an article file in a range.

Parameters
$articleIdint
Returns
ArticleFile

Definition at line 116 of file ArticleFileDAO.inc.php.

References _returnArticleFileFromRow(), and DAO\retrieve().

& ArticleFileDAO::getArticleFilesByArticle (   $articleId)

Retrieve all article files for an article.

Parameters
$articleIdint
Returns
array ArticleFiles

Definition at line 179 of file ArticleFileDAO.inc.php.

References _returnArticleFileFromRow(), and DAO\retrieve().

& ArticleFileDAO::getArticleFilesByAssocId (   $assocId,
  $fileStage 
)

Retrieve all article files for a file stage and assoc ID.

Parameters
$assocIdint
$fileStageint
Returns
array ArticleFiles

Definition at line 204 of file ArticleFileDAO.inc.php.

References _returnArticleFileFromRow(), and DAO\retrieve().

ArticleFileDAO::getInsertArticleFileId ( )

Get the ID of the last inserted article file.

Returns
int

Definition at line 375 of file ArticleFileDAO.inc.php.

References DAO\getInsertId().

Referenced by insertArticleFile().

& ArticleFileDAO::getRevisionNumber (   $fileId)

Retrieve the current revision number for a file.

Parameters
$fileIdint
Returns
int

Definition at line 151 of file ArticleFileDAO.inc.php.

References DAO\retrieve().

ArticleFileDAO::insertArticleFile ( $articleFile)

Insert a new ArticleFile.

Parameters
$articleFileArticleFile
Returns
int

Definition at line 255 of file ArticleFileDAO.inc.php.

References DAO\datetimeToDB(), getInsertArticleFileId(), and DAO\update().

ArticleFileDAO::updateArticleFile ( $articleFile)

Update an existing article file.

Parameters
$articleArticleFile

Definition at line 296 of file ArticleFileDAO.inc.php.

References DAO\datetimeToDB(), and DAO\update().


The documentation for this class was generated from the following file: