PHP-QRCode Manual

User manual for chillerlan/php-qrcode [main]. Updated on Apr 19, 2024.

The phpDocumentor API documentation can be found at chillerlan.github.io/php-qrcode.

This work is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License.

Usage

• Overview
  • Features
  • Requirements
  • Framework Integration
  • Shameless advertising
• Installation
  • Installation with Composer
    • composer.json
    • Terminal
  • Manual installation
    • Can i use this library without using composer?
  • Supported PHP versions & extension requirements
  • ImageMagick
• Quickstart
  • Import the library
  • Create your first QR Code
    • Configuration
  • Reading QR Codes
  • Notes
• Advanced usage
  • Configuration via QROptions
    • Supply an iterable of options
    • Load and save options from/to JSON
    • Extending the QROptions class
  • QRCode methods
    • Render a QRMatrix instance
    • Mixed mode
    • QR Code reader
  • Common output options
    • Save to file
    • Base64 URI output
    • Return the image resource
    • Add a logo space
• Configuration settings
  • version
  • versionMin
  • versionMax
  • eccLevel
  • maskPattern
  • addQuietzone
  • quietzoneSize
  • outputInterface
  • returnResource
  • cachefile
  • outputBase64
  • eol
  • bgColor
  • invertMatrix
  • drawLightModules
  • drawCircularModules
  • circleRadius
  • keepAsSquare
  • connectPaths
  • excludeFromConnect
  • moduleValues
  • addLogoSpace
  • logoSpaceWidth
  • logoSpaceHeight
  • logoSpaceStartX
  • logoSpaceStartY
  • scale
  • imageTransparent
  • transparencyColor
  • quality
  • gdImageUseUpscale
  • imagickFormat
  • cssClass
  • svgAddXmlHeader
  • svgDefs
  • svgPreserveAspectRatio
  • svgUseFillAttributes
  • textLineStart
  • jsonFlags
  • jsonAsBooleans
  • fpdfMeasureUnit
  • readerUseImagickIfAvailable
  • readerGrayscale
  • readerInvertColors
  • readerIncreaseContrast

Customizing output

• Module values
  • Basics
  • Assigning values
  • Handling in your own QROutputInterface
    • Setting module values
    • Using the module values
• QROutputAbstract
  • Properties
    • $options and $matrix
    • $moduleCount, $scale and $length
    • $moduleValues
    • Copies of QROptions values
  • Methods
    • setModuleValues()
    • moduleValueIsValid()
    • prepareModuleValue()
    • getDefaultModuleValue()
    • getModuleValue() and getModuleValueAt()
    • setMatrixDimensions()
    • getOutputDimensions()
    • collectModules()
    • saveToFile() and toBase64DataURI()
• Custom QROutputInterface
  • Class skeleton
  • Module values
  • Transform the output
  • Run the custom output
  • Summary

Built-In Output Modules

• QREps
  • Example
  • Additional methods
  • Options that affect this module
    • Options that have no effect
• QRFpdf
  • Example
  • Additional methods
  • Options that affect this module
    • Options that have no effect
• QRGdImage
  • Example
  • Additional methods
  • Options that affect this module
    • Options that have no effect
• QRImagick
  • Example
  • Additional methods
  • Options that affect this module
    • Options that have no effect
• QRMarkupHTML
  • Example
  • Additional methods
  • Options that affect this module
    • Options that have no effect
• QRMarkupSVG
  • Example
  • Additional methods
  • Options that affect this module
    • Options that have no effect
• QRString
  • Plain text
  • JSON
  • Additional methods
  • Options that affect this module
    • Options that have no effect

Appendix

• Terminology
  • QR Code
  • Matrix
    • Module
    • Version
  • Function Patterns
    • Finder Pattern
    • Alignment Pattern
    • Timing Pattern
    • Separators
    • Quiet Zone
  • Encoding Region
    • Data
    • Version Information
    • Format Information
    • Darkmodule
  • Mode
    • Segment
    • Extended Channel Interpretation (ECI)
    • Mixed Mode
  • ECC (Error Correction Coding)
    • ECC Level
    • Maximum data capacity
  • Data masking
    • Evaluation
    • Mask pattern
  • Reflectance
• Popular content and URI schemes
  • URL https
  • E-Mail mailto
  • Phone numbers tel
  • Geo Coordinates geo
  • Mobile Authenticators otpauth
  • Wireless Network configuration
  • Contact information: vCard
  • Calendar Events: vCalendar and iCalendar
  • SEPA Credit Transfer
  • See also
• Performance considerations
  • Version
  • Ecc level
  • Data mode
  • Mask pattern
  • Output
• How to contribute
  • Questions and issues
  • Bug reports
  • Pull requests and bug fixes
  • Documentation
• License