# aelmizeb/magento2-reports

> A Magento 2 module that adds reports in the admin panel.

`composer require aelmizeb/magento2-reports`

Canonical URL: https://packagento.com/aelmizeb/magento2-reports

## At a glance

- **Vendor**: aelmizeb (https://packagento.com/aelmizeb.md)
- **Latest version**: 1.0.1 — released 2025-08-16
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/aelmizeb/magento2-reports and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require aelmizeb/magento2-reports:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

A Magento 2 module that adds reports in the admin panel.

## README

[![Version](https://img.shields.io/github/v/tag/aelmizeb/magento2-reports?label=version)](https://github.com/aelmizeb/magento2-reports/releases)
[![PHP](https://img.shields.io/badge/php-8.1%20%7C%208.2%20%7C%208.3%20%7C%208.4-blue)]()
[![Magento](https://img.shields.io/badge/Magento-2.4.x-orange)]()
[![License](https://img.shields.io/github/license/aelmizeb/magento2-reports)](LICENSE)

---

![Mage-OS Compatible](./docs/images/Mage-OS-Compatible.png)

---

### 🔎 Preview
![Dashboard Preview](./docs/images/preview-dashboard.png)
![Config Preview](./docs/images/preview-config.png)

### ✨ Description

Advanced Reports for Magento 2 is a free extension which helps stores quickly access advanced reports on the Dashboard. As your shop grows, so does the amount of data you have to deal with every day. Eventually, it reaches a point where you find yourself in dire need of a tool that can handle analytics and insights for you. This module provides visual dashboards and detailed statistics to help you make informed business decisions.

### ❗ Disclaimer

This module has the potential to make irreversible changes to your database if set up incorrectly. Use at your own risk. Always test in a staging environment before deploying to production.

### 🛠 Features

- Sales overview dashboard
- Sales by country/location chart
- Customer growth over time
- Annual sales objective tracking
- Top-selling products chart (using ECharts)
- Dynamic, filterable charts for clear data visualization
- Fully integrated with the Magento 2 admin panel
- Responsive design and clean UI

### 💻 Installation

Run the following commands:

```bash
composer require aelmizeb/magento2-reports
php bin/magento module:enable Originalapp_Reports
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
php bin/magento cache:flush
```

### 🧩 Compatibility
Magento Open Source 2.4.x+ 
Mage OS 1.3.x+ 

PHP 8.1+

Compatible with most custom and third-party themes

### 🚀 Support
This is a free and open-source module provided as-is with no guaranteed support. However, contributions, suggestions, or issues can be submitted via GitHub.


### 🤝 Contributing
Contributions are welcome!
If you'd like to contribute:

- Fork the repository
- Create your feature branch (git checkout -b feature/my-feature)
- Commit your changes (git commit -m 'Add new feature')
- Push to the branch (git push origin feature/my-feature)
- Open a Pull Request

### 🛡 License
This project is licensed under the MIT License.

## Recent Versions

| Version | Released |
|---|---|
| 1.0.1 | 2025-08-16 |
| 1.0.0 | 2025-08-13 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | 103.0.* |
| magento/module-catalog | 104.0.* |
| php | ~8.1.0 \|\| ~8.2.0 \|\| ~8.3.0 \|\| ~8.4.0 |

## Quality

Latest release (1.0.1) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | 1 | not tested |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 120 | 28 errors, 92 warnings (ruleset: Magento2) — 23 auto-fixable with phpcbf |
| PHPMD | Warning | 11 | 11 rule violations (UnusedFormalParameter:5, MissingImport:4, UnusedLocalVariable:2) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 7 | 7 | – | – |
| 2.4.8 | – | 7 | 7 | – |
| 2.4.9 | – | – | 8 | N/A |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["aelmizeb/magento2-reports"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

aelmizeb is a Magento 2 vendor on Packagento. See https://packagento.com/aelmizeb.md for their full catalogue.