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

Public Member Functions

_returnGalleyFromRow (&$row)
 
 deleteGalley (&$galley)
 
 deleteGalleyById ($galleyId, $issueId=null)
 
 deleteGalleysByIssue ($issueId)
 
 galleyExistsByFileId ($issueId, $fileId)
 
 getAdditionalFieldNames ()
 
getGalley ($galleyId, $issueId=null)
 
getGalleyByBestGalleyId ($galleyId, $issueId)
 
getGalleyByPubId ($pubIdType, $pubId, $issueId)
 
getGalleysByIssue ($issueId)
 
 getInsertGalleyId ()
 
 getLocaleFieldNames ()
 
 getNextGalleySequence ($issueId)
 
 incrementViews ($galleyId)
 
 insertGalley (&$galley)
 
 IssueGalleyDAO ()
 
 pubIdExists ($pubIdType, $pubId, $galleyId, $journalId)
 
 resequenceGalleys ($issueId)
 
 updateGalley (&$galley)
 
 updateLocaleFields (&$galley)
 
- 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 IssueGalley objects.

See Also
IssueGalley

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

Member Function Documentation

& IssueGalleyDAO::_returnGalleyFromRow ( $row)

Internal function to return an IssueGalley object from a row.

Parameters
$rowarray
Returns
IssueGalley

Definition at line 227 of file IssueGalleyDAO.inc.php.

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

Referenced by getGalley(), getGalleyByPubId(), and getGalleysByIssue().

IssueGalleyDAO::deleteGalley ( $galley)

Delete an IssueGalley.

Parameters
$galleyIssueGalley

Definition at line 311 of file IssueGalleyDAO.inc.php.

References deleteGalleyById().

IssueGalleyDAO::deleteGalleyById (   $galleyId,
  $issueId = null 
)

Delete a galley by ID.

Parameters
$galleyIdint
$issueIdint optional

Definition at line 320 of file IssueGalleyDAO.inc.php.

References HookRegistry\call(), DAO\getAffectedRows(), and DAO\update().

Referenced by deleteGalley(), and deleteGalleysByIssue().

IssueGalleyDAO::deleteGalleysByIssue (   $issueId)

Delete galleys by issue. NOTE that this will not delete issue_file entities or the respective files.

Parameters
$issueIdint

Definition at line 343 of file IssueGalleyDAO.inc.php.

References deleteGalleyById(), and getGalleysByIssue().

IssueGalleyDAO::galleyExistsByFileId (   $issueId,
  $fileId 
)

Check if a galley exists with the associated file ID.

Parameters
$issueIdint
$fileIdint
Returns
boolean

Definition at line 356 of file IssueGalleyDAO.inc.php.

References DAO\retrieve().

IssueGalleyDAO::getAdditionalFieldNames ( )

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

Returns
array

Definition at line 205 of file IssueGalleyDAO.inc.php.

& IssueGalleyDAO::getGalley (   $galleyId,
  $issueId = null 
)

Retrieve a galley by ID.

Parameters
$galleyIdint
$issueIdint optional
Returns
IssueGalley

Definition at line 34 of file IssueGalleyDAO.inc.php.

References _returnGalleyFromRow(), HookRegistry\call(), and DAO\retrieve().

Referenced by getGalleyByBestGalleyId().

& IssueGalleyDAO::getGalleyByBestGalleyId (   $galleyId,
  $issueId 
)

Retrieve issue galley by public galley id or, failing that, internal galley ID; public galley ID takes precedence.

Parameters
$galleyIdstring
$issueIdint
Returns
galley object

Definition at line 186 of file IssueGalleyDAO.inc.php.

References getGalley(), and getGalleyByPubId().

& IssueGalleyDAO::getGalleyByPubId (   $pubIdType,
  $pubId,
  $issueId 
)

Retrieve a galley by 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
$issueIdint
Returns
IssueGalley

Definition at line 109 of file IssueGalleyDAO.inc.php.

References _returnGalleyFromRow(), HookRegistry\call(), and DAO\retrieve().

Referenced by getGalleyByBestGalleyId().

& IssueGalleyDAO::getGalleysByIssue (   $issueId)

Retrieve all galleys for an issue.

Parameters
$issueIdint
Returns
array IssueGalleys

Definition at line 147 of file IssueGalleyDAO.inc.php.

References _returnGalleyFromRow(), HookRegistry\call(), and DAO\retrieve().

Referenced by deleteGalleysByIssue().

IssueGalleyDAO::getInsertGalleyId ( )

Get the ID of the last inserted gallery.

Returns
int

Definition at line 429 of file IssueGalleyDAO.inc.php.

References DAO\getInsertId().

Referenced by insertGalley().

IssueGalleyDAO::getLocaleFieldNames ( )

Get the list of fields for which data is localized.

Returns
array

Definition at line 196 of file IssueGalleyDAO.inc.php.

IssueGalleyDAO::getNextGalleySequence (   $issueId)

Get the the next sequence number for an issue's galleys (i.e., current max + 1).

Parameters
$issueIdint
Returns
int

Definition at line 412 of file IssueGalleyDAO.inc.php.

References DAO\retrieve().

Referenced by insertGalley().

IssueGalleyDAO::incrementViews (   $galleyId)

Increment the views count for a galley.

Parameters
$galleyIdint

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

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

IssueGalleyDAO::insertGalley ( $galley)
IssueGalleyDAO::IssueGalleyDAO ( )

Constructor.

Definition at line 24 of file IssueGalleyDAO.inc.php.

IssueGalleyDAO::pubIdExists (   $pubIdType,
  $pubId,
  $galleyId,
  $journalId 
)

Checks if public identifier exists (other than for the specified galley 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
$galleyIdint An ID to be excluded from the search.
$journalIdint
Returns
boolean

Definition at line 78 of file IssueGalleyDAO.inc.php.

References DAO\retrieve().

IssueGalleyDAO::resequenceGalleys (   $issueId)

Sequentially renumber galleys for an issue in their sequence order.

Parameters
$issueIdint

Definition at line 388 of file IssueGalleyDAO.inc.php.

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

IssueGalleyDAO::updateGalley ( $galley)

Update an existing IssueGalley.

Parameters
$galleyIssueGalley

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

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

IssueGalleyDAO::updateLocaleFields ( $galley)

Update the localized fields for this galley.

Parameters
$galley

Definition at line 216 of file IssueGalleyDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertGalley(), and updateGalley().


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