Public Member Functions

GenreDAO Class Reference
[Monograph]

Operations for retrieving and modifying Genre objects. More...

Inheritance diagram for GenreDAO:
DefaultSettingDAO

List of all members.

Public Member Functions

& _fromRow (&$row)
 deleteById ($entryId)
 deleteByPressId ($pressId)
 deleteObject ($genre)
 GenreDAO ()
& getById ($genreId, $pressId=null)
 getDefaultBaseFilename ()
 getDefaultType ()
& getEnabledByPressId ($pressId, $rangeInfo=null)
 getInsertGenreId ()
 getLocaleFieldNames ()
 getPrimaryKeyColumnName ()
& getSettingAttributes ($node=null, $locale=null)
 getSettingsTableName ()
 getTableName ()
 insertObject (&$genre)
 installDefaultBase ($pressId)
 newDataObject ()
 updateLocaleFields (&$genre)
 updateObject (&$genre)

Detailed Description

Operations for retrieving and modifying Genre objects.

See also:
Genre

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

Member Function Documentation

& GenreDAO._fromRow ( &$  row  ) 

Internal function to return a Genre object from a row.

Parameters:
$row array
Returns:
Genre

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

References newDataObject().

Referenced by getById().

GenreDAO.deleteById ( $  entryId  ) 

Soft delete a genre by id.

Parameters:
$entryId int

Definition at line 159 of file GenreDAO.inc.php.

Referenced by deleteObject().

GenreDAO.deleteByPressId ( $  pressId  ) 

delete the genre entries associated with a press. Called when deleting a Press in PressDAO.

Parameters:
$pressId int

Definition at line 170 of file GenreDAO.inc.php.

GenreDAO.deleteObject ( $  genre  ) 

Delete a genre by id.

Parameters:
$genre Genre

Definition at line 151 of file GenreDAO.inc.php.

References deleteById().

GenreDAO.GenreDAO (  ) 

Constructor

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

References DefaultSettingDAO.DefaultSettingDAO().

& GenreDAO.getById ( $  genreId,
$  pressId = null 
)

Retrieve a genre by type id.

Parameters:
$genreId int
Returns:
Genre

Definition at line 39 of file GenreDAO.inc.php.

References _fromRow().

GenreDAO.getDefaultBaseFilename (  ) 

Get the path of the setting data file.

Returns:
string

Reimplemented from DefaultSettingDAO.

Definition at line 212 of file GenreDAO.inc.php.

Referenced by installDefaultBase().

GenreDAO.getDefaultType (  ) 

Get the default type constant.

Returns:
int

Reimplemented from DefaultSettingDAO.

Definition at line 204 of file GenreDAO.inc.php.

& GenreDAO.getEnabledByPressId ( $  pressId,
$  rangeInfo = null 
)

Retrieve all genres

Parameters:
$pressId int
$enabledOnly boolean optional
$rangeInfo object optional
Returns:
DAOResultFactory containing matching genres

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

GenreDAO.getInsertGenreId (  ) 

Get the ID of the last inserted genre.

Returns:
int

Definition at line 180 of file GenreDAO.inc.php.

Referenced by insertObject().

GenreDAO.getLocaleFieldNames (  ) 

Get a list of field names for which data is localized.

Returns:
array

Definition at line 74 of file GenreDAO.inc.php.

GenreDAO.getPrimaryKeyColumnName (  ) 
See also:
DefaultSettingsDAO.getPrimaryKeyColumnName()

Reimplemented from DefaultSettingDAO.

Definition at line 30 of file GenreDAO.inc.php.

& GenreDAO.getSettingAttributes ( $  node = null,
$  locale = null 
)

Get setting names and values.

Parameters:
$node XMLNode
$locale string
Returns:
array

Definition at line 246 of file GenreDAO.inc.php.

GenreDAO.getSettingsTableName (  ) 

Get the name of the settings table.

Returns:
string

Reimplemented from DefaultSettingDAO.

Definition at line 188 of file GenreDAO.inc.php.

GenreDAO.getTableName (  ) 

Get the name of the main table for this setting group.

Returns:
string

Reimplemented from DefaultSettingDAO.

Definition at line 196 of file GenreDAO.inc.php.

GenreDAO.insertObject ( &$  genre  ) 

Insert a new genre.

Parameters:
$genre Genre

Definition at line 119 of file GenreDAO.inc.php.

References getInsertGenreId(), and updateLocaleFields().

GenreDAO.installDefaultBase ( $  pressId  ) 

Install genres from an XML file.

Parameters:
$pressId int
Returns:
boolean

Reimplemented from DefaultSettingDAO.

Definition at line 221 of file GenreDAO.inc.php.

References getDefaultBaseFilename().

GenreDAO.newDataObject (  ) 

Construct a new data object corresponding to this DAO.

Returns:
Genre

Definition at line 92 of file GenreDAO.inc.php.

Referenced by _fromRow().

GenreDAO.updateLocaleFields ( &$  genre  ) 

Update the settings for this object

Parameters:
$genre object

Definition at line 82 of file GenreDAO.inc.php.

Referenced by insertObject(), and updateObject().

GenreDAO.updateObject ( &$  genre  ) 

Update an existing genre.

Parameters:
$genre Genre

Definition at line 143 of file GenreDAO.inc.php.

References updateLocaleFields().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:57 for Open Monograph Press by  doxygen 1.7.1