Class humhub\modules\notification\models\forms\NotificationSettings

All Classes | Properties | Methods

Inheritance	humhub\modules\notification\models\forms\NotificationSettings » yii\base\Model

Description of NotificationSettings

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$desktopNotifications	boolean	Manage if the user/users should receive desktop notifications.	humhub\modules\notification\models\forms\NotificationSettings
$settings	array		humhub\modules\notification\models\forms\NotificationSettings
$spaceGuids	string[]	Holds the selected spaces for receiving content created notifications.	humhub\modules\notification\models\forms\NotificationSettings
$user	humhub\modules\user\models\User	Instance for which the settings should by appleid, if null global settings are used.	humhub\modules\notification\models\forms\NotificationSettings

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$_targets	humhub\modules\notification\targets\BaseTarget[]		humhub\modules\notification\models\forms\NotificationSettings

Public Methods

Hide inherited methods

Method	Description	Defined By
attributeLabels()		humhub\modules\notification\models\forms\NotificationSettings
categories()		humhub\modules\notification\models\forms\NotificationSettings
checkPermission()		humhub\modules\notification\models\forms\NotificationSettings
getSettingFormname()	Returns the field name for the given category/target combination.	humhub\modules\notification\models\forms\NotificationSettings
getSettings()		humhub\modules\notification\models\forms\NotificationSettings
init()		humhub\modules\notification\models\forms\NotificationSettings
isUserSettingLoaded()	Checks if this form has already been saved before.	humhub\modules\notification\models\forms\NotificationSettings
resetUserSettings()		humhub\modules\notification\models\forms\NotificationSettings
rules()		humhub\modules\notification\models\forms\NotificationSettings
save()	Saves the settings for the given user (or global if no user is given).	humhub\modules\notification\models\forms\NotificationSettings
targets()		humhub\modules\notification\models\forms\NotificationSettings

Property Details

$_targets protected property

protected humhub\modules\notification\targets\BaseTarget[] $_targets = null

$desktopNotifications public property

Manage if the user/users should receive desktop notifications.

public boolean $desktopNotifications = null

$settings public property

public array $settings = []

$spaceGuids public property

Holds the selected spaces for receiving content created notifications.

public string[] $spaceGuids = []

$user public property

Instance for which the settings should by appleid, if null global settings are used.

public humhub\modules\user\models\User $user = null

Method Details

attributeLabels() public method

public void attributeLabels ( )

categories() public method

public humhub\modules\notification\components\NotificationCategory[] categories ( )
return	humhub\modules\notification\components\NotificationCategory[]	NotificationCategories enabled for this user (or global)

checkPermission() public method

public void checkPermission ( )

getSettingFormname() public method

Returns the field name for the given category/target combination.

public string getSettingFormname ( $category, $target )
$category	humhub\modules\notification\components\NotificationCategory
$target	humhub\modules\notification\targets\BaseTarget

getSettings() public method

public void getSettings ( )

init() public method

public void init ( )

isUserSettingLoaded() public method

Checks if this form has already been saved before.

public boolean isUserSettingLoaded ( )

resetUserSettings() public method

public void resetUserSettings ( )

rules() public method

public void rules ( )

save() public method

Saves the settings for the given user (or global if no user is given).

public boolean save ( )
return	boolean	If the save process was successful else false
throws	\yii\web\HttpException

targets() public method

public humhub\modules\notification\targets\BaseTarget[] targets ( )
return	humhub\modules\notification\targets\BaseTarget[]	The notification targets enabled for this user (or global)