PHP download

Download the PHP package marcin-orlowski/bank-qrcode-formatter without Composer

On this page you can find all versions of the php package marcin-orlowski/bank-qrcode-formatter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download marcin-orlowski/bank-qrcode-formatter
More information about marcin-orlowski/bank-qrcode-formatter
Files in marcin-orlowski/bank-qrcode-formatter

Vendor marcin-orlowski
Package bank-qrcode-formatter
Short Description Builds source string that can be used to generate valid QrCode matching recommendation of Polish banks
License MIT
Homepage https://github.com/MarcinOrlowski/bank-qrcode-formatter

Keywords php formatter builder helper qrcode Bank mbank bank transfer inteligo

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

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.

Please rate this library. Is it a good library?

Example code of marcin-orlowski/bank-qrcode-formatter

Informations about the package bank-qrcode-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. Otrzymany ciąg znaków należy użyć do wygenerowania kodu QR, używając do tego dowolnej biblioteki do tego przeznaczonej.

Wymagania

PHP v5.6+
Rozszerzenie mbstring

Instalacja

Przykład użycia

Zwrócony ciąg znaków ($str) należy następnie użyć z dowolną biblioteką do generowania kodów QR:

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

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

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

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

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

Bank-Qrcode-Formatter is open-sourced software licensed under the MIT license

All versions of bank-qrcode-formatter with dependencies

PHP Build Version

Package Version

Version 1.5.0 Release 15. Oct 2024
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of bank-qrcode-formatter from vendor marcin-orlowski

Requires php Version >=5.6.0
ext-mbstring Version *

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package marcin-orlowski/bank-qrcode-formatter contains the following files

Loading the files please wait ....