Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chillerlan/php-qrcode

A PHP QR Code generator and reader with a user-friendly API.
https://github.com/chillerlan/php-qrcode

drupal-module imagemagick let-php5-die php php-library php5-is-dead php7 php7-is-dead php8 phpqrcode qr-code qr-generator qr-reader qrcode qrcode-generator qrcode-reader qrcode-scanner svg wordpress-plugin

Last synced: 6 days ago
JSON representation

A PHP QR Code generator and reader with a user-friendly API.

Host: GitHub
URL: https://github.com/chillerlan/php-qrcode
Owner: chillerlan
License: apache-2.0
Created: 2015-11-30T20:27:07.000Z (about 9 years ago)
Default Branch: main
Last Pushed: 2024-10-17T09:32:58.000Z (2 months ago)
Last Synced: 2024-10-29T11:23:37.304Z (about 2 months ago)
Topics: drupal-module, imagemagick, let-php5-die, php, php-library, php5-is-dead, php7, php7-is-dead, php8, phpqrcode, qr-code, qr-generator, qr-reader, qrcode, qrcode-generator, qrcode-reader, qrcode-scanner, svg, wordpress-plugin
Language: PHP
Homepage: https://smiley.codes/qrcode/
Size: 22.2 MB
Stars: 1,986
Watchers: 45
Forks: 295
Open Issues: 7
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-ASL-2.0

Awesome Lists containing this project

README

        # chillerlan/php-qrcode

