Module Structure

Currently available in beta

Admin Dashboard is currently available in beta, which means some of the features, specifications, and details provided herein are subject to change. We recommend checking back regularly for the most up-to-date information and viewing our roadmap in regard to the general availability release.

The admin dashboard is split into 3 main modules: one for the framework, one for the set of basic widget types, and one for the more custom widget types. When installing Hyvä Commerce, the hyva-themes/commerce-module-admin-dashboard Composer package is responsible for installing these modules.

Admin Dashboard Framework

The Hyva_AdminDashboardFramework module contains the code responsible for establishing the admin dashboard and widget system framework. This is where you will find all the controllers, base models, repositories, database table definitions, setup scripts, system configuration files, utility classes, and the core set of templates.

Base Widgets

The Hyva_AdminDashboardBaseWidgets module contains the definitions and implementations for a set of the most basic widget types. The widget types in this module are typically simple, self-contained, and serve to provide a base for developers to start from. They can also provide a more "plug-and-play" experience where you can simply provide the widget implementation (i.e. the PHP class) and leverage an existing display type to handle the rendering.

Custom Widgets

The Hyva_AdminDashboardCustomWidgets module contains those widget types which are a little bit more complex - typically requiring use of the database and custom templating for their output.

Advanced Widgets

In this context, the term "Advanced Widgets" refers to the Hyvä-published widget types which exist in their own standalone modules. This is typically done when there are dependencies on other third-parties, including ourselves, or the implementation is sufficiently complicated to warrant the separation.