PHPackages marcin-orlowski/bank-qrcode-formatter - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. marcin-orlowski/bank-qrcode-formatter ActiveLibrary[Utility & Helpers](/categories/utility) marcin-orlowski/bank-qrcode-formatter ===================================== Builds source string that can be used to generate valid QrCode matching recommendation of Polish banks 1.5.0(1y ago)26.1k↑216.7%[1 issues](https://github.com/MarcinOrlowski/bank-qrcode-formatter/issues)MITPHPPHP >=5.6.0 Since Sep 22Pushed 1y ago1 watchersCompare [ Source](https://github.com/MarcinOrlowski/bank-qrcode-formatter)[ Packagist](https://packagist.org/packages/marcin-orlowski/bank-qrcode-formatter)[ Docs](https://github.com/MarcinOrlowski/bank-qrcode-formatter)[ RSS](/packages/marcin-orlowski-bank-qrcode-formatter/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (7)Dependencies (1)Versions (8)Used By (0) Bank QR Code formatter ====================== [](#bank-qr-code-formatter) Biblioteka formatująca dane dot. przelewu bankowego pod kątem generowania kodów QR rozpoznawanych przez np. aplikacje mobilne banków operujących na rynku polskim (np. mBank, Inteligo). Wynikiem działania biblioteki jest ciąg znaków (string) sformatowany zgodnie z rekomendacją dot. kodów 2D opublikowaną przez [Związek Banków Polskich](https://zbp.pl/getmedia/1d7fef90-d193-4a2d-a1c3-ffdf1b0e0649/2013-12-03_-_Rekomendacja_-_Standard_2D). Otrzymany ciąg znaków należy użyć do wygenerowania kodu QR, używając do tego dowolnej biblioteki do tego przeznaczonej. [![Latest Stable Version](https://camo.githubusercontent.com/fdcb02f44f25b4a07e0daa7e89720c3d07e99313712114389a9f8a5c961462f1/68747470733a2f2f706f7365722e707567782e6f72672f6d617263696e2d6f726c6f77736b692f62616e6b2d7172636f64652d666f726d61747465722f762f737461626c65)](https://packagist.org/packages/marcin-orlowski/bank-qrcode-formatter)[![Build Status](https://camo.githubusercontent.com/71dae6b52fc58fb31fc0f525f90ca103ae23e2c976ee2b04f61fa1d61bf7ced1/68747470733a2f2f7472617669732d63692e6f72672f4d617263696e4f726c6f77736b692f62616e6b2d7172636f64652d666f726d61747465722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/MarcinOrlowski/bank-qrcode-formatter)[![Code Quality](https://camo.githubusercontent.com/8a56768f969e8981547899da40d86271202ba27995222a88e5fa57940af33fec/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4d617263696e4f726c6f77736b692f62616e6b2d7172636f64652d666f726d61747465722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/MarcinOrlowski/bank-qrcode-formatter/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/347280ffc5a8a24bf82603004119e5c35df7a8210cb11f2232465fb80bee9529/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4d617263696e4f726c6f77736b692f62616e6b2d7172636f64652d666f726d61747465722f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/MarcinOrlowski/bank-qrcode-formatter/?branch=master)[![Codacy Grade Badge](https://camo.githubusercontent.com/5d46d8099a2c9efbf9b76e19112872ff423f28eee6c5ba45703b13e984007cb6/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3263623035366162613932623431373938316264316639396133383335326633)](https://www.codacy.com/app/MarcinOrlowski/bank-qrcode-formatter)[![License](https://camo.githubusercontent.com/6a70e3535e161c2baca5728ceafbe9a525a5360aed32ff71a0b2240b6d808b58/68747470733a2f2f706f7365722e707567782e6f72672f6d617263696e2d6f726c6f77736b692f62616e6b2d7172636f64652d666f726d61747465722f6c6963656e7365)](https://packagist.org/packages/marcin-orlowski/bank-qrcode-formatter) Wymagania --------- [](#wymagania) 1. PHP v5.6+ 2. Rozszerzenie `mbstring` Instalacja ---------- [](#instalacja) ``` composer require marcin-orlowski/bank-qrcode-formatter ``` Przykład użycia --------------- [](#przykład-użycia) ``` $str = (new \MarcinOrlowski\QrcodeFormatter\Builder()) ->name('Marcin sp. z o.o.') ->bankAccount('01234567890123456789012345') ->title('FV 1234/2020') ->amount(140.50) ->build(); ``` Zwrócony ciąg znaków (`$str`) należy następnie użyć z dowolną biblioteką do generowania kodów QR: ``` createQrcode($str, '/tmp/qrcode.png'); ``` > [![Uwaga!](img/warning.png)](img/warning.png) Bankowe aplikacje mobilne przeprowadzają weryfikacje danych odczytanych z kodu QR, zatem testując niniejszą bibliotekę, należy użyć prawidłowych danych (tj. numer NIP czy numer rachunku bankowego), w przeciwnym razie wygenerowany kod QR zostanie odrzucony przez większość (jeśli nie wszystkie) aplikacje. API === [](#api) Utworzenie instancji -------------------- [](#utworzenie-instancji) - `public function __construct($type, $strict_mode)` - `$type` (`int`): typ odbiorcy płatności. Dozwolone wartości to `Builder::TYPE_PERSON` (jeśli odbiorcą jest osoba fizyczna) lub `Builder::TYPE_COMPANY` jeśli odbiorcą jest firma. Argument opcjonalny (domyślna wartość `Builder::TYPE_PERSON`). - `$strict_mode` (`bool`): kontroluje try `strict_mode` (patrz `strict_mode()`). Domyślnie `false`. Ustawianie parametrów dot. płatności ------------------------------------ [](#ustawianie-parametrów-dot-płatności) Metody oznaczone **(wymagane)** dotyczą ustawiania wymaganych parametrów płatności i muszą zostać wywołane przed wywołaniem `build()`. Wszystkie metody zwracają `$this`, co pozwala łączyć ich wywołania łańcuchowo. - `public function vatId($vat_id)`: numer podatkowy (NIP) odbiorcy płatności. Podanie NIP-u jest wymagane dla odbiorcy korporacyjnego (`TYPE_COMPANY`). dla odbiorców będących osobami fizycznymi podanie NIP nie jest wymagane. - `$vat_id` (`string`|`int`|`null`): numer podatkowy odbiorcy (8 cyfr). Podanie `null` kasuje wprowadzoną wcześniej wartość. - `public function bankAccount($account)` **(wymagane)**: docelowy numer rachunku bankowego odbiorcy płatności. - `$account` (`string`) - numer rachunku bankowego (26 cyfr). Dozwolone jest także używanie znaków spacji oddzielających poszczególne cyfry numer lub ich grupy (zostaną one usunięte). - `public function name($name)` **(wymagane)**: nazwa odbiorcy płatności. - `$name` (`string`): maksymalna długość to 20 znaków. Widące i zamykające spacje są automatycznie usuwane (`trim()`). Jeśli wynikowy ciąg jest dłuższy niż dozwolony, zostanie automatycznie skrócony o ile tryb `strict_mode` nie jest aktywny, w przeciwnym razie wystąpi `InvalidArgumentException`. - `public function country($code)`: dwuliterowy kod kraju odbiorcy płatności. - `$code` (`string`|`null`): dwuliterowy kod kraju odbiorcy płatności (np. `PL`). Podanie `null` kasuje wprowadzoną wcześniej wartość. - `public function title($title)` **(wymagane)**: tytuł/opis płatności. - `$title` (`string`): maksymalna długość to 32 znaki. Wiodące i zamykające spacje są automatycznie usuwane. Jeśli wynikowy ciąg jest dłuższy niż dozwolony, zostanie automatycznie skrócony o ile tryb `strict_mode` nie jest aktywny, w przeciwnym razie wystąpi `InvalidArgumentException`. - `public function amount($amount)` **(wymagana)**: kwota płatności wyrażona w groszach (np `1000` to `10,00 PLN`) - `$amount` (`int`|`float`): jeśli podana wartość jest typu `int`, uznana jest za wartość wyrażoną w groszach. Gdy podana wartość jest typu `float`, zostanie uznana za wyrażoną w złotych (grosze w części ułamkowej). Przykładowo: `(int) 1012` oraz `float 10.12`są tożsame. Minimalna dozwolona wartość to `0` która oznacza, iż kwota przelewu musi zostać wprowadzona przez użytkownika w aplikacji bankowej po zeskanowaniu kodu QR. `9999999999` dla kwoty podanej jako `int` oraz `99999999.99` dla typu `float`. Podanie wartości ujemnej lub przekraczającej maksymalną dozwoloną wartość skutkuje wyjątkiem `OutOfRangeException`. - `public function reserved1($id)` lub `public function refId($id)`: zarezerwowane opcjonalne pole, przeznaczone np. na numer referencyjny płatności etc. - `$id` (`string`): ciąg o długości do 20 znaków. Podanie dłuższego ciągu zawsze skutkuje wyjątkiem `InvalidArgumentException`. - `public function reserved2($id)`: zarezerwowane opcjonalne pole, przeznaczone pierwotnie np. na numer referencyjny usługi Invobill (aka Invoobil, Qlips, QUIK etc). - `$id` (`string`): ciąg o długości do 12 znaków. Podanie dłuższego ciągu zawsze skutkuje wyjątkiem `InvalidArgumentException`. - `public function reserved3($id)`: zarezerwowane opcjonalne pole - `$id` (`string`): ciąg o długości do 24 znaków. Podanie dłuższego ciągu zawsze skutkuje wyjątkiem `InvalidArgumentException`. Wygenerowanie sformatowanego ciągu ---------------------------------- [](#wygenerowanie-sformatowanego-ciągu) - `public function build()`: generuje sformatowany ciąg znaków odpowiadający ustawionym parametrom płatności. Zwracana wartość jest typu `string` i nie przekracza `160` znaków. Metody dodatkowe ---------------- [](#metody-dodatkowe) - `public function strictMode($mode)`: kontroluje działanie trybu `strict_mode`. Metody, które automatycznie akceptują i skracają argumenty typu (`string`) przekraczające maksymalną dozwoloną długość (np. `title()`), działając w trybie `strict_mode` będą zamiast przycinać, przerywały rzucając `InvalidArgumentException`. Licencja ======== [](#licencja) - Written and copyrighted ©2020-2024 by Marcin Orlowski <mail (#) marcinorlowski (.) com> - Bank-Qrcode-Formatter is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) ### Health Score 32 — LowBetter than 72% of packages Maintenance27 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community7 Small or concentrated contributor base Maturity54 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~296 days Recently: every ~371 days Total 6 Last Release 575d ago PHP version history (3 changes)1.0.0PHP >=5.3.0 1.2.0PHP >=5.4.0 1.3.0PHP >=5.6.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/8870db56c4a0f54e86e6d574b761bac8654795bdad7b52b3ccdb6a42f0d4af80?d=identicon)[MarcinOrlowski](/maintainers/MarcinOrlowski) --- Top Contributors [![MarcinOrlowski](https://avatars.githubusercontent.com/u/8041294?v=4)](https://github.com/MarcinOrlowski "MarcinOrlowski (72 commits)") --- Tags phpformatterqrcodehelperbuilderBankmbankbank transferinteligo ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/marcin-orlowski-bank-qrcode-formatter/health.svg) ``` [![Health](https://phpackages.com/badges/marcin-orlowski-bank-qrcode-formatter/health.svg)](https://phpackages.com/packages/marcin-orlowski-bank-qrcode-formatter) ``` ### Alternatives [zjkal/time-helper 一个简单快捷的PHP日期时间助手类库。 a smart PHP datetime helper library. 21128.6k1](/packages/zjkal-time-helper) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)