Open Journal Systems  3.3.0
ControlledVocabEntryDAO Class Reference
Inheritance diagram for ControlledVocabEntryDAO:
DAO InterestEntryDAO SubmissionAgencyEntryDAO SubmissionDisciplineEntryDAO SubmissionKeywordEntryDAO SubmissionLanguageEntryDAO SubmissionSubjectEntryDAO

Public Member Functions

 _fromRow ($row)
 
 deleteObject ($controlledVocabEntry)
 
 deleteObjectById ($controlledVocabEntryId)
 
 getByContextId ($symbolic, $contextId, $locale)
 
 getByControlledVocabId ($controlledVocabId, $rangeInfo=null, $filter=null)
 
 getById ($controlledVocabEntryId, $controlledVocabId=null)
 
 getBySetting ($settingValue, $symbolic, $assocType=0, $assocId=0, $settingName='name', $locale='')
 
 getInsertId ()
 
 getLocaleFieldNames ()
 
 getSettingsDAO ()
 
 insertObject ($controlledVocabEntry)
 
 newDataObject ()
 
 resequence ($controlledVocabId)
 
 updateLocaleFields ($controlledVocabEntry)
 
 updateObject ($controlledVocabEntry)
 
- 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 ()
 
 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 ControlledVocabEntry objects.

See also
ControlledVocabEntry

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

Member Function Documentation

◆ _fromRow()

ControlledVocabEntryDAO::_fromRow (   $row)

Internal function to return an ControlledVocabEntry object from a row.

Parameters
$rowarray
Returns
ControlledVocabEntry

Definition at line 101 of file ControlledVocabEntryDAO.inc.php.

References DAO\getDataObjectSettings(), and newDataObject().

Referenced by getById(), and getBySetting().

◆ deleteObject()

ControlledVocabEntryDAO::deleteObject (   $controlledVocabEntry)

Delete a controlled vocab entry.

Parameters
$controlledVocabEntryControlledVocabEntry

Definition at line 153 of file ControlledVocabEntryDAO.inc.php.

References deleteObjectById().

◆ deleteObjectById()

ControlledVocabEntryDAO::deleteObjectById (   $controlledVocabEntryId)

Delete a controlled vocab entry by controlled vocab entry ID.

Parameters
$controlledVocabEntryIdint

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

References DAO\update().

Referenced by deleteObject().

◆ getByContextId()

ControlledVocabEntryDAO::getByContextId (   $symbolic,
  $contextId,
  $locale 
)

Retrieve an array of controlled vocab entries that exist for a given context (assigned to at least one submission in that context) and which match the requested symbolic (eg - keywords/subjects)

Parameters
$symbolicstring One of the CONTROLLED_VOCAB_* constants
$contextIdint
$localestring
Returns
array

Definition at line 201 of file ControlledVocabEntryDAO.inc.php.

References DAO\retrieve().

◆ getByControlledVocabId()

ControlledVocabEntryDAO::getByControlledVocabId (   $controlledVocabId,
  $rangeInfo = null,
  $filter = null 
)

Retrieve an iterator of controlled vocabulary entries matching a particular controlled vocabulary ID.

Parameters
$controlledVocabIdint
Returns
object DAOResultFactory containing matching CVE objects

Reimplemented in InterestEntryDAO, SubmissionAgencyEntryDAO, SubmissionDisciplineEntryDAO, SubmissionKeywordEntryDAO, SubmissionLanguageEntryDAO, and SubmissionSubjectEntryDAO.

Definition at line 173 of file ControlledVocabEntryDAO.inc.php.

References DAO\retrieveRange().

◆ getById()

ControlledVocabEntryDAO::getById (   $controlledVocabEntryId,
  $controlledVocabId = null 
)

Retrieve a controlled vocab entry by controlled vocab entry ID.

Parameters
$controlledVocabEntryIdint
$controlledVocabEntryint optional
Returns
ControlledVocabEntry

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

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

◆ getBySetting()

ControlledVocabEntryDAO::getBySetting (   $settingValue,
  $symbolic,
  $assocType = 0,
  $assocId = 0,
  $settingName = 'name',
  $locale = '' 
)

Retrieve a controlled vocab entry by resolving one of its settings to the corresponding entry id.

Parameters
$settingValuestring the setting value to be searched for
$symbolicstring the vocabulary to be searched, identified by its symbolic name
$assocTypeinteger
$assocIdinteger
$settingNamestring the setting to be searched
$localestring
Returns
ControlledVocabEntry

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

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

◆ getInsertId()

ControlledVocabEntryDAO::getInsertId ( )

Get the ID of the last inserted controlled vocab.

Returns
int

Definition at line 274 of file ControlledVocabEntryDAO.inc.php.

Referenced by insertObject().

◆ getLocaleFieldNames()

ControlledVocabEntryDAO::getLocaleFieldNames ( )

Get the list of fields for which data can be localized.

Returns
array

Reimplemented from DAO.

Definition at line 116 of file ControlledVocabEntryDAO.inc.php.

◆ getSettingsDAO()

ControlledVocabEntryDAO::getSettingsDAO ( )

Return the entry settings DAO. Can be subclassed to provide extended DAOs.

Definition at line 25 of file ControlledVocabEntryDAO.inc.php.

References DAORegistry\getDAO().

◆ insertObject()

ControlledVocabEntryDAO::insertObject (   $controlledVocabEntry)

Insert a new ControlledVocabEntry.

Parameters
$controlledVocabEntryControlledVocabEntry
Returns
int Inserted controlled vocabulary entry ID

Definition at line 135 of file ControlledVocabEntryDAO.inc.php.

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

◆ newDataObject()

ControlledVocabEntryDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
ControlledVocabEntry

Reimplemented in InterestEntryDAO, SubmissionAgencyEntryDAO, SubmissionDisciplineEntryDAO, SubmissionKeywordEntryDAO, SubmissionLanguageEntryDAO, and SubmissionSubjectEntryDAO.

Definition at line 91 of file ControlledVocabEntryDAO.inc.php.

Referenced by _fromRow().

◆ resequence()

ControlledVocabEntryDAO::resequence (   $controlledVocabId)

Sequentially renumber entries in their sequence order.

Parameters
$controlledVocabIdint Controlled vocabulary ID

Definition at line 248 of file ControlledVocabEntryDAO.inc.php.

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

◆ updateLocaleFields()

ControlledVocabEntryDAO::updateLocaleFields (   $controlledVocabEntry)

Update the localized fields for this table

Parameters
$controlledVocabEntryobject

Definition at line 124 of file ControlledVocabEntryDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

◆ updateObject()

ControlledVocabEntryDAO::updateObject (   $controlledVocabEntry)

Update an existing review form element.

Parameters
$controlledVocabEntryControlledVocabEntry

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

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


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