Class humhub\modules\activity\models\MailSummaryForm

Inheritancehumhub\modules\activity\models\MailSummaryForm » yii\base\Model
Available since version1.2

MailSummaryForm

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$activities array Of selected activities to include humhub\modules\activity\models\MailSummaryForm
$interval integer The mail summary interval humhub\modules\activity\models\MailSummaryForm
$limitSpaces array The selected spaces humhub\modules\activity\models\MailSummaryForm
$limitSpacesMode integer The mode how to handle selected spaces (include or exclude) humhub\modules\activity\models\MailSummaryForm
$user humhub\modules\user\models\User The user when user settings should be loaded/saved humhub\modules\activity\models\MailSummaryForm
$userSettingsLoaded boolean Indicates that custom user settings were loaded humhub\modules\activity\models\MailSummaryForm

Public Methods

Hide inherited methods

MethodDescriptionDefined By
attributeHints() humhub\modules\activity\models\MailSummaryForm
attributeLabels() humhub\modules\activity\models\MailSummaryForm
getActivitiesArray() Returns an array of all possible activities for the checkboxLis humhub\modules\activity\models\MailSummaryForm
getIntervals() Returns a list of available mail summary intervals humhub\modules\activity\models\MailSummaryForm
getLimitSpaceModes() Returns available modes how to handle given spaces humhub\modules\activity\models\MailSummaryForm
loadCurrent() Loads the current values into this model humhub\modules\activity\models\MailSummaryForm
resetUserSettings() Resets all settings stored for the current user humhub\modules\activity\models\MailSummaryForm
rules() humhub\modules\activity\models\MailSummaryForm
save() Saves the current model values to the current user or globally. humhub\modules\activity\models\MailSummaryForm

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
LIMIT_MODE_EXCLUDE 0 Space limit modes (include or exclude) humhub\modules\activity\models\MailSummaryForm
LIMIT_MODE_INCLUDE 1 humhub\modules\activity\models\MailSummaryForm

Property Details

$activities public property

Of selected activities to include

public array $activities = []
$interval public property

The mail summary interval

public integer $interval null
$limitSpaces public property

The selected spaces

public array $limitSpaces null
$limitSpacesMode public property

The mode how to handle selected spaces (include or exclude)

$user public property

The user when user settings should be loaded/saved

$userSettingsLoaded public property

Indicates that custom user settings were loaded

Method Details

attributeHints() public method

public void attributeHints ( )
attributeLabels() public method

public void attributeLabels ( )
getActivitiesArray() public method

Returns an array of all possible activities for the checkboxLis

public array getActivitiesArray ( )
getIntervals() public method

Returns a list of available mail summary intervals

public array getIntervals ( )
return array

The intervals

getLimitSpaceModes() public method

Returns available modes how to handle given spaces

public array getLimitSpaceModes ( )
return array

The modes

loadCurrent() public method

Loads the current values into this model

If the 'user' attribute is set, the user settings are loaded if present. Otherwise the system defaults will be loaded.

public boolean loadCurrent ( )
resetUserSettings() public method

Resets all settings stored for the current user

public void resetUserSettings ( )
throws \yii\base\Exception
rules() public method

public void rules ( )
save() public method

Saves the current model values to the current user or globally.

public boolean save ( )
return boolean

Success