Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
UserSettingsDAO Class Reference
Inheritance diagram for UserSettingsDAO:
PKPUserSettingsDAO DAO

Public Member Functions

 deleteSetting ($userId, $name, $journalId=null)
 
getSetting ($userId, $name, $journalId=null)
 
getSettingsByJournal ($userId, $journalId=null)
 
getUsersBySetting ($name, $value, $type=null, $journalId=null)
 
 updateSetting ($userId, $name, $value, $type=null, $journalId=null)
 
- Public Member Functions inherited from PKPUserSettingsDAO
 deleteSetting ($userId, $name, $assocType=null, $assocId=null)
 
 deleteSettings ($userId)
 
getSetting ($userId, $name, $assocType=null, $assocId=null)
 
getSettingsByAssoc ($userId, $assocType=null, $assocId=null)
 
getUsersBySetting ($name, $value, $type=null, $assocType=null, $assocId=null)
 
 PKPUserSettingsDAO ()
 
 updateSetting ($userId, $name, $value, $type=null, $assocType=null, $assocId=null)
 
- 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 user settings.

See Also
User

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

Member Function Documentation

UserSettingsDAO::deleteSetting (   $userId,
  $name,
  $journalId = null 
)

Delete a user setting.

Parameters
$userIdint
$namestring
$journalIdint

Definition at line 71 of file UserSettingsDAO.inc.php.

& UserSettingsDAO::getSetting (   $userId,
  $name,
  $journalId = null 
)

Retrieve a user setting value.

Parameters
$userIdint
$name
$journalIdint
Returns
mixed

Definition at line 27 of file UserSettingsDAO.inc.php.

& UserSettingsDAO::getSettingsByJournal (   $userId,
  $journalId = null 
)

Retrieve all settings for a user for a journal.

Parameters
$userIdint
$journalIdint
Returns
array

Definition at line 49 of file UserSettingsDAO.inc.php.

& UserSettingsDAO::getUsersBySetting (   $name,
  $value,
  $type = null,
  $journalId = null 
)

Retrieve all users by setting name and value.

Parameters
$namestring
$valuemixed
$typestring
$journalIdint
Returns
DAOResultFactory matching Users

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

UserSettingsDAO::updateSetting (   $userId,
  $name,
  $value,
  $type = null,
  $journalId = null 
)

Add/update a user setting.

Parameters
$userIdint
$namestring
$valuemixed
$typestring data type of the setting. If omitted, type will be guessed
$journalIdint

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


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