Open Journal Systems  3.3.0
IssueGalleyDAO Class Reference
Inheritance diagram for IssueGalleyDAO:
DAO

Public Member Functions

 _fromRow ($row)
 
 deleteById ($galleyId, $issueId=null)
 
 deleteByIssueId ($issueId)
 
 deleteObject ($galley)
 
 getAdditionalFieldNames ()
 
 getByBestId ($galleyId, $issueId)
 
 getById ($galleyId, $issueId=null)
 
 getByIssueId ($issueId)
 
 getByPubId ($pubIdType, $pubId, $issueId)
 
 getInsertId ()
 
 getLocaleFieldNames ()
 
 getNextGalleySequence ($issueId)
 
 insertObject ($galley)
 
 newDataObject ()
 
 pubIdExists ($pubIdType, $pubId, $galleyId, $journalId)
 
 resequence ($issueId)
 
 updateLocaleFields ($galley)
 
 updateObject ($galley)
 
- Public Member Functions inherited from DAO
 __construct ($dataSource=null, $callHooks=true)
 
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
 
 getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getType ($value)
 
 handleError ($dataSource, $sql)
 
 nullOrInt ($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

- Static Public Member Functions inherited from DAO
static getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
 
- Data Fields inherited from DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table='', $id='')
 

Detailed Description

Operations for retrieving and modifying IssueGalley objects.

See also
IssueGalley

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

Member Function Documentation

◆ _fromRow()

IssueGalleyDAO::_fromRow (   $row)

Internal function to return an IssueGalley object from a row.

Parameters
$rowarray
Returns
IssueGalley

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

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

Referenced by getByBestId(), getById(), getByIssueId(), and getByPubId().

◆ deleteById()

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

Delete a galley by ID.

Parameters
$galleyIdint
$issueIdint optional

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

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

Referenced by deleteByIssueId(), and deleteObject().

◆ deleteByIssueId()

IssueGalleyDAO::deleteByIssueId (   $issueId)

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

Parameters
$issueIdint

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

References deleteById(), and getByIssueId().

◆ deleteObject()

IssueGalleyDAO::deleteObject (   $galley)

Delete an IssueGalley.

Parameters
$galleyIssueGalley

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

References deleteById().

◆ getAdditionalFieldNames()

IssueGalleyDAO::getAdditionalFieldNames ( )

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

Returns
array

Reimplemented from DAO.

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

◆ getByBestId()

IssueGalleyDAO::getByBestId (   $galleyId,
  $issueId 
)

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

Parameters
$galleyIdstring
$issueIdint
Returns
IssueGalley object

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

References _fromRow(), getById(), and DAO\retrieve().

◆ getById()

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

Retrieve a galley by ID.

Parameters
$galleyIdint
$issueIdint optional
Returns
IssueGalley

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

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

Referenced by getByBestId().

◆ getByIssueId()

IssueGalleyDAO::getByIssueId (   $issueId)

Retrieve all galleys for an issue.

Parameters
$issueIdint
Returns
array IssueGalleys

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

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

Referenced by deleteByIssueId().

◆ getByPubId()

IssueGalleyDAO::getByPubId (   $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 96 of file IssueGalleyDAO.inc.php.

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

◆ getInsertId()

IssueGalleyDAO::getInsertId ( )

Get the ID of the last inserted gallery.

Returns
int

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

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLocaleFieldNames()

IssueGalleyDAO::getLocaleFieldNames ( )

Get the list of fields for which data is localized.

Returns
array

Reimplemented from DAO.

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

◆ getNextGalleySequence()

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 397 of file IssueGalleyDAO.inc.php.

References DAO\retrieve().

◆ insertObject()

IssueGalleyDAO::insertObject (   $galley)

Insert a new IssueGalley.

Parameters
$galleyIssueGalley

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

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

◆ newDataObject()

IssueGalleyDAO::newDataObject ( )

Construct a new issue galley.

Returns
IssueGalley

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

Referenced by _fromRow().

◆ pubIdExists()

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 68 of file IssueGalleyDAO.inc.php.

References DAO\retrieve().

◆ resequence()

IssueGalleyDAO::resequence (   $issueId)

Sequentially renumber galleys for an issue in their sequence order.

Parameters
$issueIdint

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

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

◆ updateLocaleFields()

IssueGalleyDAO::updateLocaleFields (   $galley)

Update the localized fields for this galley.

Parameters
$galley

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

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

◆ updateObject()

IssueGalleyDAO::updateObject (   $galley)

Update an existing IssueGalley.

Parameters
$galleyIssueGalley

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

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


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