README

Business intelligence dashboard for Yii 2

Bidashboard

Bidashboard is a data visualization dashboard designed to provide insights into key metrics and data for business intelligence purposes. It allows users to monitor and analyze various aspects of their business in real-time through interactive charts and graphs.

This extension provides the Business Intelligence Dashboard for the Yii framework 2.0.

For license information check the LICENSE-file.

Installation

Using Composer (Preferred Method):

The preferred way to install this extension is through composer:

composer require --prefer-dist ziaadini/yii2-bi-dashboard:"*"

Alternative Method:

If you prefer adding the bidashboard extension to your composer.json file manually, you can do so by adding the following entry to the require section:

{
  "require": {
    "ziaadini/yii2-bi-dashboard": "*"
  }
}

After adding the entry, save the composer.json file and run the following command in the terminal or command prompt within your project directory:

composer update

This command will fetch and install the bidashboard extension and its required dependencies into your Yii 2 project.

Configuration

To use this extension, you have to configure the bidashboard module in your application configuration:

return [
    //....
    'modules' => [
        'bidashboard' => [
            'class' => 'ziaadini\bidashboard\Module',
        ],
    ]
];

And for access Alerts to User for show who see the fired alerts:

implement fullName() function into your User model class

Env

You have to add the database configuration to env, its example is in - Env.example

DB Migrations

Run module migrations:

php yii migrate --migrationPath=@ziaadini/bidashboard/migrations

Or, Add migrations path in console application config:

'controllerMap' => [
    'migrate' => [
        'class' => 'yii\console\controllers\MigrateController',
        'migrationNamespaces' => [],
        'migrationPath' => [
            '@vendor/ziaadini/yii2-bi-dashboard/src/migrations',
            '@app/migrations'
        ]
    ],
],

How To Use

add to view model:

use ziaadini\bidashboard\widgets\ReportModalWidget;

<?= ReportModalWidget::widget([
    'queryParams' => $queryParams,
    'searchModel' => $searchModel,
    'searchModelMethod' => $searchWidget,
    'searchModelRunResultView' => $searchModelRunResultView,
    'searchRoute' => Yii::$app->request->pathInfo,
    'searchModelFormName' => $searchModelFormName,
    'outputColumn' => $outputColumn,
]) ?>

add to search model:

public function searchWidget(array $params,int $rangeType,int $startRange,int $endRange)
{
    $query = Invoice::find();
    $dataProvider = new ActiveDataProvider([
        'query' => $query,
    ]);
    $this->load($params, '');
    $query->andFilterWhere(['between', 'created_at', $startRange, $endRange]);
    if ($rangeType == ReportWidget::RANGE_TYPE_MONTHLY) {
    ...
     }
    elseif ($rangeType == ReportWidget::RANGE_TYPE_DAILY) {
    ...    
    }
    return $dataProvider;
}

Advanced config

• Installation Guide

• Description Guide

• Usage Guide

• Access Control Guide (RBAC)