Download the PHP package kalamu/dashboard-bundle without Composer
On this page you can find all versions of the php package kalamu/dashboard-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kalamu/dashboard-bundle
More information about kalamu/dashboard-bundle
Files in kalamu/dashboard-bundle
Package dashboard-bundle
Short Description Configurable Bootstrap dashboard for Kalamu
License MIT
Informations about the package dashboard-bundle
Bundle kalamu/dashboard-bundle
This bundle provide a configurable interface for users to build modulable content. It's can be used to build responsive content, application dashbord and more.
Installation
Install the bundle:
Register the bundle and the dependency in app/AppKernel.php
:
Register de routing in app/config/routing.yml
:
Publish assets:
How to use it ?
To use this bundle there is 3 key concepts:
- The context in witch we work
- The elements that compose the content
- The dashboard that is the main container
The context
The contexts are used to organize and filter the elements that are available. For exemple an application can use the dasboard for two purpuses: a dashboard with personnal activity report and a shared public dashboard with gobal stats.
This two purpuses will maybe have common elements like todo task list, but somes will have no sense in somes contexts. For exemple, an element for managing personnal activity sould not be added in public shared dashboard.
For this reason, you can create multiple contexts and define the elements that can be added in each context.
This defined in the app/config/config.yml
:
This configuration create 2 contexts personal_dashboard
and global_dashboard
.
In personal_dashboard
there is one type of element cms_content
that provide
4 element organised in categories standard
and media
.
Each element of a dashboard is a Symfony service. To enable it, you must report the service name in the appropriate category.
Create an Element
Like it's said, the elements are Symfony services. They must implements either
the Kalamu\DashboardBundle\Model\AbstractElement
for a simple element or
Kalamu\DashboardBundle\Model\AbstractConfigurableElement
if the element require
some sort of configuration.
Example of an element that show the n
last tasks of an user. This element will
ask the user to define how many task must be reported on his dashboard.
You must register this class as a service in Symfony, then add the service name
on your config file (app/config/config.yml
) in the appropriate context(s) and
category.
The Form used to configure the element is rendered with default options. If
you want a more specific template for this form, you can add the following method
renderConfigForm(TwigEngine $templating, Form $form)
that will be automaticaly
called if present.
Display the dashboard
All versions of dashboard-bundle with dependencies
symfony/framework-bundle Version ^4.0
willdurand/js-translation-bundle Version ^3.0||^4.0