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

Public Member Functions

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

See Also
ControlledVocabEntry

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

Member Function Documentation

ControlledVocabEntryDAO::_fromRow ( $row)

Internal function to return an ControlledVocabEntry object from a row.

Parameters
$rowarray
Returns
ControlledVocabEntry

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

References newDataObject().

Referenced by getById(), and getBySetting().

ControlledVocabEntryDAO::ControlledVocabEntryDAO ( )

Constructor

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

ControlledVocabEntryDAO::deleteObject (   $controlledVocabEntry)

Delete a controlled vocab entry.

Parameters
$controlledVocabEntryControlledVocabEntry
Returns
boolean

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

References deleteObjectById().

ControlledVocabEntryDAO::deleteObjectById (   $controlledVocabEntryId)

Delete a controlled vocab entry by controlled vocab entry ID.

Parameters
$controlledVocabEntryIdint
Returns
boolean

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

References DAO\update().

Referenced by deleteObject().

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

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

References DAO\retrieveRange().

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

Retrieve a controlled vocab entry by controlled vocab entry ID.

Parameters
$controlledVocabEntryIdint
$controlledVocabEntryint optional
Returns
ControlledVocabEntry

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

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

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 62 of file ControlledVocabEntryDAO.inc.php.

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

ControlledVocabEntryDAO::getInsertId ( )

Get the ID of the last inserted controlled vocab.

Returns
int

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

Referenced by insertObject().

ControlledVocabEntryDAO::getLocaleFieldNames ( )

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

Returns
array

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

ControlledVocabEntryDAO::insertObject ( $controlledVocabEntry)

Insert a new ControlledVocabEntry.

Parameters
$controlledVocabEntryControlledVocabEntry
Returns
int

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

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

ControlledVocabEntryDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
ControlledVocabEntry

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

Referenced by _fromRow().

ControlledVocabEntryDAO::resequence (   $controlledVocabId)

Sequentially renumber entries in their sequence order.

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

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

ControlledVocabEntryDAO::updateLocaleFields ( $controlledVocabEntry)

Update the localized fields for this table

Parameters
$controlledVocabEntryobject

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

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

ControlledVocabEntryDAO::updateObject ( $controlledVocabEntry)

Update an existing review form element.

Parameters
$controlledVocabEntryControlledVocabEntry

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

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


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