Download the PHP package dwenzel/reporter-api without Composer
On this page you can find all versions of the php package dwenzel/reporter-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
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.
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 PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- 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.
Please rate this library. Is it a good library?
Informations about the package reporter-api
Reporter API
A modern PHP library providing a reporting API for web applications. Designed as PSR-7/PSR-15 middleware that collects and reports application status information including installed packages, repositories, and application metadata.
Features
- 🚀 Modern PHP 8.1+ with native enums, constructor property promotion, and strict types
- 📊 Application Status Reporting with package information and metadata
- 🔌 PSR-7/PSR-15 Compatible middleware for easy integration
- 🎯 Null Object Pattern for robust error handling
- 📋 OpenAPI 3.0 Specification with complete API documentation
- 🧪 100% Test Coverage with PHPUnit 11
- 🔐 JWT Authentication support
Requirements
- PHP 8.1+ (required for native enum support)
- Composer for dependency management
- PHPUnit 10.5+ or 11.0+ for testing (dev dependency)
Installation
Install via Composer:
Quick Start
Basic Usage as PSR-15 Middleware
Using the Report Endpoint Directly
Working with Application Status
API Endpoints
GET /api/reporter/v1/application/report
Returns a comprehensive JSON report containing:
- Application metadata (name, ID, status)
- Installed package information with versions
- Repository details
- Status indicators
Example Response:
Architecture
Core Components
Api: Main PSR-15 middleware class with endpoint routingEndpoint\Report: Primary reporting endpoint implementationSchema\*: Data models representing API response structureHttp\*: PSR-7 HTTP message implementations
Design Patterns
- Endpoint Routing: Path-based routing with lazy loading
- Schema Serialization: JSON serialization via traits
- Null Object Pattern: Robust error handling
- Dependency Integration: Leverages
cpsit/auditorfor package discovery
Testing
Run the test suite:
Test Coverage
The library maintains 100% test coverage with comprehensive unit tests for all components.
Configuration
Custom Endpoint Registration
JWT Authentication
The API supports JWT token authentication as defined in the OpenAPI specification. Include the api_key header in your requests:
Development
Project Structure
Modern PHP Features
This library showcases modern PHP development practices:
- Native Enums (PHP 8.1):
ApplicationStatusenum with string backing - Constructor Property Promotion (PHP 8.0): Clean, concise constructors
- Typed Properties (PHP 7.4): All properties are strictly typed
- Strict Types: Enabled across the entire codebase
- Union Types: Used where appropriate for flexibility
Contributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes with proper tests
- Ensure all tests pass (
composer test) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Code Standards
- PHP 8.1+ with strict types
- PSR-4 autoloading
- PSR-7/PSR-15 compliance
- 100% test coverage
- Modern PHP conventions
API Documentation
Complete API documentation is available in the OpenAPI 3.0 specification:
- OpenAPI Spec:
reporterApi.yaml - Interactive Documentation: Use tools like Swagger UI to explore the API
License
This project is licensed under the GPL-2.0+ License - see the LICENSE file for details.
Authors
- Dirk Wenzel - Initial work and maintenance
Dependencies
Runtime Dependencies
- PHP 8.1+: Core language requirement
- cpsit/auditor: Package information gathering
- web-token/jwt-framework: JWT token handling
Development Dependencies
- PHPUnit 10.5+/11.0+: Testing framework
- roave/security-advisories: Security vulnerability monitoring
Changelog
See ChangeLog for a detailed history of changes and improvements.
Need help? Open an issue on GitHub or check the OpenAPI specification for detailed API documentation.
All versions of reporter-api with dependencies
PHP Build Version
Package Version
Requires
php Version
>=8.1
cpsit/auditor Version *
web-token/jwt-framework Version ^2.0 || ^3.1 || ^4.1
cpsit/auditor Version *
web-token/jwt-framework Version ^2.0 || ^3.1 || ^4.1
The package dwenzel/reporter-api contains the following files
Loading the files please wait ...