Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dfridrich/qrplatba

Knihovna pro generování QR plateb v PHP
https://github.com/dfridrich/qrplatba

php qrcode

Last synced: about 10 hours ago
JSON representation

Knihovna pro generování QR plateb v PHP

Host: GitHub
URL: https://github.com/dfridrich/qrplatba
Owner: dfridrich
License: mit
Created: 2016-01-04T19:44:54.000Z (about 9 years ago)
Default Branch: main
Last Pushed: 2023-05-05T10:10:39.000Z (over 1 year ago)
Last Synced: 2025-01-04T03:50:04.200Z (4 days ago)
Topics: php, qrcode
Language: PHP
Homepage:
Size: 180 KB
Stars: 42
Watchers: 5
Forks: 45
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # QR Platba a QR Faktura

[![Latest Stable Version](https://poser.pugx.org/dfridrich/qr-platba/v/stable)](https://packagist.org/packages/dfridrich/qr-platba)

[![Total Downloads](https://poser.pugx.org/dfridrich/qr-platba/downloads)](https://packagist.org/packages/dfridrich/qr-platba)

[![Build Status](https://travis-ci.org/dfridrich/QRPlatba.svg)](https://travis-ci.org/dfridrich/QRPlatba)

[![Coverage Status](https://coveralls.io/repos/github/dfridrich/QRPlatba/badge.svg?branch=master)](https://coveralls.io/github/dfridrich/QRPlatba?branch=master)

![QR Platba 2](logo.png)

Knihovna pro generování QR plateb v PHP. QR platba zjednodušuje koncovému uživateli

provedení příkazu k úhradě, protože obsahuje veškeré potřebné údaje, které stačí jen

naskenovat. Nově lze použít i jiné měny než CZK a to pomocí metody ```setCurrenty($currency)```.

Tato knihovna umožňuje:

- zobrazení obrázku v `````` tagu, který obsahuje v ```src``` rovnou data-uri s QR kódem, takže vygenerovaný

obrázek tak není třeba ukládat na server (```$qrPlatba->getQRCodeImage()```)

- uložení obrázku s QR kódem (```$qrPlatba->saveQRCodeImage()```)

- získání data-uri (```$qrPlatba->getDataUri()```)

- získání instance objektu [QrCode](https://github.com/endroid/QrCode) (```$qrPlatba->getQRCodeInstance()```) 

QRPlatbu v současné době podporují tyto banky:

Air Bank, Česká spořitelna, ČSOB, Equa bank, Era, Fio banka, Komerční banka, mBank, Raiffeisenbank, ZUNO.

Podporuje PHP 7.4 až 8.1.

## Instalace pomocí Composeru

`composer require "dfridrich/qr-platba:^2"`

## Příklad

```php

setAccount('12-3456789012/0100') // nastavení č. účtu

    ->setIBAN('CZ3112000000198742637541') // nastavení č. účtu

    ->setVariableSymbol('2016001234')

    ->setMessage('Toto je první QR platba.')

    ->setConstantSymbol('0308')

    ->setSpecificSymbol('1234')

    ->setAmount('1234.56')

    ->setCurrency('CZK') // Výchozí je CZK, lze zadat jakýkoli ISO kód měny

    ->setDueDate(new \DateTime());

echo $qrPlatba->getQRCodeImage(); // Zobrazí  tag s kódem, viz níže  

```

Ukázky (viz `test/OutputTest.php`), zkuste si je naskenovat v bankovnictví nebo třeba iDokladu jako QR Fakturu:

**QR Platba (PNG):**




**QR Platba v EUR (PNG):**




**QR Platba (SVG):**




**QR Platba a popisek (PNG):**




**QR Platba a popisek v EUR (PNG):**




**QR Platba a popisek (SVG):**




**QR Platba+F a popisek (PNG):**




**QR Platba+F a popisek v EUR (PNG):**




**QR Platba+F a popisek (SVG):**




**QR Faktura bez platby (SVG):**




Lze použít i jednodušší zápis:

```php

echo QRPlatba::create('12-3456789012/0100', 987.60)

    ->setMessage('QR platba je parádní!')

    ->getQRCodeImage();

```

Pro IBAN pak:

```php

echo QRPlatba::create('CZ6508000000192000145399', 987.60)

    ->setMessage('QR platba je parádní!')

    ->getQRCodeImage();

```

### Další možnosti

Uložení do souboru

```php

// Uloží png o velikosti 100x100 px

$qrPlatba->saveQRCodeImage("qrcode.png", "png", 100);

// Uloží svg o velikosti 100x100 px

$qrPlatba->saveQRCodeImage("qrcode.svg", "svg", 100);

// Generování jen QR Faktury

$qrPlatba->setIsOnlyInvoice(true)->setLabel('QR Faktura');

```

Aktuální možné formáty jsou: 

* PNG

* SVG

Pro další je potřeba dopsat vlastní Writer

Zobrazení data-uri

```php

// data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAAFAAQMAAAD3XjfpAAAA...

echo $qrPlatba->getDataUri();

```

## Odkazy

- Oficiální web QR Platby - http://qr-platba.cz/

- Oficiální web QR Faktury - http://qr-faktura.cz/

- Repozitář, který mě inspiroval - https://github.com/snoblucha/QRPlatba

- Fork, ze kterého jsem zpětně přidal a upravil implementaci QR Faktury - https://github.com/bonami/qr-platba

- Image by storyset on Freepik

## Contributing

Budu rád za každý návrh na vylepšení ať už formou issue nebo pull requestu.