Open Journal Systems
3.3.0
|
Public Member Functions | |
deleteSetting ($userId, $name, $contextId=CONTEXT_SITE) | |
deleteSettings ($userId) | |
getSetting ($userId, $name, $contextId=CONTEXT_SITE) | |
getSettingsByContextId ($userId, $contextId=CONTEXT_SITE) | |
getUsersBySetting ($name, $value, $type=null, $contextId=CONTEXT_SITE) | |
updateSetting ($userId, $name, $value, $type=null, $contextId=CONTEXT_SITE) | |
Public Member Functions inherited from DAO | |
__construct ($dataSource=null, $callHooks=true) | |
concat () | |
convertFromDB ($value, $type) | |
convertToDB ($value, &$type) | |
dateFromDB ($d) | |
datetimeFromDB ($dt) | |
datetimeToDB ($dt) | |
dateToDB ($d) | |
flushCache () | |
formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true) | |
getAdditionalFieldNames () | |
getAffectedRows () | |
getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject) | |
getDataSource () | |
getDirectionMapping ($direction) | |
getDriver () | |
getLocaleFieldNames () | |
getType ($value) | |
handleError ($dataSource, $sql) | |
nullOrInt ($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 | |
Static Public Member Functions inherited from DAO | |
static | getDataChangedEvent ($elementId=null, $parentElementId=null, $content='') |
Data Fields inherited from DAO | |
$_dataSource | |
Protected Member Functions inherited from DAO | |
_getInsertId ($table='', $id='') | |
Operations for retrieving and modifying user settings.
Definition at line 18 of file UserSettingsDAO.inc.php.
UserSettingsDAO::deleteSetting | ( | $userId, | |
$name, | |||
$contextId = CONTEXT_SITE |
|||
) |
Delete a user setting by context.
$userId | int |
$name | string |
$contextId | int |
Definition at line 173 of file UserSettingsDAO.inc.php.
References Application\getContextAssocType(), and DAO\update().
UserSettingsDAO::deleteSettings | ( | $userId | ) |
Delete all settings for a user.
$userId | int |
Definition at line 184 of file UserSettingsDAO.inc.php.
References DAO\update().
UserSettingsDAO::getSetting | ( | $userId, | |
$name, | |||
$contextId = CONTEXT_SITE |
|||
) |
Retrieve a user setting value.
$userId | int |
$name | |
$contextId | int |
Definition at line 27 of file UserSettingsDAO.inc.php.
References DAO\convertFromDB(), Application\getContextAssocType(), and DAO\retrieve().
UserSettingsDAO::getSettingsByContextId | ( | $userId, | |
$contextId = CONTEXT_SITE |
|||
) |
Retrieve all settings for a user for a context.
$userId | int |
$contextId | int |
Definition at line 86 of file UserSettingsDAO.inc.php.
References DAO\convertFromDB(), Application\getContextAssocType(), and DAO\retrieve().
UserSettingsDAO::getUsersBySetting | ( | $name, | |
$value, | |||
$type = null , |
|||
$contextId = CONTEXT_SITE |
|||
) |
Retrieve all users by setting name and value.
$name | string |
$value | mixed |
$type | string |
$contextId | int |
Definition at line 62 of file UserSettingsDAO.inc.php.
References DAO\convertToDB(), Application\getContextAssocType(), DAORegistry\getDAO(), and DAO\retrieve().
UserSettingsDAO::updateSetting | ( | $userId, | |
$name, | |||
$value, | |||
$type = null , |
|||
$contextId = CONTEXT_SITE |
|||
) |
Add/update a user setting.
$userId | int |
$name | string |
$value | mixed |
$type | string data type of the setting. If omitted, type will be guessed |
$contextId | int |
Definition at line 117 of file UserSettingsDAO.inc.php.
References DAO\convertToDB(), Application\getContextAssocType(), DAO\retrieve(), and DAO\update().