• Overview
• Usage
  • Application
  • Page
  • Dashboard
  • Widget
• Register events

Events

Overview #

Dashboard's events provide you a simple way to listen to what happened within your application. Each objects like Application, Dashboard and Widget provide events to which you can register and provide reaction on those events.

There are two type of events: pre-event and post-event. If you register for pre-event, you will get notification before that event actually happens. Normally the pre-event name will ended with -ing like onRendering or onExporting. On the other hand, if you register for post-event, you will get notification after that event happens. The name of pre-events are normally ended with -ed, for example onRendered or onExported.

Usage #

Application #

Example:

<?php

use \koolreport\dashboard\Application;

class App extends Application
{
    protected function onCreated()
    {
        $this->title("Dashboard");
    }

    protected function onError($exception)
    {
        Log::error("Something happens".$exception->getMessage());
    }

    protected function onRendering()
    {
        if(/*something wrong*/) {
            return false; // Not allowed to render
        } 
        return true; // Allow to render
    }
}

Page #

<?php

use \koolreport\dashboard\pages\Main;

class MyPage extends Main
{
    protected function onCreated()
    {
        $this->loginRequired(true);
    }

    protected function onRendering()
    {
        if(/*something wrong*/) {
            return false; // Not allowed to render
        } 
        return true; // Allow to render
    }
}

Dashboard #

Example:

<?php

use \koolreport\dashboard\Dashboard;

class MyDashboard extends Dashboard
{
    protected function onCreated()
    {
        //Anything you set here can be changed by outside settings
        $this->title("My Dashboard");
    }

    protected function onInit()
    {
        //Anything you set here will be the last before dashboard is going to be rendered.
        $this->title("My Dashboard");
    }

    protected function onError($exception)
    {
        //Error happens inside dashboard
        Log::error("Something went wrong");
    }
}

Widget #

Example:

<?php

use \koolreport\dashboard\widgets\Table;

class MyTable extends Table
{
    protected function onCreated()
    {
        $this->pageSize(10);
    }

    protected function onDataReady($result)
    {
        if($result["data"]->count()==0) {
            $this->hidden(true);
        }
    }

    protected function onRendering()
    {
        if (/*something wrong*/) {
            return false;
        }
        return true;
    }
}

Register events #

In common, all entities which use trait TEvent will have ability to subscribe listeners to an event using registerEvent() function

->registerEvent(_string_ $eventName, _function_ $anonymousFucntion);

Example:

class MyWidget extends Widget
{
    protected function onCreated()
    {
        $this->registerEvent("Init",function(){
            // Do something on Init
        });
    }

}

Since registerEvent() has public scope so you can register event from outside:

class MyDashboard extends Dashboard
{
    protected function content()
    {
        return [
            MyWidget::create()
                ->registerEvent("Init",function (){
                    //Do something
                })
        ];
    }
}