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

Public Member Functions

_returnFromRow ($code, &$entry)
 
 CodelistItemDAO ()
 
getByCode ($code)
 
 getCacheName ()
 
getCodelistItems ($locale=null)
 
 getFilename ($locale)
 
 getName ()
 
getNames ($locale=null)
 
 newDataObject ()
 
- 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

Parent class for operations involving Codelist objects.

See Also
CodelistItem

Definition at line 20 of file CodelistItemDAO.inc.php.

Member Function Documentation

& CodelistItemDAO::_returnFromRow (   $code,
$entry 
)

Internal function to return a Codelist object from a row.

Parameters
$rowarray
Returns
CodelistItem

Definition at line 164 of file CodelistItemDAO.inc.php.

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

Referenced by getByCode(), and getCodelistItems().

CodelistItemDAO::CodelistItemDAO ( )

Constructor.

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

& CodelistItemDAO::getByCode (   $code)

Retrieve a codelist by code.

Parameters
$codelistIdint
Returns
CodelistItem

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

References _returnFromRow().

CodelistItemDAO::getCacheName ( )

Get the cache name for this particular codelist database

Returns
string

Definition at line 88 of file CodelistItemDAO.inc.php.

References getName().

& CodelistItemDAO::getCodelistItems (   $locale = null)

Retrieve an array of all the codelist items.

Parameters
$localean optional locale to use
Returns
array of CodelistItems

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

References _returnFromRow().

CodelistItemDAO::getFilename (   $locale)

Get the filename of the codelist database

Parameters
$localestring
Returns
string

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

CodelistItemDAO::getName ( )

Get the base node name particular codelist database

Returns
string

Definition at line 105 of file CodelistItemDAO.inc.php.

Referenced by getCacheName().

& CodelistItemDAO::getNames (   $locale = null)

Retrieve an array of all codelist names.

Parameters
$localean optional locale to use
Returns
array of CodelistItem names

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

CodelistItemDAO::newDataObject ( )

Get the name of the CodelistItem subclass.

Returns
String

Definition at line 113 of file CodelistItemDAO.inc.php.

Referenced by _returnFromRow().


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