Open Journal Systems  3.3.0
ArticleGalleyDAO Class Reference
Inheritance diagram for ArticleGalleyDAO:
SchemaDAO PKPPubIdPluginDAO DAO

Public Member Functions

 changePubId ($pubObjectId, $pubIdType, $pubId)
 
 deleteAllPubIds ($contextId, $pubIdType)
 
 deletePubId ($pubObjectId, $pubIdType)
 
 getByBestGalleyId ($galleyId, $publicationId)
 
 getByContextId ($journalId)
 
 getByFileId ($fileId)
 
 getByPublicationId ($publicationId, $contextId=null)
 
 getExportable ($contextId, $pubIdType=null, $title=null, $author=null, $issueId=null, $pubIdSettingName=null, $pubIdSettingValue=null, $rangeInfo=null)
 
 getGalleyByPubId ($pubIdType, $pubId, $publicationId=null)
 
 getGalleysBySetting ($settingName, $settingValue, $publicationId=null, $journalId=null)
 
 newDataObject ()
 
 pubIdExists ($pubIdType, $pubId, $excludePubObjectId, $contextId)
 
- Public Member Functions inherited from SchemaDAO
 _fromRow ($primaryRow)
 
 deleteById ($objectId)
 
 deleteObject ($object)
 
 getById ($objectId)
 
 getInsertId ()
 
 insertObject ($object)
 
 updateObject ($object)
 
- 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)
 
 getAdditionalFieldNames ()
 
 getAffectedRows ()
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
 
 getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getLocaleFieldNames ()
 
 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)
 

Data Fields

 $primaryKeyColumn = 'galley_id'
 
 $primaryTableColumns
 
 $schemaName = SCHEMA_GALLEY
 
 $settingsTableName = 'publication_galley_settings'
 
 $tableName = 'publication_galleys'
 
- Data Fields inherited from SchemaDAO
 $primaryKeyColumn
 
 $primaryTableColumns = array()
 
 $schemaName
 
 $settingsTableName
 
 $tableName
 
- Data Fields inherited from DAO
 $_dataSource
 

Additional Inherited Members

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

Detailed Description

Operations for retrieving and modifying ArticleGalley objects.

See also
ArticleGalley

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

Member Function Documentation

◆ changePubId()

ArticleGalleyDAO::changePubId (   $pubObjectId,
  $pubIdType,
  $pubId 
)

Change the public ID of a submission.

Parameters
$pubObjectIdint ID of the pub object
$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

Reimplemented from PKPPubIdPluginDAO.

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

References DAO\replace().

◆ deleteAllPubIds()

ArticleGalleyDAO::deleteAllPubIds (   $contextId,
  $pubIdType 
)

Delete the public IDs of all submissions in this context.

Parameters
$contextIdint
$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).

Reimplemented from PKPPubIdPluginDAO.

Definition at line 265 of file ArticleGalleyDAO.inc.php.

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

◆ deletePubId()

ArticleGalleyDAO::deletePubId (   $pubObjectId,
  $pubIdType 
)

Delete the public ID of a submission.

Parameters
$pubObjectIdint ID of the pub object
$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).

Reimplemented from PKPPubIdPluginDAO.

Definition at line 250 of file ArticleGalleyDAO.inc.php.

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

◆ getByBestGalleyId()

ArticleGalleyDAO::getByBestGalleyId (   $galleyId,
  $publicationId 
)

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

Parameters
$galleyIdstring
$publicationIdint
Returns
ArticleGalley object

Definition at line 178 of file ArticleGalleyDAO.inc.php.

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

◆ getByContextId()

ArticleGalleyDAO::getByContextId (   $journalId)

Retrieve all galleys of a journal.

Parameters
$journalIdint
Returns
DAOResultFactory

Definition at line 139 of file ArticleGalleyDAO.inc.php.

References DAO\retrieve().

Referenced by deleteAllPubIds().

◆ getByFileId()

