Unable to add logo space with PDF output

[reconstrukt]

Hi,

I'm attempting to generate a QR Code with addLogoSpace option set to true , output to a PDF ('outputType' => QRCode::OUTPUT_FPDF,. But, receiving an error, details below.

Full code sample is below, w/ configuration options. Pls note I am not placing a logo in this example, just attempting to add space for it in the matrix.

I am using php v7.4.25 with the "chillerlan/php-qrcode": "dev-main" version in my composer.json.

Thank you!
Matt

$dark = [255, 255, 255];      // white code 
$trans = [238, 35, 36];       // red background

$options = new QROptions([
    'version'      => 5,        
    'outputType'   => QRCode::OUTPUT_FPDF,
    'eccLevel'     => EccLevel::H,
    'addLogoSpace'    => true,
    'logoSpaceWidth'  => 13,
    'logoSpaceHeight' => 13,
    'scale'        => 5,
    'imageBase64'  => false,
    'maskPattern' => 4,
    'moduleValues' => [
        // finder
        QRMatrix::M_FINDER | QRMatrix::IS_DARK     => $dark, // dark (true)
        QRMatrix::M_FINDER_DOT | QRMatrix::IS_DARK => $dark, // finder dot, dark (true)
        QRMatrix::M_FINDER                         => $trans, // light (false), white is the transparency color by default            
        // alignment
        QRMatrix::M_ALIGNMENT | QRMatrix::IS_DARK  => $dark,
        QRMatrix::M_ALIGNMENT                      => $trans,
        // timing
        QRMatrix::M_TIMING | QRMatrix::IS_DARK     => $dark,
        QRMatrix::M_TIMING                         => $trans,
        // format
        QRMatrix::M_FORMAT | QRMatrix::IS_DARK     => $dark,
        QRMatrix::M_FORMAT                         => $trans,
        // version
        QRMatrix::M_VERSION | QRMatrix::IS_DARK    => $dark,
        QRMatrix::M_VERSION                        => $trans,
        // data
        QRMatrix::M_DATA | QRMatrix::IS_DARK       => $dark,
        QRMatrix::M_DATA                           => $trans,
        // darkmodule
        QRMatrix::M_DARKMODULE | QRMatrix::IS_DARK => $dark,
        // separator
        QRMatrix::M_SEPARATOR                      => $trans,
        // quietzone
        QRMatrix::M_QUIETZONE                      => $trans,
    ],
    
]);

try{
  $qr = (new QRCode($options));
} catch(\Throwable $e){
  exit($e->getMessage());
}

$filename = uniqid() . '.pdf';
$filepath = config('filesystems.disks.temp.root') . '/' . $filename;    

$data = 'https://github.com/chillerlan/php-qrcode';

$qr->render($data, $filepath);

echo $filepath;

And i'm receiving the following error:

   chillerlan\QRCode\Data\QRCodeDataException

  code length overflow. (548 > 368 bit)

  at vendor/chillerlan/php-qrcode/src/Data/QRData.php:173
    169▕                }
    170▕
    171▕                // overflow, likely caused due to invalid version setting
    172▕                if($this->bitBuffer->getLength() > $MAX_BITS){
  ➜ 173▕                        throw new QRCodeDataException(
    174▕                                sprintf('code length overflow. (%d > %d bit)', $this->bitBuffer->getLength(), $MAX_BITS)
    175▕                        );
    176▕                }
    177▕

      +5 vendor frames
  6   app/Library/LabelRenderer.php:175
      chillerlan\QRCode\QRCode::render()

[codemasher]

The error means that the string you try to encode does not fit into the QR Code. Try increasing the version number or set it to Version::AUTO.

[reconstrukt]

Roger! I'll try that now

[reconstrukt]

hmm @codemasher i'm not seeing a public AUTO const on chillerlan\QRCode\Common\Version .
...
tried blindly setting version to 10, that worked!

is there any docs on what the versions mean, and how to determine the "best" version to used based on the length of the string being passed into the qr code? (fwiw, we're just embedding dynamic URLs, approx ~70 characters or so, nothing crazy).

also, is there a way to set the color of the logo space?
see screenshot below, its a white square by default

thank you,
matt

[codemasher]

i'm not seeing a public AUTO const on chillerlan\QRCode\Common\Version .

Uhh, it should be. But you can also just omit the version setting, as auto detection is enabled by default.

edit:

is there any docs on what the versions mean, and how to determine the "best" version to used based on the length of the string being passed into the qr code?

There's nothing else to do on your end - the auto setting does that all for you - even for mixed mode QR Codes.
Version (and general QR Code info is here: https://www.qrcode.com/en/about/version.html )

also, is there a way to set the color of the logo space?

I've added a "background" option recently but it's inconsitent across the several output modules for various reasons. Since you're using FPDF, you may consider their documentation (you can return the FPDF instance by setting QROptions::returnResource to true).

[codemasher]

Ok, i've added support for the bgColor and drawLightModules options in 00f47b4 so you can omit the module values for the light pixels.

[reconstrukt]

Thanks @codemasher for all your help! Will look into manually setting the background color on this end

[codemasher]

Um hey, wait a second - have you tried to set the quiet zone to dark? I just noticed in your code snippet above it is set to transparent. This should do the trick as the output module doesn't care for the given values.

Edit: oh nevermind - this is the orange color :)

[codemasher]

Excuse me, my brain is not working at full capacity right now... so the setting for the logo space would be QRMatrix::M_LOGO, which you would need to add to the module settings.

Also, I'll look into the FPDF output module and see if i can get the background setting working.

[reconstrukt]

@codemasher lol, no problem
just so i'm tracking, what should i try doing with QRMatrix::M_LOGO, ?

[codemasher]

In your OP you see the array where you define the colors for the several matrix parts, just add a line there:

        QRMatrix::M_LOGO => $trans,

[reconstrukt]

ah got it, copy that; will try now

[reconstrukt]

boom! worked like a champ

[codemasher]

The TCPDF example i linked above shows SVG import. Either way, it's all just a suggestion - do whatever works best for you. :)

[reconstrukt]

copy, taking a look at that snip (circa 2013 lol)

[codemasher]

I agreee, TCPDF is a moloch and i wouldn't poke it with a stick... :D

[reconstrukt]

ok, so we ended up managing the logo assets as PDFs; and adding the logo to the center of the QR code (as another layer on the PDF) at render-time. just another step in tag creation. works great, little annoying to manage all the separate logo assets (diff colors), but lot better than bringing in TCPDF. :)

thanks for your help with all the options above! cheers

[codemasher]

Sounds great! Cheers!