pdWidget Bundle

Flexible widget system for Symfony 5., _(*1)

, _(*2)

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:, _(*3)

$ composer require appaydin/pd-widget

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation., _(*4)

Step 2: Enable the Bundle

With Symfony 4, the package will be activated automatically. But if something goes wrong, you can install it manually., _(*5)

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:, _(*6)

<?php
// config/bundles.php

return [
    //...
    Pd\WidgetBundle\PdWidgetBundle::class => ['all' => true]
];

Add Widget Routing:, _(*7)

#config/routes.yaml

# Widget Routing
widget:
    resource: "@PdWidgetBundle/Resources/config/routing.yml"

Edit Doctrine Settings (config/packages/doctrine.yaml):, _(*8)

doctrine:
    orm:
        resolve_target_entities:
            Pd\WidgetBundle\Entity\UserInterface: App\Entity\User

UserInterface field, enter the class for the existing authorization system., _(*9)

Step 3: Settings Bundle (Optional)

You can specify the template for the widget container., _(*10)

# config/packages/framework.yaml

pd_widget:
    base_template: '@PdWidget/widgetBase.html.twig'
    return_route: 'admin_dashboard'

Widgets work with Event. Create Widget with Event Listener, _(*11)

<?php
// src/Widgets/DashboardWidget.php

namespace App\Widgets;

use Pd\WidgetBundle\Builder\Item;
use Pd\WidgetBundle\Event\WidgetEvent;

class Dashboard
{
    public function builder(WidgetEvent $event)
    {
        // Get Widget Container
        $widgets = $event->getWidgetContainer();

        // Add Widgets
        $widgets
            ->addWidget((new Item('user_info', 3600)) // Add Cache Time or Default 3600 Second
                ->setGroup('admin')
                ->setName('widget_user_info.name')
                ->setDescription('widget_user_info.description')
                ->setTemplate('widgets/userInfo.html.twig')
                //->setContent('pdWidget Text Content')
                //->setRole(['USER_INFO_WIDGET'])
                ->setData(function () {
                    return ['userCount' => 5];
                })
                ->setOrder(5)
            );
    }
}

You can create a Twig template for the widget or can only use text content., _(*12)

# templates/userInfo.html.twig

{% if widget.isActive %}



        
            
                {# Action Button #}
                {% include '@PdWidget/widgetAction.html.twig' %}

                {{ widget.data.userCount }}
                {{ 'widget_user_info.count'|trans }}
            
        
    


{% endif %}

# config/services.yaml

# Load All Widgets
App\Widgets\:
    resource: '../src/Widgets/*'
    tags:
        - { name: kernel.event_listener, event: widget.start, method: builder }

# Load Single Widget
App\Widgets\DashboardWidget:
    tags:
        - { name: kernel.event_listener, event: widget.start, method: builder }

Rendering Widgets

The creation process is very simple. You should use widget groups for widget creation., _(*13)

# Render all 'admin' widget groups
{{ pd_widget_render('admin') }}

# Render selected widgets in 'admin' group
{{ pd_widget_render('admin', ['user_info']) }}