Bacon Qr Code Laravel Package

Getting Started

Minimal Setup

Install via Composer:

composer require bacon/bacon-qr-code

First Use Case: Basic QR Code Generation

use BaconQrCode\Writer;

$writer = new Writer();
$writer->writeFile('https://example.com', 'qr-code.png');

• Key Classes:
  • Writer: Core class for generating QR codes
  • Renderer: Handles output format (default: PNG via Imagick)
  • RendererStyle: Controls visual appearance (size, colors, etc.)

Where to Look First

1. Documentation: GitHub README (covers all backends)
2. Examples: tests/ directory for advanced use cases
3. Renderer Options: RendererStyle class for customization

Implementation Patterns

Core Workflow

1. Instantiate Renderer (choose backend):

   // Imagick (default, high quality)
   $renderer = new ImageRenderer(
       new RendererStyle(400),
       new ImagickImageBackEnd()
   );
   
   // SVG (vector, no artifacts)
   $renderer = new ImageRenderer(
       new RendererStyle(400),
       new SvgImageBackEnd()
   );
   
   // GD (lightweight, limited features)
   $renderer = new GDLibRenderer(400);
   

2. Create Writer:

   $writer = new Writer($renderer);
   

3. Generate QR Code:

   // To file
   $writer->writeFile('data', 'output.png');
   
   // To string (e.g., for responses)
   $qrCode = $writer->writeString('data');
   

Common Patterns

Dynamic QR Codes in Controllers

use BaconQrCode\Writer;
use BaconQrCode\Renderer\ImageRenderer;
use BaconQrCode\Renderer\RendererStyle;
use BaconQrCode\Renderer\Image\SvgImageBackEnd;

public function generateQr(Request $request)
{
    $renderer = new ImageRenderer(
        new RendererStyle(300),
        new SvgImageBackEnd()
    );
    $writer = new Writer($renderer);

    return response($writer->writeString($request->input('data')), 200, [
        'Content-Type' => 'image/svg+xml',
    ]);
}

Custom Styling

$style = new RendererStyle(500);
$style->setForegroundColor(new \BaconQrCode\Color\Rgb(0, 102, 204)); // Blue
$style->setBackgroundColor(new \BaconQrCode\Color\Rgb(255, 255, 255)); // White
$style->setMargin(10);

$renderer = new ImageRenderer($style, new ImagickImageBackEnd());

Error Correction Levels

$writer->getRenderer()->getStyle()->setErrorCorrectionLevel(
    \BaconQrCode\Writer\ErrorCorrectionLevel::HIGH
);

Batch Generation

$urls = ['url1', 'url2', 'url3'];
foreach ($urls as $index => $url) {
    $writer->writeFile($url, "qr_{$index}.png");
}

Integration Tips

• Laravel Storage: Use Storage::put() to save QR codes to disk:

  Storage::put('public/qr-codes/' . $filename, $qrCode);
  

• Queue Jobs: Offload generation for large batches:

  GenerateQrJob::dispatch($data, $filename)->onQueue('qr-codes');
  

• Caching: Cache generated QR codes if data doesn’t change often:

  $cacheKey = 'qr_' . md5($data);
  $qrCode = Cache::remember($cacheKey, now()->addHours(1), function() use ($data) {
      return $writer->writeString($data);
  });
  

Gotchas and Tips

Pitfalls

1. Imagick Artifacts:

   • Use SvgImageBackEnd or GDLibRenderer if you encounter white pixel artifacts (common with ImagickImageBackEnd).
   • Example:

     $renderer = new ImageRenderer(new RendererStyle(400), new SvgImageBackEnd());
     

2. GD Limitations:

   • GD renderer lacks gradients and curves (always square QR codes).
   • Avoid for high-quality or complex designs.

3. Memory Usage:

   • Large QR codes (e.g., >1000px) may consume significant memory with Imagick.
   • Use SVG for scalable vector output.

4. PHP Extensions:

   • Imagick: Requires php-imagick (pecl install imagick).
   • SVG: Requires xmlwriter extension.
   • GD: Built into PHP (php-gd).

5. Encoding Issues:

   • Non-ASCII text (e.g., emojis, CJK) may require explicit encoding:

     $writer->writeFile(mb_convert_encoding($data, 'UTF-8'), 'output.png');
     

Debugging Tips

• Validate Data: Ensure input data is <3276 bytes (max QR code capacity).
• Check Logs: Enable BaconQrCode\Writer logging for encoding errors:

  \Log::debug('QR Data:', ['data' => $data]);
  

• Test Backends: Verify output across backends if artifacts appear:

  // Test Imagick
  $imagickRenderer = new ImageRenderer(new RendererStyle(400), new ImagickImageBackEnd());
  $imagickWriter = new Writer($imagickRenderer);
  $imagickWriter->writeFile($data, 'test_imagick.png');
  
  // Test SVG
  $svgRenderer = new ImageRenderer(new RendererStyle(400), new SvgImageBackEnd());
  $svgWriter = new Writer($svgRenderer);
  $svgWriter->writeFile($data, 'test_svg.svg');
  

Extension Points

1. Custom Renderers: Extend \BaconQrCode\Renderer\ImageRenderer or \BaconQrCode\Renderer\RendererStyle for custom logic. Example:

   class CustomRenderer extends ImageRenderer {
       public function __construct() {
           parent::__construct(
               new RendererStyle(400),
               new CustomImageBackEnd()
           );
       }
   }
   

2. Eye Patterns: Override default eye shapes (finder patterns) by extending \BaconQrCode\Renderer\Eye\Eye:

   class CustomEye extends SimpleCircleEye {
       protected function drawEye(): void {
           // Custom drawing logic
       }
   }
   

3. Color Management: Extend \BaconQrCode\Color\Color for custom color spaces or conversions.

Configuration Quirks

• Default Size: QR codes default to 256px. Adjust via RendererStyle:

  $style = new RendererStyle(500); // 500px
  

• Margin: Default margin is 4. Reduce for compact QR codes:

  $style->setMargin(1);
  

• Error Correction: Default is LOW. Use HIGH for noisy environments:

  $style->setErrorCorrectionLevel(\BaconQrCode\Writer\ErrorCorrectionLevel::HIGH);
  

Performance Tips

• Reuse Writers: Instantiate Writer once and reuse for multiple generations:

  $writer = new Writer(); // Reuse across requests
  

• SVG for Static Content: SVG renders are faster for static QR codes (no Imagick overhead).
• Batch Processing: Use Laravel queues for large batches to avoid timeouts.