HeroQR

Библиотека HeroQR

HeroQR — это расширенная модульная библиотека PHP, предназначенная для упрощения создания, настройки и управления QR-кодами. Нужен ли вам базовый QR-код или персонализированный код со встроенными логотипами и цветами, HeroQR поможет вам.

Функции

• Непревзойденная настройка:

  • Отрегулируйте размер логотипа и добавьте логотипы в QR-код.
  • Добавляйте метки с настраиваемым цветом, размером, выравниванием текста и полями.
  • Поддержка различных форматов кодировки, таких как UTF-8 и других стандартных форматов.
  • Измените цвет QR-кода вместе с цветом фона.
  • Автоматически настраивайте макет и поля QR-кода.

• Многоформатное кодирование данных: легко кодируйте URL-адреса, текст, электронные письма, визитные карточки и платежную информацию.

• Проверка данных: библиотека поддерживает проверку различных типов данных, включая URL-адрес, текст, электронную почту, номер телефона, IP-адрес и Wi-Fi, обеспечивая точность входных данных.

• Гибкие возможности экспорта: сохраняйте QR-коды в различных форматах, включая PDF, SVG, PNG, двоичные файлы, GIF, EPS и WebP, обеспечивая совместимость с различными проектами.

• Готовность к фреймворку: легко интегрируется с такими фреймворками, как Laravel, что делает его идеальным для современных приложений.

Установка

Используйте Composer для установки библиотеки. Также убедитесь, что вы включили и настроили расширение GD, если хотите создавать изображения.

composer require amirezaeb/ HeroQR 

Начиная

1. Основное использование

Создайте простой QR-код всего за несколько строк кода:

Пример :

HeroQRCoreQRCodeGenerator; $qrCodeManager = new QRCodeGenerator(); $qrCode = $qrCodeManager # Set the data to be encoded in the QR code ->setData('https://test.org') # Generate the QR code in PNG format ->generate('png') ; # Save the generated QR code to a file named 'qrcode.png' $qrCode->saveTo('qrcode'); ">

 require ' vendor/autoload.php ' ;

use HeroQR  Core  QRCodeGenerator ;

$ qrCodeManager = new QRCodeGenerator ();

$ qrCode = $ qrCodeManager
    # Set the data to be encoded in the QR code
    -> setData ( ' https://test.org ' ) 
    # Generate the QR code in PNG format
    -> generate ( ' png ' ) ;

# Save the generated QR code to a file named 'qrcode.png'
$ qrCode -> saveTo ( ' qrcode ' ); 

2. Расширенная настройка

Полностью настройте внешний вид и функциональность вашего QR-кода, гарантируя при этом проверку данных:

• Параметры настройки : вы можете изменить различные параметры, такие как размер, цвет, логотип и другие визуальные аспекты.
• Автоматическая проверка данных : используя DataType (необязательно), библиотека автоматически проверяет тип кодируемых данных (URL-адрес, электронная почта, телефон, местоположение, Wi-Fi, текст).

Пример :

HeroQRDataTypesDataType; $qrCode = $qrCodeManager # Set the data to be encoded and validation Email ->setData('[email protected]', DataType::Email) # Set the background color ->setBackgroundColor('#000000') # Set the QR code's color ->setColor('#b434eb') # Set the size ->setSize(350) # Set the logo to be embedded at the center # Set the logo size default value is 40 ->setLogo('../assets/HeroExpert.png', 30 ) # Set the margin around ->setMargin(10) # Set the character encoding ->setEncoding('UTF-8') # Set the label ->setLabel( # Label Text label: 'My Email', # Label align textAlign: 'center', # Label text color textColor: '#a503fc', # Label size default value is 20 fontSize: 15, # Label margin default value is (0, 10, 10, 10) margin: [15, 15, 15, 15] ) # Generate the QR code in WebP format ->generate('webp'); # Save the generated QR code to a file $qrCode->saveTo('custom-qrcode'); ">

 use HeroQR  DataTypes  DataType ;

