eluhr/yii2-notification-module

A notification module for Yii2

1.3.9 2024-01-15 12:23 UTC

Requires

• 2amigos/yii2-ckeditor-widget: ^2.0.2
• 2amigos/yii2-usuario: ^1.5.0
• dmstr/yii2-adminlte-asset: ^2.5.0
• kartik-v/yii2-widget-select2: ^2.0.1
• yiisoft/yii2-dev: ~2.0.11

Requires (Dev)

• codeception/codeception: ^3.1.3
• dmstr/yii2-db: ^0.9.4

BSD-3-Clause

• Elias Luhr

README

composer require eluhr/yii2-notification-module

Configuration

use eluhr\notification\components\Notification as NotificationComponent;
use eluhr\notification\Module as NotificationModule;
...
'modules' => [
    'notification' => [
        'class' => NotificationModule::class
    ],
    'translatemanager' => [
        'root' => [
            '@vendor/eluhr/yii2-notification-module/src'
        ]
    ]
],
'components' => [
    'notification' => [
        'class' => NotificationComponent::class,
        'mailer' => 'mailer', // OPTIONAL: Default -> mailer
        'fromEmail' => '[e-mail]' // REQUIRED
    ]
],
'controllerMap' => [
    'migrate' => [
        'migrationPath' => [
            '@vendor/eluhr/yii2-notification-module/src/migrations',
        ]
    ]
]
...

Example

Inbox from the point of view of a user with all authorizations

Worth knowing

Requires PHP version >= 7.*

Example usuage

ExampleModel extends ActiveRecord implements ModelChangeNotification {
        
        /**
         * @return array
         */
        public function behaviors()
        {
            $behaviors = parent::behaviors();
            $behaviors['notification'] = [
                'class' => ModelChangeNotification::class,
                'receiverIds' => [MessageUserGroup::MESSAGE_USER_GROUP_ID_PREFIX . '1']
            ];
            return $behaviors;
        }
    
    
        /**
         * @return string
         */
        public function subject()
        {
            return $this->isNewRecord ? 'New entry' : ('Updated entry #' . $this->id);
        }
    
        /**
         * @return string
         */
        public function text()
        {
            $text = Html::tag('pre', htmlentities(json_encode($this->attributes, JSON_PRETTY_PRINT)));
            $text .= Html::tag('p', Html::a('Direct link',['/widgets/crud/widget-template/view','id' => $this->id], true));
            return $text;
        }
        
}

More infos coming soon

Ideas

The following stuff will probably come in a future release

• Draft messages for later use
• Ability to remove messages
• Mark messages from users with a label or something
• Notification Widget (AdminLTE)
• Delete (inbox) message in overview (three dots option edit)
• Translation config