Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SuppFileDAO Class Reference
Inheritance diagram for SuppFileDAO:
DAO

Public Member Functions

_returnSuppFileFromRow (&$row)
 
 changePubId ($suppFileId, $pubIdType, $pubId)
 
 deleteAllPubIds ($journalId, $pubIdType)
 
 deleteSuppFile (&$suppFile)
 
 deleteSuppFileById ($suppFileId, $articleId=null)
 
 deleteSuppFilesByArticle ($articleId)
 
 getAdditionalFieldNames ()
 
 getInsertSuppFileId ()
 
 getLocaleFieldNames ()
 
 getNextSuppFileSequence ($articleId)
 
getSuppFile ($suppFileId, $articleId=null)
 
getSuppFileByBestSuppFileId ($suppId, $articleId)
 
getSuppFileByPubId ($pubIdType, $pubId, $articleId=null)
 
getSuppFilesByArticle ($articleId)
 
getSuppFilesByJournalId ($journalId)
 
getSuppFilesBySetting ($settingName, $settingValue, $articleId=null, $journalId=null)
 
 insertSuppFile (&$suppFile)
 
 pubIdExists ($pubIdType, $pubId, $suppId, $journalId)
 
 resequenceSuppFiles ($articleId)
 
 suppFileExistsByFileId ($articleId, $fileId)
 
 updateLocaleFields (&$suppFile)
 
 updateSuppFile (&$suppFile)
 
- 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 SuppFile objects.

See Also
SuppFile

Definition at line 19 of file SuppFileDAO.inc.php.

Member Function Documentation

& SuppFileDAO::_returnSuppFileFromRow ( $row)

Internal function to return a SuppFile object from a row.

Parameters
$rowarray
Returns
SuppFile

Definition at line 192 of file SuppFileDAO.inc.php.

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

Referenced by getSuppFile(), getSuppFilesByArticle(), and getSuppFilesBySetting().

SuppFileDAO::changePubId (   $suppFileId,
  $pubIdType,
  $pubId 
)

Change the public ID of a supplementary file.

Parameters
$suppFileIdint
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).
$pubIdstring

Definition at line 442 of file SuppFileDAO.inc.php.

References DAO\replace().

SuppFileDAO::deleteAllPubIds (   $journalId,
  $pubIdType 
)

Delete the public IDs of all supplementary files in a journal.

Parameters
$journalIdint
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).

Definition at line 464 of file SuppFileDAO.inc.php.

References DAO\flushCache(), getSuppFilesByJournalId(), and DAO\update().

SuppFileDAO::deleteSuppFile ( $suppFile)

Delete a SuppFile.

Parameters
$suppFileSuppFile

Definition at line 287 of file SuppFileDAO.inc.php.

References deleteSuppFileById().

Referenced by deleteSuppFilesByArticle().

SuppFileDAO::deleteSuppFileById (   $suppFileId,
  $articleId = null 
)

Delete a supplementary file by ID.

Parameters
$suppFileIdint
$articleIdint optional

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

References DAO\update().

Referenced by deleteSuppFile().

SuppFileDAO::deleteSuppFilesByArticle (   $articleId)

Delete supplementary files by article.

Parameters
$articleIdint

Definition at line 314 of file SuppFileDAO.inc.php.

References deleteSuppFile(), and getSuppFilesByArticle().

SuppFileDAO::getAdditionalFieldNames ( )

Get a list of additional fields that do not have dedicated accessors.

Returns
array

Definition at line 170 of file SuppFileDAO.inc.php.

SuppFileDAO::getInsertSuppFileId ( )

Get the ID of the last inserted supplementary file.

Returns
int

Definition at line 387 of file SuppFileDAO.inc.php.

References DAO\getInsertId().

Referenced by insertSuppFile().

SuppFileDAO::getLocaleFieldNames ( )

Get the list of fields for which data is localized.

Returns
array

Definition at line 161 of file SuppFileDAO.inc.php.

SuppFileDAO::getNextSuppFileSequence (   $articleId)

