Download the PHP package 2lenet/dashboard-bundle without Composer
On this page you can find all versions of the php package 2lenet/dashboard-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package dashboard-bundle
This bundle provides a dashboard with customizable widgets.
Install
composer require 2lenet/dashboard-bundle
Setting up the bundle
Add this to services.yaml
Add this to routes.yaml
You also need to update your database to have widget table.
Making widgets
All your widget classes will lie in src/Widgets/.
They must extend AbstractWidget.
Existing methods that can be overriden:
- __construct: the constructor for usual services injection. You need at least a Twig_Environment ($twig)
- getName: must return general name of the widget
- getJsonSchema: must return an array (that will be json encoded) that represents an Json Schema, for the widget configuration. (see also https://github.com/json-editor/json-editor)
- getConfigForm: makes the configuration form. You shouldn't need to modify it, but it can happen in some cases (ex: bootstrap version)
- support: returns true if widget is supported. If not, user won't be able to add such widget nor render it
- supportsAjax: returns true if widget should be loaded asynchronously. If not, it will be loaded directly with the dashboard
- transformResponse: takes Response representing the widget as argument and returns response. By default, it caches widgets for 300 seconds.
You must implement the render() method.
This method returns simple HTML. You can use $twig->render("template.html.twig", array(...)). Your templates should extend the base widget template, because it has some interactions. Otherwise, make sure you implement those interactions.
Note that base template uses Bootstrap panels, which means it is better to put your widget body in a .
If you use the widget configuration (getJsonSchema) you must pass the form to the template with getConfigForm as 'form'.
This method renders the widget that is shown. All your logic should be in there.
cache
by default the cache is enable, you can change timeout and key with
above you see the default return.
If you want disable the cache for a widget getCacheTimeout have to return 0.
