Class humhub\modules\activity\components\MailSummary

Inheritancehumhub\modules\activity\components\MailSummary » yii\base\Component
Available since version1.2

MailSummary is send to the user with a list of new activities

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$interval integer The interval of this summary humhub\modules\activity\components\MailSummary
$layout string The mail summary layout file for html mails humhub\modules\activity\components\MailSummary
$layoutPlaintext string The mail summary layout file for plaintext mails humhub\modules\activity\components\MailSummary
$maxActivityCount integer The maximum number of activities in the e-mail summary humhub\modules\activity\components\MailSummary
$user humhub\modules\user\models\User The user humhub\modules\activity\components\MailSummary

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getActivities() Returns the list of activities for the e-mail summary humhub\modules\activity\components\MailSummary
send() Sends the summary mail to the user humhub\modules\activity\components\MailSummary

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getLastSummaryDate() Returns the last summary date humhub\modules\activity\components\MailSummary
getLimitContentContainerMode() Returns the mode (exclude, include) of given content containers humhub\modules\activity\components\MailSummary
getLimitContentContainers() Returns a list of content containers which should be included or excluded. humhub\modules\activity\components\MailSummary
getSubject() Returns the subject of the MailSummary humhub\modules\activity\components\MailSummary
getSuppressedActivities() Returns a list of suppressed activity classes humhub\modules\activity\components\MailSummary
setLastSummaryDate() Stores the date of the last summary mail humhub\modules\activity\components\MailSummary

Property Details

$interval public property

The interval of this summary

public integer $interval null
$layout public property

The mail summary layout file for html mails

public string $layout '@activity/views/mails/mailSummary'
$layoutPlaintext public property

The mail summary layout file for plaintext mails

public string $layoutPlaintext '@activity/views/mails/plaintext/mailSummary'
$maxActivityCount public property

The maximum number of activities in the e-mail summary

$user public property

The user

Method Details

getActivities() public method

Returns the list of activities for the e-mail summary

public humhub\modules\activity\models\Activity[] getActivities ( )
return humhub\modules\activity\models\Activity[]

The activities

getLastSummaryDate() protected method

Returns the last summary date

protected string|\yii\db\Expression getLastSummaryDate ( )
return string|\yii\db\Expression

Of the last summary mail

getLimitContentContainerMode() protected method

Returns the mode (exclude, include) of given content containers

See also humhub\modules\activity\models\MailSummaryForm.

protected integer getLimitContentContainerMode ( )
return integer

Mode

getLimitContentContainers() protected method

Returns a list of content containers which should be included or excluded.

protected array getLimitContentContainers ( )
return array

List of contentcontainer ids

getSubject() protected method

Returns the subject of the MailSummary

protected string getSubject ( )
return string

The subject of mail summary

getSuppressedActivities() protected method

Returns a list of suppressed activity classes

protected array getSuppressedActivities ( )
return array

Suppressed activity class names

send() public method

Sends the summary mail to the user

public void send ( )
setLastSummaryDate() protected method

Stores the date of the last summary mail

protected void setLastSummaryDate ( )