Public Member Functions

CataloguingMetadataFieldDAO Class Reference
[CataloguingMetadata]

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

Inheritance diagram for CataloguingMetadataFieldDAO:
DefaultSettingDAO

List of all members.

Public Member Functions

& _fromRow (&$row)
 CataloguingMetadataFieldDAO ()
 deleteById ($cataloguingMetadataFieldId, $pressId=null)
& getById ($cataloguingMetadataFieldId, $pressId=null)
 getDefaultBaseFilename ()
 getDefaultType ()
& getEnabledByPressId ($pressId)
 getInsertCataloguingMetadataFieldId ()
 getLocaleFieldNames ()
 getPrimaryKeyColumnName ()
& getSettingAttributes ($node=null, $locale=null)
 getSettingsTableName ()
 getTableName ()
 insertObject (&$cataloguingMetadataField)
 installDefaultBase ($pressId)
 newDataObject ()
 updateLocaleFields (&$cataloguingMetadataField)
 updateObject (&$cataloguingMetadataField)

Detailed Description

Operations for retrieving and modifying CataloguingMetadataField objects.

See also:
CataloguingMetadataField

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

Member Function Documentation

& CataloguingMetadataFieldDAO._fromRow ( &$  row  ) 

Internal function to return a CataloguingMetadataField object from a row.

Parameters:
$row array
Returns:
CataloguingMetadataField

Definition at line 115 of file CataloguingMetadataFieldDAO.inc.php.

References newDataObject().

Referenced by getById(), and getEnabledByPressId().

CataloguingMetadataFieldDAO.CataloguingMetadataFieldDAO (  ) 

Constructor

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

References DefaultSettingDAO.DefaultSettingDAO().

CataloguingMetadataFieldDAO.deleteById ( $  cataloguingMetadataFieldId,
$  pressId = null 
)

Soft delete a field by id.

Parameters:
$cataloguingMetadataFieldId int
$pressId int optional

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

& CataloguingMetadataFieldDAO.getById ( $  cataloguingMetadataFieldId,
$  pressId = null 
)

Retrieve a cataloguing metadata field by id.

Parameters:
$cataloguingMetadataFieldId int
$pressId int
Returns:
CataloguingMetadataField

Definition at line 40 of file CataloguingMetadataFieldDAO.inc.php.

References _fromRow().

CataloguingMetadataFieldDAO.getDefaultBaseFilename (  ) 

Get the path of the setting data file.

Returns:
string

Reimplemented from DefaultSettingDAO.

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

Referenced by installDefaultBase().

CataloguingMetadataFieldDAO.getDefaultType (  ) 

Get the default type constant.

Returns:
int

Reimplemented from DefaultSettingDAO.

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

& CataloguingMetadataFieldDAO.getEnabledByPressId ( $  pressId  ) 

Retrieve all enabled metadata fields

Returns:
array CataloguingMetadataField

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

References _fromRow().

CataloguingMetadataFieldDAO.getInsertCataloguingMetadataFieldId (  ) 

Get the ID of the last inserted field.

Returns:
int

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

Referenced by insertObject().

CataloguingMetadataFieldDAO.getLocaleFieldNames (  ) 

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

Returns:
array

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

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

Reimplemented from DefaultSettingDAO.

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

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

Get setting names and values.

Parameters:
$node XMLNode
$locale string
Returns:
array

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

CataloguingMetadataFieldDAO.getSettingsTableName (  ) 

Get the name of the settings table.

Returns:
string

Reimplemented from DefaultSettingDAO.

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

CataloguingMetadataFieldDAO.getTableName (  ) 

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

Returns:
string

Reimplemented from DefaultSettingDAO.

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

CataloguingMetadataFieldDAO.insertObject ( &$  cataloguingMetadataField  ) 

Insert a new field.

Parameters:
$cataloguingMetadataField CataloguingMetadataField

Definition at line 130 of file CataloguingMetadataFieldDAO.inc.php.

References getInsertCataloguingMetadataFieldId(), and updateLocaleFields().

CataloguingMetadataFieldDAO.installDefaultBase ( $  pressId  ) 

Install fields from an XML file.

Parameters:
$pressId int
Returns:
boolean

Reimplemented from DefaultSettingDAO.

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

References getDefaultBaseFilename().

CataloguingMetadataFieldDAO.newDataObject (  ) 

Construct a new data object corresponding to this DAO.

Returns:
CataloguingMetadataField

Definition at line 106 of file CataloguingMetadataFieldDAO.inc.php.

Referenced by _fromRow().

CataloguingMetadataFieldDAO.updateLocaleFields ( &$  cataloguingMetadataField  ) 

Update the settings for this object

Parameters:
$cataloguingMetadataField object

Definition at line 96 of file CataloguingMetadataFieldDAO.inc.php.

Referenced by insertObject(), and updateObject().

CataloguingMetadataFieldDAO.updateObject ( &$  cataloguingMetadataField  ) 

Update an existing field.

Parameters:
$cataloguingMetadataField CataloguingMetadataField

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

References updateLocaleFields().

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