Get the the next sequence number for an article's supplementary files (i.e., current max + 1).

Parameters
$articleIdint
Returns
int

Definition at line 370 of file SuppFileDAO.inc.php.

References DAO\retrieve().

Referenced by insertSuppFile().

& SuppFileDAO::getSuppFile (   $suppFileId,
  $articleId = null 
)

Retrieve a supplementary file by ID.

Parameters
$suppFileIdint
$articleIdint optional
Returns
SuppFile

Definition at line 26 of file SuppFileDAO.inc.php.

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

Referenced by getSuppFileByBestSuppFileId().

& SuppFileDAO::getSuppFileByBestSuppFileId (   $suppId,
  $articleId 
)

Retrieve supp file by public supp file id or, failing that, internal supp file ID; public ID takes precedence.

Parameters
$suppIdstring
$articleIdint
Returns
SuppFile object

Definition at line 398 of file SuppFileDAO.inc.php.

References getSuppFile(), and getSuppFileByPubId().

& SuppFileDAO::getSuppFileByPubId (   $pubIdType,
  $pubId,
  $articleId = null 
)

Retrieve a supplementary file by public supp file ID.

Parameters
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).
$pubIdstring
$articleIdint
Returns
SuppFile

Definition at line 55 of file SuppFileDAO.inc.php.

References getSuppFilesBySetting().

Referenced by getSuppFileByBestSuppFileId().

& SuppFileDAO::getSuppFilesByArticle (   $articleId)

Retrieve all supplementary files for an article.

Parameters
$articleIdint
Returns
array SuppFiles

Definition at line 117 of file SuppFileDAO.inc.php.

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

Referenced by deleteSuppFilesByArticle().

& SuppFileDAO::getSuppFilesByJournalId (   $journalId)

Retrieve all supplementary files of a journal.

Parameters
$journalIdint
Returns
DAOResultFactory

Definition at line 141 of file SuppFileDAO.inc.php.

References DAO\retrieve().

Referenced by deleteAllPubIds().

& SuppFileDAO::getSuppFilesBySetting (   $settingName,
  $settingValue,
  $articleId = null,
  $journalId = null 
)

Find supp files by querying supp file settings.

Parameters
$settingNamestring
$settingValuemixed
$articleIdint optional
$journalIdint optional
Returns
array The supp files identified by setting.

Definition at line 75 of file SuppFileDAO.inc.php.

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

Referenced by getSuppFileByPubId().

SuppFileDAO::insertSuppFile ( $suppFile)
SuppFileDAO::pubIdExists (   $pubIdType,
  $pubId,
  $suppId,
  $journalId 
)

Checks if public identifier exists (other than for the specified supplementary file ID, which is treated as an exception).

Parameters
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).
$pubIdstring
$suppIdint An ID to be excluded from the search.
$journalIdint
Returns
boolean

Definition at line 415 of file SuppFileDAO.inc.php.

References DAO\retrieve().

SuppFileDAO::resequenceSuppFiles (   $articleId)

Sequentially renumber supplementary files for an article in their sequence order.

Parameters
$articleIdint

Definition at line 346 of file SuppFileDAO.inc.php.

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

SuppFileDAO::suppFileExistsByFileId (   $articleId,
  $fileId 
)

Check if a supplementary file exists with the associated file ID.

Parameters
$articleIdint
$fileIdint
Returns
boolean

Definition at line 327 of file SuppFileDAO.inc.php.

References DAO\retrieve().

SuppFileDAO::updateLocaleFields ( $suppFile)

Update the localized fields for this supp file.

Parameters
$suppFile

Definition at line 181 of file SuppFileDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertSuppFile(), and updateSuppFile().

SuppFileDAO::updateSuppFile ( $suppFile)

Update an existing SuppFile.

Parameters
$suppFileSuppFile

Definition at line 256 of file SuppFileDAO.inc.php.

References DAO\dateToDB(), DAO\update(), and updateLocaleFields().


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