Download the PHP package amirezaeb/heroqr without Composer
On this page you can find all versions of the php package amirezaeb/heroqr. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download amirezaeb/heroqr
More information about amirezaeb/heroqr
Files in amirezaeb/heroqr
Package heroqr
Short Description A Powerful QR Code Management Library For PHP
License MIT
Homepage https://github.com/AmirezaEb/HeroQR
Rated 4.75 based on 8 reviews
Informations about the package heroqr
HeroQR - QR Code Library for PHP
HeroQR is a PHP library for generating and customizing QR codes with full control over styling and multi-format output, while remaining ISO/IEC 18004 compliant.
Table of Contents
- Features
- Getting Started
- Project Structure
- Support & Sponsorship
- Contributing
- License
- Contact
Features
-
Customization
- Logo embedding with size control
- Full color control (RGB/RGBA with transparency)
- Custom labels with alignment, styling, and spacing
- Automatic layout optimization for readability
-
Geometric Styling
- Custom module shapes
- Custom corner markers and cursors
- Multiple predefined design styles (S, M, C sets)
- SVG and PNG support for advanced rendering
-
Data Support
- Generate QR codes for URLs, text, emails, vCards, WiFi, and more
- Support for UTF-8 / UTF-16 / Base64 encoding
-
Validation
- Built-in validation for URLs, emails, phones, IPs, and WiFi credentials
-
Export Formats
- PNG, SVG, PDF, WebP, EPS, GIF, Binary output support
- Reliability
- Framework-agnostic, Laravel-ready design
- Extensive test coverage ensuring ISO/IEC 18004 compliance
Getting Started
1. Installation
Use Composer to install the library. Also make sure you have enabled and configured the GD extension if you want to generate images.
2. Basic Usage
Example:
The saveTo() method automatically resolves and appends the appropriate file extension based on the selected output format.
3. Advanced Customization
Advanced configuration options for full control over QR code generation and validation.
Granular Customization: Fine-tune colors, size, logos, and typography.
Smart Validation: Use the optional DataType to automatically validate inputs like URL, Email, Phone, Wi-Fi, and more.
Example:
4. Customizing Shapes, Markers, and Cursors
HeroQR supports custom styling for QR modules, corner markers, and alignment cursors.
This feature is available for PNG and SVG output formats.
Available Options:
- Shapes (Modules):
S1toS4 - Markers (Corners):
M1toM6 - Cursors (Inner Markers):
C1toC6
Example:
Examples
| Combination | Shape (Body) | Marker (Corner) | Cursor (Inner) | Preview |
|---|---|---|---|---|
| S1-M1-C1 | Square (Default) | Square (Default) | Square (Default) | View |
| S2-M2-C2 | Circle (Custom) | Circle (Custom) | Circle (Custom) | View |
| S3-M3-C3 | Star (Custom) | D-Drop-O (Custom) | D-Drop-O (Custom) | View |
| S4-M4-C4 | Diamond (Custom) | D-Drop-I (Custom) | D-Drop-I (Custom) | View |
| S4-M5-C5 | Diamond (Custom) | D-Drop-IO (Custom) | D-Drop-IO (Custom) | View |
| S4-M6-C6 | Diamond (Custom) | Square-O (Custom) | Square-O (Custom) | View |
5. Advanced Output Options
HeroQR supports multiple output formats for flexible usage in web, CLI, and custom rendering environments.
Available Outputs
- Raw string representation
- Matrix object / 2D array
- Base64 Data URI (for direct HTML embedding)
- Multi-format export (PNG, SVG, GIF, WebP, EPS, PDF)
Example:
Project Structure
HeroQR follows a modular architecture designed for scalability and maintainability.
Module Overview:
- Contracts: Core interfaces defining system boundaries and extensibility
- Core: QR code generation engine
- DataTypes: Input validation layer for structured data (URL, Email, WiFi, etc.)
- Managers: Feature orchestration and lifecycle handling
- Customs: Visual customization layer (Shapes, Markers, Cursors)
- Tests: Unit and integration test suite
Support & Sponsorship
If HeroQR is useful in your projects, you can support its development by:
- ⭐ Starring the repository
- 🛠 Contributing via issues or pull requests
- 💰 Donating via TON or USDT
- 💼 Contacting us for sponsorship opportunities
GRAM (TON)
USDT (TRC-20)
TEbQ2K3kWF1TjE4yRuqp6hTH8FRr7n7xGX
Organizations interested in sponsoring HeroQR or featuring their brand in the documentation may contact us via the Contact section.
Contributing
Contributions are welcome.
- Fork the repository.
- Create a feature or bugfix branch.
- Implement your changes and add tests when necessary.
- Commit your changes using the Conventional Commits format.
- Push your branch and open a Pull Request.
Example:
Please provide a clear description of your changes and reference any related issues (e.g. Fixes #123).
License
HeroQR is open-sourced software licensed under the MIT License.
Contact
For inquiries, feedback, or collaborations, feel free to reach out via any of the following channels:
- Author: Amirreza Ebrahimi
- Email: [email protected]
- GitHub: Report an Issue
- LinkedIn: Amirreza Ebrahimi
- Telegram: @a_m_b_r