PHPackages                             dwenzel/reporter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [PDF & Document Generation](/categories/documents)
4. /
5. dwenzel/reporter

ActiveTypo3-cms-extension[PDF & Document Generation](/categories/documents)

dwenzel/reporter
================

Reporting extension for the TYPO3 CMS

2.0.0(11mo ago)124.2kGPL-2.0+PHP

Since Jan 25Pushed 11mo ago2 watchersCompare

[ Source](https://github.com/dwenzel/reporter)[ Packagist](https://packagist.org/packages/dwenzel/reporter)[ RSS](/packages/dwenzel-reporter/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (18)Versions (13)Used By (0)

Reporter
========

[](#reporter)

Reporting extension for the TYPO3 CMS that provides additional reporting and auditing capabilities for TYPO3 instances.

Requirements
------------

[](#requirements)

- TYPO3 CMS >= 12.4 or >= 13.4
- PHP >= 8.1
- Instance in *Composer Mode*
- `cpsit/auditor` package for auditing functionality
- `cpsit/api-token` package for API authentication
- `dwenzel/reporter-api` package for API endpoints

What does it do
---------------

[](#what-does-it-do)

**Reporter** provides comprehensive reporting and auditing capabilities for your TYPO3 instance:

- **System Information Toolbar**: Displays bundle name and version in the TYPO3 backend toolbar
- **Backend Reports Module**: Detailed reports including:
    - Composer bundle information
    - Package dependency analysis
    - Security and compliance auditing
- **REST API Endpoints**: External system integration capabilities
- **Package Analysis**: Extensive reflection system for composer package metadata

Features
--------

[](#features)

### Backend Integration

[](#backend-integration)

- System Information Toolbar integration showing current bundle status
- Dedicated Reports module with comprehensive package information
- Real-time dependency analysis and version tracking

### API Capabilities

[](#api-capabilities)

- REST API middleware for external integrations
- Custom route compilation and enhancement
- Standardized endpoints for system reporting

### Package Analysis

[](#package-analysis)

The extension includes an extensive property reflection system that analyzes:

- Package properties (Name, Version, Description, License, Keywords, etc.)
- Distribution information (URL, Type, Reference)
- Source information (URL, Type, Reference)
- Configuration details (Scripts, Repositories, Extra data)

Installation
------------

[](#installation)

Install via Composer:

```
composer require dwenzel/reporter
```

Activate the extension in the TYPO3 Extension Manager or via CLI:

```
vendor/bin/typo3 extension:activate reporter
```

API Configuration
-----------------

[](#api-configuration)

The Reporter extension provides REST API endpoints for external system integration. Follow these steps to configure and use the API:

### 1. Import API Routes

[](#1-import-api-routes)

Add the Reporter API route enhancers to your TYPO3 site configuration file (`config/sites/{site-identifier}/config.yaml`):

```
routeEnhancers:
  ReporterApi:
    type: ReporterApiEnhancer
    limitToPath: '/api/reporter/v{version}'
    namespace: 'rest_api'
    routes:
      - { routePath: '/application/report', method: 'GET', default: true }
    defaults:
      version: '1'
    requirements:
      version: '\d+'
```

### 2. Generate API Token

[](#2-generate-api-token)

The Reporter API uses token-based authentication via the `cpsit/api-token` package. Generate tokens using the CLI:

**Interactive Mode:**

```
./vendor/bin/typo3 apitoken:generate
```

**Non-Interactive Mode:**

```
./vendor/bin/typo3 apitoken:generate \
    --name="Reporter API Token" \
    --description="Authentication for reporter API endpoints" \
    --expires="+6 months" \
    --no-interaction
```

**JSON Output for Automation:**

```
./vendor/bin/typo3 apitoken:generate \
    --name="Reporter API Token" \
    --output-format=json \
    --no-interaction
```

**Backend Module:**

1. Navigate to **System** > **API Token Management**
2. Click **Create New Token**
3. Fill in name, description, and expiration
4. **Important:** Copy the secret immediately - it won't be shown again!

### 3. API Usage

[](#3-api-usage)

#### Available Endpoints

[](#available-endpoints)

- `GET /api/reporter/v1/application/report` - Retrieve application report data

#### Authentication Headers

[](#authentication-headers)

All API requests require the following headers:

```
x-api-identifier: {your-api-identifier}
application-authorization: {your-api-secret}
Content-Type: application/json
```

#### Example Requests

[](#example-requests)

**cURL:**

```
curl -X GET "https://your-site.com/api/reporter/v1/application/report" \
     -H "x-api-identifier: 4a6f8b2e3d" \
     -H "application-authorization: 7a5c9f2b-4d8e-1a3c-9e5f-2b4d8e1a3c82" \
     -H "Content-Type: application/json"
```

**HTTP File (for IDE testing):**

```
GET https://your-site.com/api/reporter/v1/application/report
x-api-identifier: 4a6f8b2e3d
application-authorization: 7a5c9f2b-4d8e-1a3c-9e5f-2b4d8e1a3c82
Content-Type: application/json
```

#### Response Format

[](#response-format)

The API returns JSON responses with application report data including:

- Bundle information
- Package versions
- Dependency analysis
- System configuration details

### 4. Security Considerations

[](#4-security-considerations)

- **Token Management**: API tokens should be stored securely and rotated regularly
- **Access Control**: Limit API access to authorized systems only
- **HTTPS**: Always use HTTPS in production environments
- **Expiration**: Set appropriate expiration dates for tokens

Dependencies
------------

[](#dependencies)

- **Core Dependencies**:

    - `typo3/cms-core`: ^12.4 || ^13.4
    - `typo3/cms-reports`: ^12.4 || ^13.4
    - `cpsit/auditor`: ^1.0.0
    - `cpsit/api-token`: For API authentication
    - `dwenzel/reporter-api`: For API endpoints
- **Development Dependencies**:

    - PHPUnit for testing
    - PHP-CS-Fixer for code standards
    - PHPStan for static analysis
    - TYPO3 Rector for code migrations

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance50

Moderate activity, may be stable

Popularity22

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 97% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~330 days

Recently: every ~561 days

Total

8

Last Release

349d ago

Major Versions

0.4.1 → 1.0.02023-01-06

1.0.0 → 2.0.02025-05-30

### Community

Maintainers

![](https://www.gravatar.com/avatar/d475c20d671c5a196b3982ec3576ef36a8b2b557c88ded4f666a69c6c1a5aa50?d=identicon)[dwenzel](/maintainers/dwenzel)

---

Top Contributors

[![dwenzel](https://avatars.githubusercontent.com/u/712458?v=4)](https://github.com/dwenzel "dwenzel (65 commits)")[![eliashaeussler](https://avatars.githubusercontent.com/u/16313625?v=4)](https://github.com/eliashaeussler "eliashaeussler (1 commits)")[![vladimirfalconpiva](https://avatars.githubusercontent.com/u/16591165?v=4)](https://github.com/vladimirfalconpiva "vladimirfalconpiva (1 commits)")

---

Tags

Auditreportextensiontypo3

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/dwenzel-reporter/health.svg)

```
[![Health](https://phpackages.com/badges/dwenzel-reporter/health.svg)](https://phpackages.com/packages/dwenzel-reporter)
```

###  Alternatives

[christophlehmann/imageoptimizer

Optimize uploaded/processed images with binaries of your choice

46501.8k](/packages/christophlehmann-imageoptimizer)[drutiny/drutiny

This is a generic Drupal 7 and Drupal 8 site auditing and optional remediation tool.

132122.2k17](/packages/drutiny-drutiny)[georgringer/redirect-generator

Generate redirect entries from a given set of URLs and export all to CSV

1645.5k](/packages/georgringer-redirect-generator)[custom-it/yii2-excel-report

An extension for generate excel file from GridView content

371.9k](/packages/custom-it-yii2-excel-report)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)