UserSettingsDAO Class Reference
[User]

Operations for retrieving and modifying user settings. More...

List of all members.

Public Member Functions

 deleteSetting ($userId, $name, $conferenceId=null)
getSetting ($userId, $name, $conferenceId=null)
getSettingsByConference ($userId, $conferenceId=null)
getUsersBySetting ($name, $value, $type=null, $conferenceId=null)
 updateSetting ($userId, $name, $value, $type=null, $conferenceId=null)


Detailed Description

Operations for retrieving and modifying user settings.

See also:
User

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


Member Function Documentation

UserSettingsDAO.deleteSetting ( userId,
name,
conferenceId = null 
)

Delete a user setting.

Parameters:
$userId int
$name string
$conferenceId int

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

& UserSettingsDAO.getSetting ( userId,
name,
conferenceId = null 
)

Retrieve a user setting value.

Parameters:
$userId int
$name 
$conferenceId int
Returns:
mixed

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

& UserSettingsDAO.getSettingsByConference ( userId,
conferenceId = null 
)

Retrieve all settings for a user for a conference.

Parameters:
$userId int
$conferenceId int
Returns:
array

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

& UserSettingsDAO.getUsersBySetting ( name,
value,
type = null,
conferenceId = null 
)

Retrieve all users by setting name and value.

Parameters:
$name string
$value mixed
$type string
$conferenceId int
Returns:
DAOResultFactory matching Users

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

UserSettingsDAO.updateSetting ( userId,
name,
value,
type = null,
conferenceId = null 
)

Add/update a user setting.

Parameters:
$userId int
$name string
$value mixed
$type string data type of the setting. If omitted, type will be guessed
$conferenceId int

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


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7