ArticleGalleyDAO::getByFileId (   $fileId)

Retrieve all galleys with a particular file id

Parameters
$journalIdint
Returns
DAOResultFactory

Definition at line 160 of file ArticleGalleyDAO.inc.php.

References DAO\retrieve().

◆ getByPublicationId()

ArticleGalleyDAO::getByPublicationId (   $publicationId,
  $contextId = null 
)

Retrieves an iterator of representations for a publication

Parameters
$publicationIdint
$contextIdint
Returns
DAOResultFactory

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

References DAO\retrieve().

◆ getExportable()

ArticleGalleyDAO::getExportable (   $contextId,
  $pubIdType = null,
  $title = null,
  $author = null,
  $issueId = null,
  $pubIdSettingName = null,
  $pubIdSettingValue = null,
  $rangeInfo = null 
)

Get all published submission galleys (eventually with a pubId assigned and) matching the specified settings.

Parameters
$contextIdinteger optional
$pubIdTypestring
$titlestring optional
$authorstring optional
$issueIdinteger optional
$pubIdSettingNamestring optional (e.g. medra::status or medra::registeredDoi)
$pubIdSettingValuestring optional
$rangeInfoDBResultRange optional
Returns
DAOResultFactory

Definition at line 294 of file ArticleGalleyDAO.inc.php.

References DAO\retrieveRange().

◆ getGalleyByPubId()

ArticleGalleyDAO::getGalleyByPubId (   $pubIdType,
  $pubId,
  $publicationId = null 
)

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
$publicationIdint
Returns
ArticleGalley

Definition at line 64 of file ArticleGalleyDAO.inc.php.

References getGalleysBySetting().

◆ getGalleysBySetting()

ArticleGalleyDAO::getGalleysBySetting (   $settingName,
  $settingValue,
  $publicationId = null,
  $journalId = null 
)

Find galleys by querying galley settings.

Parameters
$settingNamestring
$settingValuemixed
$publicationIdint optional
$journalIdint optional
Returns
DAOResultFactory The factory for galleys identified by setting.

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

References DAO\retrieve().

Referenced by getGalleyByPubId().

◆ newDataObject()

ArticleGalleyDAO::newDataObject ( )

Return a new data object.

Returns
ArticleGalley

Reimplemented from SchemaDAO.

Definition at line 51 of file ArticleGalleyDAO.inc.php.

◆ pubIdExists()

ArticleGalleyDAO::pubIdExists (   $pubIdType,
  $pubId,
  $excludePubObjectId,
  $contextId 
)

Checks if public identifier exists (other than for the specified submission 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
$excludePubObjectIdint ID of the pub object to be excluded from the search.
$contextIdint
Returns
boolean

Reimplemented from PKPPubIdPluginDAO.

Definition at line 210 of file ArticleGalleyDAO.inc.php.

References DAO\retrieve().

Field Documentation

◆ $primaryKeyColumn

ArticleGalleyDAO::$primaryKeyColumn = 'galley_id'

Definition at line 32 of file ArticleGalleyDAO.inc.php.

◆ $primaryTableColumns

ArticleGalleyDAO::$primaryTableColumns
Initial value:
= [
'fileId' => 'file_id',
'id' => 'galley_id',
'isApproved' => 'is_approved',
'locale' => 'locale',
'label' => 'label',
'publicationId' => 'publication_id',
'seq' => 'seq',
'urlPath' => 'url_path',
'urlRemote' => 'remote_url',
]

Definition at line 35 of file ArticleGalleyDAO.inc.php.

◆ $schemaName

ArticleGalleyDAO::$schemaName = SCHEMA_GALLEY

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

◆ $settingsTableName

ArticleGalleyDAO::$settingsTableName = 'publication_galley_settings'

Definition at line 29 of file ArticleGalleyDAO.inc.php.

◆ $tableName

ArticleGalleyDAO::$tableName = 'publication_galleys'

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


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