Public Member Functions

DefaultSettingDAO Class Reference
[Press]

Operations for retrieving and modifying press default settings. More...

Inheritance diagram for DefaultSettingDAO:
CataloguingMetadataFieldDAO GenreDAO

List of all members.

Public Member Functions

 DefaultSettingDAO ()
 getDefaultBaseFilename ()
 getDefaultKey ()
& getDefaultSettingIds ($pressId)
 getDefaultType ()
 getPrimaryKeyColumnName ()
 getSettingAttributes ($node=null)
 getSettingsTableName ()
 getTableName ()
 installDefaultBase ($pressId)
 installDefaultBaseData ($locale, $pressId, $skipLoad=true, $localeInstall=false)
 installDefaults ($pressId, $locales)
 installLocale ($locale)
 restoreByPressId ($pressId, $locale=null)
 uninstallLocale ($locale)

Detailed Description

Operations for retrieving and modifying press default settings.

See also:
PressSettingsDAO

Definition at line 18 of file DefaultSettingDAO.inc.php.

Member Function Documentation

DefaultSettingDAO.DefaultSettingDAO (  ) 

Constructor

Definition at line 22 of file DefaultSettingDAO.inc.php.

Referenced by CataloguingMetadataFieldDAO.CataloguingMetadataFieldDAO(), and GenreDAO.GenreDAO().

DefaultSettingDAO.getDefaultBaseFilename (  ) 

Get the path of the settings file.

Returns:
string

Reimplemented in CataloguingMetadataFieldDAO, and GenreDAO.

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

Referenced by installDefaultBaseData().

DefaultSettingDAO.getDefaultKey (  ) 

Get the column name of the constant key identifier.

Returns:
string

Definition at line 56 of file DefaultSettingDAO.inc.php.

Referenced by getDefaultSettingIds(), and restoreByPressId().

& DefaultSettingDAO.getDefaultSettingIds ( $  pressId  ) 

Retrieve ids for all default setting entries

Parameters:
$pressId int

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

References getDefaultKey(), getPrimaryKeyColumnName(), and getTableName().

Referenced by installDefaultBaseData(), and restoreByPressId().

DefaultSettingDAO.getDefaultType (  ) 

Get the default type constant.

Returns:
int

Reimplemented in CataloguingMetadataFieldDAO, and GenreDAO.

Definition at line 91 of file DefaultSettingDAO.inc.php.

Referenced by installDefaultBaseData(), and restoreByPressId().

DefaultSettingDAO.getPrimaryKeyColumnName (  ) 

Get the column name of the primary key

Returns:
string

Reimplemented in CataloguingMetadataFieldDAO, and GenreDAO.

Definition at line 47 of file DefaultSettingDAO.inc.php.

Referenced by getDefaultSettingIds(), and restoreByPressId().

DefaultSettingDAO.getSettingAttributes ( $  node = null  ) 

Get the names and values for setting attributes. In subclasses: if $node is null, return only the attribute names.

Parameters:
$node XMLNode
$onlyNames bool
Returns:
array key=>value

Definition at line 67 of file DefaultSettingDAO.inc.php.

Referenced by installDefaultBaseData().

DefaultSettingDAO.getSettingsTableName (  ) 

Get the name of the settings table.

Returns:
string

Reimplemented in CataloguingMetadataFieldDAO, and GenreDAO.

Definition at line 75 of file DefaultSettingDAO.inc.php.

Referenced by restoreByPressId(), and uninstallLocale().

DefaultSettingDAO.getTableName (  ) 

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

Returns:
string

Reimplemented in CataloguingMetadataFieldDAO, and GenreDAO.

Definition at line 83 of file DefaultSettingDAO.inc.php.

Referenced by getDefaultSettingIds(), and restoreByPressId().

DefaultSettingDAO.installDefaultBase ( $  pressId  ) 

Install setting types from an XML file.

Parameters:
$pressId int
Returns:
boolean

Reimplemented in CataloguingMetadataFieldDAO, and GenreDAO.

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

Referenced by installDefaults().

DefaultSettingDAO.installDefaultBaseData ( $  locale,
$  pressId,
$  skipLoad = true,
$  localeInstall = false 
)

Install setting type localized data from an XML file.

Parameters:
$locale string
$pressId int
$skipLoad bool
$localInstall bool
Returns:
boolean

Definition at line 103 of file DefaultSettingDAO.inc.php.

References getDefaultBaseFilename(), getDefaultSettingIds(), getDefaultType(), getSettingAttributes(), and restoreByPressId().

Referenced by installDefaults(), and installLocale().

DefaultSettingDAO.installDefaults ( $  pressId,
$  locales 
)

Install default data for settings.

Parameters:
$pressId int
$locales array

Definition at line 252 of file DefaultSettingDAO.inc.php.

References installDefaultBase(), installDefaultBaseData(), and restoreByPressId().

DefaultSettingDAO.installLocale ( $  locale  ) 

Install locale specific items for a locale.

Parameters:
$locale string

Definition at line 264 of file DefaultSettingDAO.inc.php.

References installDefaultBaseData().

DefaultSettingDAO.restoreByPressId ( $  pressId,
$  locale = null 
)

Restore settings.

Parameters:
$pressId int
$locale string

Definition at line 202 of file DefaultSettingDAO.inc.php.

References getDefaultKey(), getDefaultSettingIds(), getDefaultType(), getPrimaryKeyColumnName(), getSettingsTableName(), and getTableName().

Referenced by installDefaultBaseData(), and installDefaults().

DefaultSettingDAO.uninstallLocale ( $  locale  ) 

Delete locale specific items from the settings table.

Parameters:
$locale string

Definition at line 278 of file DefaultSettingDAO.inc.php.

References getSettingsTableName().

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