A PHP QR Code generator based on the [implementation by Kazuhiko Arase](https://github.com/kazuhikoarase/qrcode-generator), namespaced, cleaned up, improved and other stuff. 


It also features a QR Code reader based on a [PHP port](https://github.com/khanamiryan/php-qrcode-detector-decoder) of the [ZXing library](https://github.com/zxing/zxing).

**Attention:** there is now also a javascript port on NPM: [@chillerlan/qrcode](https://www.npmjs.com/package/@chillerlan/qrcode).

[![PHP Version Support][php-badge]][php]

[![Packagist version][packagist-badge]][packagist]

[![Continuous Integration][gh-action-badge]][gh-action]

[![CodeCov][coverage-badge]][coverage]

[![Codacy][codacy-badge]][codacy]

[![Packagist downloads][downloads-badge]][downloads]

[![Documentation][readthedocs-badge]][readthedocs]

[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-qrcode?logo=php&color=8892BF&logoColor=fff

[php]: https://www.php.net/supported-versions.php

[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-qrcode.svg?logo=packagist&logoColor=fff

[packagist]: https://packagist.org/packages/chillerlan/php-qrcode

[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-qrcode/ci.yml?branch=main&logo=github&logoColor=fff

[gh-action]: https://github.com/chillerlan/php-qrcode/actions/workflows/ci.yml?query=branch%3Amain

[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-qrcode/main?logo=codecov&logoColor=fff

[coverage]: https://app.codecov.io/gh/chillerlan/php-qrcode/tree/main

[codacy-badge]: https://img.shields.io/codacy/grade/edccfc4fe5a34b74b1c53ee03f097b8d/main?logo=codacy&logoColor=fff

[codacy]: https://app.codacy.com/gh/chillerlan/php-qrcode/dashboard?branch=main

[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-qrcode?logo=packagist&logoColor=fff

[downloads]: https://packagist.org/packages/chillerlan/php-qrcode/stats

[readthedocs-badge]: https://img.shields.io/readthedocs/php-qrcode/main?logo=readthedocs&logoColor=fff

[readthedocs]: https://php-qrcode.readthedocs.io/en/main/

# Overview

## Features

- Creation of [Model 2 QR Codes](https://www.qrcode.com/en/codes/model12.html), [Version 1 to 40](https://www.qrcode.com/en/about/version.html)

- [ECC Levels](https://www.qrcode.com/en/about/error_correction.html) L/M/Q/H supported

- Mixed mode support (encoding modes can be combined within a QR symbol). Supported modes:

  - numeric

  - alphanumeric

  - 8-bit binary

    - [ECI support](https://en.wikipedia.org/wiki/Extended_Channel_Interpretation)

  - 13-bit double-byte:

    - kanji (Japanese, Shift-JIS)

    - hanzi (simplified Chinese, GB2312/GB18030) as [defined in GBT18284-2000](https://www.chinesestandard.net/PDF/English.aspx/GBT18284-2000)

- Flexible, easily extensible output modules, built-in support for the following output formats:

  - [GdImage](https://www.php.net/manual/book.image) (raster graphics: avif, bmp, gif, jpeg, png, webp)

  - [ImageMagick](https://www.php.net/manual/book.imagick) ([multiple supported image formats](https://imagemagick.org/script/formats.php))

  - Markup types: SVG, HTML, etc.

  - String types: JSON, plain text, etc.

  - Encapsulated Postscript (EPS)

  - PDF via [FPDF](https://github.com/setasign/fpdf)

- QR Code reader (via GD and ImageMagick)

## Requirements

- PHP 8.2+

  - [`ext-mbstring`](https://www.php.net/manual/book.mbstring.php)

  - optional:

    - [`ext-gd`](https://www.php.net/manual/book.image) for `QRGdImage` based output

    - [`ext-imagick`](https://github.com/Imagick/imagick) with [ImageMagick](https://imagemagick.org) installed

    - [`ext-fileinfo`](https://www.php.net/manual/book.fileinfo.php) required by `QRImagick` output

    - [`setasign/fpdf`](https://github.com/setasign/fpdf) for the PDF output module

    - [`intervention/image`](https://github.com/Intervention/image) for alternative GD/ImageMagick output

For the QR Code reader, either `ext-gd` or `ext-imagick` is required!

# Documentation

- The user manual is at https://php-qrcode.readthedocs.io/ ([sources](https://github.com/chillerlan/php-qrcode/tree/main/docs))

- An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-qrcode/

- The documentation for the `QROptions` container can be found here: [chillerlan/php-settings-container](https://github.com/chillerlan/php-settings-container#readme)

**Important: Please use the examples from the branch that matches your installed php-qrcode version (

[v4.x](https://github.com/chillerlan/php-qrcode/tree/v4.3.x/examples),

[v5.x](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/examples),

[dev-main](https://github.com/chillerlan/php-qrcode/tree/main/examples)

)!**

## Installation with [composer](https://getcomposer.org)

See [the installation guide](https://php-qrcode.readthedocs.io/en/main/Usage/Installation.html) for more info!

### Terminal

```

composer require chillerlan/php-qrcode

```

### composer.json

```json

{

	"require": {

		"php": "^8.2",

		"chillerlan/php-qrcode": "dev-main#"

	}

}

```

Note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^5.0` - see [releases](https://github.com/chillerlan/php-qrcode/releases) for valid versions.

## Quickstart

We want to encode this URI for a mobile authenticator into a QRcode image:

```php

$data = 'otpauth://totp/test?secret=B3JX4VCVJDVNXNZ5&issuer=chillerlan.net';

// quick and simple:

echo '';

```

Wait, what was that? Please again, slower! See [Advanced usage](https://php-qrcode.readthedocs.io/en/main/Usage/Advanced-usage.html) in the manual.

Also, have a look [in the examples folder](https://github.com/chillerlan/php-qrcode/tree/main/examples) for some more usage examples.



	



## Reading QR Codes

Using the built-in QR Code reader is pretty straight-forward:

```php

// it's generally a good idea to wrap the reader in a try/catch block because it WILL throw eventually

try{

	$result = (new QRCode)->readFromFile('path/to/file.png'); // -> DecoderResult

	// you can now use the result instance...

	$content = $result->data;

	$matrix  = $result->getMatrix(); // -> QRMatrix

	// ...or simply cast it to string to get the content:

	$content = (string)$result;

}

catch(Throwable $e){

	// oopsies!

}

```

# Shameless advertising

Hi, please check out some of my other projects that are way cooler than qrcodes!

- [js-qrcode](https://github.com/chillerlan/js-qrcode) - a javascript port of this library

- [php-authenticator](https://github.com/chillerlan/php-authenticator) - a Google Authenticator implementation (see [authenticator example](https://github.com/chillerlan/php-qrcode/blob/main/examples/authenticator.php))

- [php-httpinterface](https://github.com/chillerlan/php-httpinterface) - a PSR-7/15/17/18 implemetation

- [php-oauth](https://github.com/chillerlan/php-oauth) - an OAuth 1/2 client library, fully PSR-7/PSR-17/PSR-18 compatible

- [php-database](https://github.com/chillerlan/php-database) - a database client & querybuilder for MySQL, Postgres, SQLite, MSSQL, Firebird

- [php-tootbot](https://github.com/php-tootbot/tootbot-template) - a Mastodon bot library (see [@dwil](https://github.com/php-tootbot/dwil))

# Disclaimer!

I don't take responsibility for molten CPUs, misled applications, failed log-ins etc.. Use at your own risk!

## License notice

- Parts of this code are [ported to PHP](https://github.com/codemasher/php-qrcode-decoder) from the [ZXing project](https://github.com/zxing/zxing) and licensed under the [Apache License, Version 2.0](./NOTICE).

- [The documentation](https://github.com/chillerlan/php-qrcode/tree/main/docs) is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/).

## Trademark Notice

The word "QR Code" is a registered trademark of *DENSO WAVE INCORPORATED*


https://www.qrcode.com/en/faq.html#patentH2Title