mail/Module.php at master · humhub/mail · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
<?php

namespace humhub\modules\mail;

use humhub\modules\mail\models\MessageEntry;
use humhub\modules\mail\notifications\MailNotification;
use humhub\modules\mail\notifications\ConversationNotification;
use humhub\modules\mail\permissions\StartConversation;
use humhub\modules\mail\permissions\SendMail;
use humhub\modules\user\models\User;
use humhub\modules\mail\helpers\Url;
use Yii;

/**
 * MailModule provides messaging functions inside the application.
 *
 * @package humhub.modules.mail
 * @since 0.5
 */
class Module extends \humhub\components\Module
{
    /**
     * @var int Defines the initial page size of conversation overview inbox sidebar in messenger view. Should be > 6
     */
    public $inboxInitPageSize = 30;

    /**
     * @var int Defines the page size when loading more conversation page entries (autoscroller)
     */
    public $inboxUpdatePageSize = 5;

    /**
     * @var int Defines the initial message amount loaded for a conversation
     */
    public $conversationInitPageSize = 50;

    /**
     * @var int Defines the amount of messages loaded when loading more messages
     */
    public $conversationUpdatePageSize = 50;

    /**
     * @return static
     */
    public static function getModuleInstance()
    {
        return Yii::$app->getModule('mail');
    }

    /**
     * @inheritdoc
     */
    public function getConfigUrl()
    {
        return Url::toConfig();
    }

    /**
     * @inheritdoc
     */
    public function getPermissions($contentContainer = null)
    {
        if (!$contentContainer) {
            return [
                new StartConversation(),
            ];
        } elseif ($contentContainer instanceof User) {
            return [
                new SendMail(),
            ];
        }

        return [];
    }

    public function getNotifications()
    {
        return [
            MailNotification::class,
            ConversationNotification::class,
        ];
    }

    /**
     * Determines showInTopNav is enabled or not
     *
     * @return bool is showInTopNav enabled
     */
    public function hideInTopNav()
    {
        return !$this->settings->get('showInTopNav', false);
    }

    /**
     * @inheritdoc
     */
    public function disable()
    {
        foreach (MessageEntry::find()->each() as $messageEntry) {
            $messageEntry->delete();
        }

        parent::disable();
    }

}