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
FAQ
Example:
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 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.
Informations about the package heroqr
HeroQR - A Powerful PHP QR Code Library
Last Updated: March 2025
Author: Amirreza Ebrahimi
Contributors: None yet
License: MIT License
- HeroQR is an advanced and modular PHP library designed to simplify the creation, customization, and management of QR codes. Whether you need a basic QR code or a highly customized one with embedded logos, colors, markers, and cursors, HeroQR has you covered. You can fully customize the appearance of your QR code by adjusting the markers (for corner customization), cursors (for design enhancements), and even the shapes of the QR code itself. This level of customization allows you to tailor your QR codes to fit your needs precisely.
Table of Contents
- HeroQR Library
- Features
- Getting Started
- 1. Installation
- 2. Basic Usage
- 3. Advanced Customization
- 4. Customizing Shapes Markers and Cursors (PNG Only)
- 5. Advanced Output Options
- Project Structure
- Contributing
- License
- Contact
Features
-
Advanced Customization Options:
- Adjust logo size and embed logos into QR codes.
- Automatically adjust QR code layout and margins to ensure proper scaling.
- Change QR code and background colors (RGB or RGBA), including transparency options.
- Add customizable labels with options for color (RGB or RGBA), size, alignment, and margin.
- Support for various encoding formats such as BASE64, UTF-8, UTF-16, and others.
-
Shape, Marker, and Cursor Customization: HeroQR offers enhanced design control by allowing customization of the geometric shape of QR code points, as well as markers and cursors.These features are support:
Sfor Shape type.Mfor Marker type.Cfor Cursor type.- Available marker and cursor types:
- Shapes:
S1,S2,S3,S4 - Markers:
M1,M2,M3,M4 - Cursors:
C1,C2,C3,C4
- Shapes:
- Note: This feature is available only for PNG format at the moment, but additional formats will be supported in future updates.
-
Multi-Format Data Encoding: Easily encode different data types, including URLs, text, emails, business cards, and payment information, ensuring flexibility for all your QR code needs.
-
Data Validation: The library provides validation for various data types such as URLs, text, emails, phone numbers, IP addresses, and Wi-Fi, ensuring the accuracy and validity of input data.
-
Flexible Export Options: QR codes can be exported in various formats, including PDF, SVG, PNG, Binary, GIF, EPS, and WebP. If custom shapes, markers, or cursors are not required, you can choose from these formats for the output.
- Framework Ready: Seamlessly integrates with modern frameworks like Laravel, making it a perfect fit for contemporary web applications.
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
- Generate a simple QR code in just a few lines of code:
Example :
3. Advanced Customization
-
Fully customize the appearance and functionality of your QR code with automatic data validation:
- Customization Options: Modify various parameters such as size, color, logo, and more.
- Automatic Data Validation: By using
DataType(optional), the library automatically validates the type of data being encoded (e.g., URL, Email, Phone, Location, Wifi, Text).
Example :
With these options, you can create visually appealing QR codes that align with your design needs.
4. Customizing Shapes, Markers, and Cursors (PNG Only)
HeroQR allows you to fully customize the markers, cursors, and shapes of your QR codes. This feature is exclusive to PNG output. To use this feature, specify the output format with generate('png', [ ... ]) and include the desired parameters for shape, marker, and cursor types.
Available Options:
- Shapes:
S1,S2,S3,S4 - Markers:
M1,M2,M3,M4 - Cursors:
C1,C2,C3,C4
These options allow you to modify the appearance of the QR code, making it more personalized or stylish. Shapes modify the corners, markers change the patterns on the dots, and cursors adjust the positioning pointers.
Example :
Example QR Code Outputs with Different Combinations : Below are some examples of QR codes generated using various combinations of shapes, markers, and cursors:
| Combination | Shape | Marker | Cursor | Preview |
|---|---|---|---|---|
| S1-M1-C1 | Default (Square) | Default (Square) | Default (Square) | View |
| S2-M2-C2 | Circle | Custom Marker 1 | Custom Cursor 1 | View |
| S3-M3-C3 | Star | Custom Marker 2 | Custom Cursor 2 | View |
| S4-M4-C4 | Diamond | Custom Marker 3 | Custom Cursor 3 | View |
- Experiment with Different Combinations: In this section, you can experiment with various combinations of shapes, markers, and cursors to create unique QR codes that best suit your needs. Each combination will impact the appearance of the QR code, from the corners and points to the positioning of the markers. Simply adjust the parameters to customize your QR codes.
5. Advanced Output Options
HeroQR provides advanced output capabilities, offering flexibility and compatibility for various use cases, from web embedding to raw data manipulation:
-
String Representation : Retrieve the QR code as a raw string, which can be useful for direct processing or custom transformations.
-
Matrix Output : Represent the QR code as a matrix (2D array) of bits, where each block of the matrix corresponds to a specific piece of the encoded data. You can retrieve the matrix in two forms:
- As a
Matrixobject. - As a 2D array, which makes it easier to manipulate or display directly in some applications.
- As a
-
Base64 Encoding : Generate the QR code as a Base64-encoded string, which is ideal for embedding directly in HTML, emails, or other media.
- Saving to Different Formats : You can save the QR code in a variety of formats such as PNG, SVG, GIF, WebP, EPS, PDF, Binary, and more. The format is automatically determined based on the desired output type.
Example
Project Structure
The modular structure of HeroQR is designed to enhance efficiency and scalability, making it easier to use, maintain, and expand:
-
Contracts : Defines interfaces for the core components, ensuring consistency and reusability across the system.
-
Core : Houses the primary logic for generating and managing QR codes, acting as the foundation of the library.
-
DataTypes : Provides definitions and automatic validation for various data types (wifi, Location, URL, Email, Phone, Text). This eliminates the need for users to manually validate their input.
-
Managers : Oversees the customization and processing of QR codes, enabling users to have full control over the appearance and functionality of their QR codes.
-
Customs : The Customs module allows advanced QR code customization, including shapes, cursors, markers, line colors, and other visual elements, perfect for creating unique and tailored designs.
- Tests : Contains unit and integration tests for the library's core functionality. These tests ensure the library works as expected, providing confidence in the stability and correctness of the code.
Contributing
We welcome contributions and appreciate your interest in improving the project! Here's how you can contribute:
-
Fork the repository: Create your own copy of the repository by forking it.
-
Clone your fork: Clone the repository to your local machine:
-
Create a feature branch: Create a new branch for your feature or bug fix.
-
Make changes: Work on your feature or fix the issue.
-
Write tests: Ensure your changes are covered by tests. If you're fixing a bug, add a test to verify the fix.
-
Commit your changes: Commit your changes with clear, descriptive messages.
-
Push your branch: Push your changes to your forked repository.
-
Open a Pull Request: Once your branch is pushed, open a Pull Request on GitHub for review. Be sure to:
- Provide a clear description of what your changes do.
- Include any relevant issue numbers (e.g., Fixes #123).
- Participate in the review process: After submitting the pull request, review any feedback and make necessary changes.
We’ll review and merge your changes as soon as possible. Thank you for contributing!
License
HeroQR is released under the MIT License, giving you the freedom to use, modify, and distribute it.
Contact
For inquiries or feedback, feel free to reach out via email, GitHub issues, or LinkedIn:
- Author : Amirreza Ebrahimi
- Email : [email protected]
- GitHub Issues : GitHub Repository
- LinkedIn : My LinkedIn
Transform your projects with HeroQR today! 🚀
