README

Table of Contents

• Introduction
• Requirements
• How does the Notification Module work?
  • Read
  • Create
  • Update
  • Delete
• How to use or develop
• General Usage
  • Widgets
  • Component

Introduction

This module created for sending and receiving notifications to specific users based on permissions that is given to related user.

Requirements

PHP 7.3.31 or higher

How does the Notification Module work?

Creating, Updating, Deleting and Viewing the notification is done base on the permissions that is given to users.

Read

For reading or viewing your notifications you need to check the bell icon on the right corner of your login page. If you have any new notification, a number which states the number of notifications will be appeared on top of bell icon.

By clicking any of them you will be redirected to that notification.

Create

For creating a notification you should have the related permission. If you have the permission you can start to create a notification by clicking on the viewAll in the dropdown list of bell icon and then click on the plus(+) icon that is located on the corner side of your page. The first field shows to whom the notification will be sent. After filling required fields, you can click on the save button.

Update

For updating a notification you need to click on the pencil icon on the right side your notification as follows,

Delete

For deleting a notification, you should click on the trash icon which is located on the right side of your related notification row.

How to use or develop

You should add the following blocks of code into your composer.json file of your Portalium module.

to repositories part of your composer.json
{ "type": "git", "url": "https://github.com/portalium/yii2-notification.git" }

to require part of your composer.json
"portalium/yii2-notification": "dev-develop",

and in web\config\main.php path you should add the following block of code in module part
{ "type": "git", "url": "https://github.com/portalium/yii2-notification.git" }

and finally, you should run composer update command in the terminal of your php container in Docker.