Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
ControlledVocabDAO Class Reference
Inheritance diagram for ControlledVocabDAO:
DAO CategoryDAO InterestDAO

Public Member Functions

 _fromRow (&$row)
 
 build ($symbolic, $assocType=0, $assocId=0)
 
 ControlledVocabDAO ()
 
 deleteObject ($controlledVocab)
 
 deleteObjectById ($controlledVocabId)
 
 enumerate ($controlledVocabId, $settingName= 'name')
 
 enumerateBySymbolic ($symbolic, $assocType, $assocId, $settingName= 'name')
 
 getById ($controlledVocabId)
 
 getBySymbolic ($symbolic, $assocType, $assocId)
 
getEntryDAO ()
 
 getInsertId ()
 
 insertObject (&$controlledVocab)
 
 newDataObject ()
 
 updateObject (&$controlledVocab)
 
- 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 ControlledVocab objects.

See Also
ControlledVocab

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

Member Function Documentation

ControlledVocabDAO::_fromRow ( $row)

Internal function to return an ControlledVocab object from a row.

Parameters
$rowarray
Returns
ControlledVocab

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

References newDataObject().

Referenced by getById(), and getBySymbolic().

ControlledVocabDAO::build (   $symbolic,
  $assocType = 0,
  $assocId = 0 
)

Fetch a controlled vocab by symbolic info, building it if needed.

Parameters
$symbolicstring
$assocTypeint
$assocIdint
Returns
$controlledVocab

Definition at line 61 of file ControlledVocabDAO.inc.php.

References getBySymbolic(), insertObject(), and newDataObject().

ControlledVocabDAO::ControlledVocabDAO ( )

Constructor

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

ControlledVocabDAO::deleteObject (   $controlledVocab)

Delete a controlled vocab.

Parameters
$controlledVocabControlledVocab
Returns
boolean

Definition at line 147 of file ControlledVocabDAO.inc.php.

References deleteObjectById().

ControlledVocabDAO::deleteObjectById (   $controlledVocabId)

Delete a controlled vocab by controlled vocab ID.

Parameters
$controlledVocabIdint
Returns
boolean

Definition at line 156 of file ControlledVocabDAO.inc.php.

References enumerate(), DAORegistry\getDAO(), and DAO\update().

Referenced by deleteObject().

ControlledVocabDAO::enumerate (   $controlledVocabId,
  $settingName = 'name' 
)

Get a list of controlled vocabulary options.

Parameters
$controlledVocabIdint
$settingNamestring optional
Returns
array $controlledVocabEntryId => name

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

References DAO\convertFromDB(), AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and DAO\retrieve().

Referenced by deleteObjectById().

ControlledVocabDAO::enumerateBySymbolic (   $symbolic,
  $assocType,
  $assocId,
  $settingName = 'name' 
)

Get a list of controlled vocabulary options.

Parameters
$symbolicstring
$assocTypeint
$assocIdint
$settingNamestring optional
Returns
array $controlledVocabEntryId => $settingValue

Definition at line 195 of file ControlledVocabDAO.inc.php.

References getBySymbolic().

Referenced by CategoryDAO\getCategories().

ControlledVocabDAO::getById (   $controlledVocabId)

Retrieve a controlled vocab by controlled vocab ID.

Parameters
$controlledVocabIdint
Returns
ControlledVocab

Definition at line 41 of file ControlledVocabDAO.inc.php.

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

ControlledVocabDAO::getBySymbolic (   $symbolic,
  $assocType,
  $assocId 
)

Retrieve an array of controlled vocabs matching the specified symbolic name and assoc info.

Parameters
$symbolicstring
$assocTypeint
$assocIdint

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

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

Referenced by build(), and enumerateBySymbolic().

& ControlledVocabDAO::getEntryDAO ( )

Return the Controlled Vocab Entry DAO for this Controlled Vocab. Can be subclassed to provide extended DAOs.

Definition at line 31 of file ControlledVocabDAO.inc.php.

References DAORegistry\getDAO().

Referenced by CategoryDAO\getCache(), and CategoryDAO\rebuildCache().

ControlledVocabDAO::getInsertId ( )

Get the ID of the last inserted controlled vocab.

Returns
int

Definition at line 247 of file ControlledVocabDAO.inc.php.

Referenced by insertObject().

ControlledVocabDAO::insertObject ( $controlledVocab)

Insert a new ControlledVocab.

Parameters
$controlledVocabControlledVocab
Returns
int

Definition at line 104 of file ControlledVocabDAO.inc.php.

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

Referenced by build().

ControlledVocabDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
ControlledVocabEntry

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

Referenced by _fromRow(), and build().

ControlledVocabDAO::updateObject ( $controlledVocab)

Update an existing controlled vocab.

Parameters
$controlledVocabControlledVocab
Returns
boolean

Definition at line 125 of file ControlledVocabDAO.inc.php.

References DAO\update().


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