Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PublicationFormatDAO Class Reference
Inheritance diagram for PublicationFormatDAO:
RepresentationDAO DAO

Public Member Functions

 _fromRow ($row, $callHooks=true)
 
 changePubId ($formatId, $pubIdType, $pubId)
 
 deleteAllPubIds ($pressId, $pubIdType)
 
 deleteById ($publicationFormatId)
 
 getAdditionalFieldNames ()
 
 getApprovedBySubmissionId ($submissionId)
 
 getById ($publicationFormatId, $monographId=null, $pressId=null)
 
 getByPressId ($pressId)
 
 getBySubmissionId ($submissionId)
 
 getLocaleFieldNames ()
 
 insertObject (&$publicationFormat)
 
 newDataObject ()
 
 pubIdExists ($pubIdType, $pubId, $formatId, $pressId)
 
 PublicationFormatDAO ()
 
 updateLocaleFields (&$publicationFormat)
 
 updateObject (&$publicationFormat)
 
- Public Member Functions inherited from RepresentationDAO
 getBySubmissionId ($submissionId)
 
 RepresentationDAO ()
 
- 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 ()
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 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

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

Detailed Description

Operations for retrieving and modifying PublicationFormat objects.

See Also
PublicationFormat

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

Member Function Documentation

PublicationFormatDAO::_fromRow (   $row,
  $callHooks = true 
)

Internal function to return an PublicationFormat object from a row.

Parameters
$rowarray
$callHooksboolean
Returns
PublicationFormat

Definition at line 144 of file PublicationFormatDAO.inc.php.

References HookRegistry\call(), and newDataObject().

Referenced by getById().

PublicationFormatDAO::changePubId (   $formatId,
  $pubIdType,
  $pubId 
)

Change the public ID of a format.

Parameters
$formatIdint
$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 337 of file PublicationFormatDAO.inc.php.

References getById(), and updateObject().

PublicationFormatDAO::deleteAllPubIds (   $pressId,
  $pubIdType 
)

Delete the public IDs of all publication formats in a press.

Parameters
$pressIdint
$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 312 of file PublicationFormatDAO.inc.php.

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

PublicationFormatDAO::deleteById (   $publicationFormatId)

Delete an publication format by ID.

Parameters
$publicationFormatIdint

Definition at line 112 of file PublicationFormatDAO.inc.php.

References DAO\update().

PublicationFormatDAO::getAdditionalFieldNames ( )
See Also
DAO::getAdditionalFieldNames()

Definition at line 298 of file PublicationFormatDAO.inc.php.

PublicationFormatDAO::getApprovedBySubmissionId (   $submissionId)

Retrieves a list of approved publication formats for a published submission

Parameters
int$submissionId
Returns
DAOResultFactory (PublicationFormat)

Definition at line 97 of file PublicationFormatDAO.inc.php.

References DAO\retrieve().

PublicationFormatDAO::getById (   $publicationFormatId,
  $monographId = null,
  $pressId = null 
)

Retrieve a publication format by type id.

Parameters
$publicationFormatIdint
$monographIdoptional int
$pressIdoptional int
Returns
PublicationFormat

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

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

Referenced by changePubId().

PublicationFormatDAO::getByPressId (   $pressId)

Retrieves a list of publication formats for a press

Parameters
intpressId
Returns
DAOResultFactory (PublicationFormat)

Definition at line 79 of file PublicationFormatDAO.inc.php.

References DAO\retrieve().

Referenced by deleteAllPubIds().

PublicationFormatDAO::getBySubmissionId (   $submissionId)

Retrieves a list of publication formats for a submission

Parameters
int$submissionIdint
Returns
DAOResultFactory (PublicationFormat)

Definition at line 63 of file PublicationFormatDAO.inc.php.

References DAO\retrieve().

PublicationFormatDAO::getLocaleFieldNames ( )

Get a list of fields for which we store localized data

Returns
array

Definition at line 291 of file PublicationFormatDAO.inc.php.

PublicationFormatDAO::insertObject ( $publicationFormat)

Insert a publication format.

Parameters
$publicationFormatPublicationFormat
Returns
int the publication format id.

Definition at line 185 of file PublicationFormatDAO.inc.php.

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

PublicationFormatDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
PublicationFormat

Definition at line 134 of file PublicationFormatDAO.inc.php.

Referenced by _fromRow().

PublicationFormatDAO::pubIdExists (   $pubIdType,
  $pubId,
  $formatId,
  $pressId 
)

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

Definition at line 354 of file PublicationFormatDAO.inc.php.

References DAO\retrieve().

PublicationFormatDAO::PublicationFormatDAO ( )

Constructor

Definition at line 23 of file PublicationFormatDAO.inc.php.

PublicationFormatDAO::updateLocaleFields ( $publicationFormat)

Update the settings for this object

Parameters
$publicationFormatobject

Definition at line 122 of file PublicationFormatDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

PublicationFormatDAO::updateObject ( $publicationFormat)

Update an existing publication format.

Parameters
$publicationFormatPublicationFormat

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

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

Referenced by changePubId().


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