$ qrCode = $ qrCodeManager
    # Set the data to be encoded and validation Email
    -> setData ( ' [email protected] ' , DataType::Email)  
    # Set the background color
    -> setBackgroundColor ( ' #000000 ' )
    # Set the QR code's color
    -> setColor ( ' #b434eb ' )
    # Set the size
    -> setSize ( 350 )
    # Set the logo to be embedded at the center
    # Set the logo size default value is 40
    -> setLogo ( ' ../assets/HeroExpert.png ' , 30 )
    # Set the margin around
    -> setMargin ( 10 )
    # Set the character encoding
    -> setEncoding ( ' UTF-8 ' )
    # Set the label 
    -> setLabel (
        # Label Text
        label: ' My Email ' ,
        # Label align
        textAlign: ' center ' ,
        # Label text color
        textColor: ' #a503fc ' ,
        # Label size default value is 20
        fontSize: 15 ,
        # Label margin default value is (0, 10, 10, 10)
        margin: [ 15 , 15 , 15 , 15 ] 
    )
    # Generate the QR code in WebP format
    -> generate ( ' webp ' );

# Save the generated QR code to a file
$ qrCode -> saveTo ( ' custom-qrcode ' ); 

С помощью этих опций вы можете создавать визуально привлекательные QR-коды, соответствующие вашим потребностям в дизайне.

3. Расширенные параметры вывода

HeroQR поддерживает расширенные параметры вывода для большей гибкости при создании QR-кодов:

• Выход матрицы : представляет QR-код в виде матрицы (2D-массива) битов, где каждый блок матрицы соответствует определенной части закодированных данных. Вы можете получить матрицу в двух формах:

  • Как объект Matrix .
  • В виде 2D-массива, что упрощает манипулирование или непосредственное отображение в некоторых приложениях.

• Кодировка Base64 : сгенерируйте QR-код в виде строки в кодировке Base64, которая идеально подходит для встраивания непосредственно в HTML, электронные письма или другие носители.

• URI данных : получите QR-код в виде URI данных, который представляет собой компактное строковое представление изображения, которое можно внедрить непосредственно в HTML.

• Сохранение в различных форматах . Вы можете сохранить QR-код в различных форматах, таких как PNG, SVG, GIF, WebP, EPS, PDF, двоичный и других. Формат определяется автоматически в зависимости от желаемого типа вывода.

Пример :

 # Get the QR code as a string representation
$ string = $ qrCode -> getString ();

# Get the QR code as a matrix object
$ matrix = $ qrCode -> getMatrix ();

# Get the matrix as a 2D array
$ matrixArray = $ qrCode -> getMatrixAsArray ();

# Get the QR code as Base64 encoding for embedding in HTML
$ dataUri = $ qrCode -> getDataUri ();

# Save the QR code to a file in the desired format (WebP, GIF, Binary, Esp, PNG, SVG, PDF)
$ qrCode -> saveTo ( ' qr_code_output ' );

Структура проекта

Модульная структура HeroQR обеспечивает простоту использования и масштабируемость:

• Контракты: определяют интерфейсы для основных компонентов, обеспечивая согласованность во всей системе.
• Ядро: содержит основную логику для создания и управления QR-кодами.
• DataTypes: обрабатывает определения для различных типов данных (местоположение, URL-адрес, электронная почта, телефон, текст) и выполняет автоматическую проверку для каждого типа, поэтому пользователям не нужно проверять данные вручную.
• Менеджеры: управляет настройкой и обработкой QR-кодов, обеспечивая максимальную гибкость для пользователей.

Содействие

Мы приветствуем ваш вклад! Вот как вы можете принять участие:

1. Форкните репозиторий.
2. Создайте ветку функции: git checkout -b feature-name .
3. Зафиксируйте изменения с помощью четких сообщений: git commit -m 'Add feature-name' .
4. Отправьте свою ветку: git push origin feature-name .
5. Откройте запрос на включение для проверки.

Лицензия

HeroQR выпускается под лицензией MIT, что дает вам свободу использовать, изменять и распространять его.

Контакт

Есть вопросы или предложения? Давайте подключим:

• Автор: Амирреза Эбрахими.
• Электронная почта: [email protected]
• GitHub: АмиррезаЭб

---

Преобразуйте свои проекты с помощью HeroQR уже сегодня!