https://github.com/prooph/link-dashboard

Dashboard module for prooph LINK
https://github.com/prooph/link-dashboard

Last synced: 10 months ago
JSON representation

Dashboard module for prooph LINK

• Host: GitHub
• URL: https://github.com/prooph/link-dashboard
• Owner: prooph
• License: bsd-3-clause
• Created: 2015-02-27T22:12:44.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-05-10T13:01:27.000Z (about 11 years ago)
• Last Synced: 2025-07-11T09:46:07.900Z (11 months ago)
• Language: PHP
• Size: 238 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Prooph\Link\Dashboard

=====================

Dashboard module for [prooph LINK](https://github.com/prooph/link)

# Widgets

A standard prooph LINK application home screen is rendered by the dashboard module. The module overrides the `home` route of the application to point to the IndexController of the dashboard module. Other modules can register [WidgetController](https://github.com/prooph/link-dashboard/blob/master/src/Controller/AbstractWidgetController.php) via configuration. The IndexController loops through all registered WidgetController and calls the `widgetAction` which should return a [DashboardWidget](https://github.com/prooph/link-dashboard/blob/master/src/View/DashboardWidget.php).

A typical module configuration to register a widget looks like the following:

```php

//module.config.php of the link-app-core module

return [

    'prooph.link.dashboard' => [

        'system_config_widget' => [

            'controller' => 'Prooph\Link\Application\Controller\DashboardWidget', //Controller alias of WidgetController

            'order' => 101 //Order of the widget on the dashboard

        ]

    ],

    //...

];

```

# Widget Groups

to be defined ...

# Support

- Ask any questions on [prooph-users](https://groups.google.com/forum/?hl=de#!forum/prooph) google group.

- File issues at [https://github.com/prooph/link-dashboard/issues](https://github.com/prooph/link-dashboard/issues).

# Contribution

You wanna help us? Great!

We appreciate any help, be it on implementation level, UI improvements, testing, donation or simply trying out the system and give us feedback.

Just leave us a note in our google group linked above and we can discuss further steps.

Thanks,

your prooph team