README.md

Messer Pix

This is a library developed by Gustavo Ramad Messer for Symfony with the goal of generating random Pix keys in image and text formats (Pix copy and paste), using the open source gerarqrcodepix API.

Installation

Use the composer to install:

composer require messer/pix

Usage

Using Messer Pix to get a pix string key.

use Messer\Pix\Pix;

$pix = new Pix();

$data = [
    'name' => 'Gustavo Ramad Messer',
    'city' => 'Santos',
    'key' => 'gustavoramadmesser',
    'value' => '77.77',
    'description' => 'Pix String Test',
    'output' => 'string', // optional (default: string)
    'destiny' => '', // optional (public path)
];

$pixResponse = $pix->generate($data);

Using Messer Pix to get a pix qr code image.

use Messer\Pix\Pix;

$pix = new Pix();

$data = [
    'name' => 'Gustavo Ramad Messer', // required
    'city' => 'Santos', // required
    'key' => 'gustavoramadmesser', // required
    'value' => '77.77', // optional
    'description' => 'Pix Image Test', // optional
    'output' => 'image', // optional (default: string)
    'destiny' => '', // optional (public path)
];

$pixResponse = $pix->generate($data);

License

MIT

Copyright © 2023 Gustavo Ramad Messer