# woocommerce-pos/1.10.20/vendor_prefixed/chillerlan/php-qrcode/src/QROptionsTrait.php

WCPOS – Point of Sale (POS) plugin for WooCommerce, version 1.10.20. 657 lines.

- Page: https://pluginprobe.com/plugins/woocommerce-pos/1.10.20/code/vendor_prefixed/chillerlan/php-qrcode/src/QROptionsTrait.php
- Raw: https://pluginprobe.com/plugins/woocommerce-pos/1.10.20/raw/vendor_prefixed/chillerlan/php-qrcode/src/QROptionsTrait.php
- Modified: 2026-06-09T13:55:26+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/woocommerce-pos/1.10.20/code/vendor_prefixed/chillerlan/php-qrcode/src/QROptionsTrait.php#L10-L20`.

```php
<?php

/**
 * Trait QROptionsTrait
 *
 * Note: the docblocks in this file are optimized for readability in PhpStorm ond on readthedocs.io
 *
 * @created      10.03.2018
 * @author       smiley <smiley@chillerlan.net>
 * @copyright    2018 smiley
 * @license      MIT
 *
 * @noinspection PhpUnused, PhpComposerExtensionStubsInspection
 */
namespace WCPOS\Vendor\chillerlan\QRCode;

use WCPOS\Vendor\chillerlan\QRCode\Output\QROutputInterface;
use WCPOS\Vendor\chillerlan\QRCode\Common\EccLevel;
use WCPOS\Vendor\chillerlan\QRCode\Common\MaskPattern;
use WCPOS\Vendor\chillerlan\QRCode\Common\Version;
use function extension_loaded, in_array, max, min, strtolower;
use const JSON_THROW_ON_ERROR, PHP_EOL;
/**
 * The QRCode plug-in settings & setter functionality
 */
trait QROptionsTrait
{
    /*
     * QR Code specific settings
     */
    /**
     * QR Code version number
     *
     * `1 ... 40` or `Version::AUTO` (default)
     *
     * @see \chillerlan\QRCode\Common\Version
     */
    protected int $version = Version::AUTO;
    /**
     * Minimum QR version
     *
     * if `QROptions::$version` is set to `Version::AUTO` (default: 1)
     */
    protected int $versionMin = 1;
    /**
     * Maximum QR version
     *
     * if `QROptions::$version` is set to `Version::AUTO` (default: 40)
     */
    protected int $versionMax = 40;
    /**
     * Error correct level
     *
     * `EccLevel::X` where `X` is:
     *
     * - `L` =>  7% (default)
     * - `M` => 15%
     * - `Q` => 25%
     * - `H` => 30%
     *
     * @todo: accept string values (PHP8+)
     * @see \chillerlan\QRCode\Common\EccLevel
     * @see https://github.com/chillerlan/php-qrcode/discussions/160
     */
    protected int $eccLevel = EccLevel::L;
    /**
     * Mask Pattern to use (no value in using, mostly for unit testing purposes)
     *
     * `0 ... 7` or `MaskPattern::PATTERN_AUTO` (default)
     *
     * @see \chillerlan\QRCode\Common\MaskPattern
     */
    protected int $maskPattern = MaskPattern::AUTO;
    /**
     * Add a "quiet zone" (margin) according to the QR code spec
     *
     * @see https://www.qrcode.com/en/howto/code.html
     */
    protected bool $addQuietzone = \true;
    /**
     * Size of the quiet zone
     *
     * internally clamped to `0 ... $moduleCount / 2` (default: 4)
     */
    protected int $quietzoneSize = 4;
    /*
     * General output settings
     */
    /**
     * The built-in output type
     *
     * - `QROutputInterface::MARKUP_SVG` (default)
     * - `QROutputInterface::MARKUP_HTML`
     * - `QROutputInterface::GDIMAGE_BMP`
     * - `QROutputInterface::GDIMAGE_GIF`
     * - `QROutputInterface::GDIMAGE_JPG`
     * - `QROutputInterface::GDIMAGE_PNG`
     * - `QROutputInterface::GDIMAGE_WEBP`
     * - `QROutputInterface::STRING_TEXT`
     * - `QROutputInterface::STRING_JSON`
     * - `QROutputInterface::IMAGICK`
     * - `QROutputInterface::EPS`
     * - `QROutputInterface::FPDF`
     * - `QROutputInterface::CUSTOM`
     *
     * @see \chillerlan\QRCode\Output\QREps
     * @see \chillerlan\QRCode\Output\QRFpdf
     * @see \chillerlan\QRCode\Output\QRGdImage
     * @see \chillerlan\QRCode\Output\QRImagick
     * @see \chillerlan\QRCode\Output\QRMarkupHTML
     * @see \chillerlan\QRCode\Output\QRMarkupSVG
     * @see \chillerlan\QRCode\Output\QRString
     * @see https://github.com/chillerlan/php-qrcode/issues/223
     *
     * @deprecated 5.0.0 see issue #223
     */
    protected string $outputType = QROutputInterface::MARKUP_SVG;
    /**
     * The FQCN of the custom `QROutputInterface`
     *
     * if `QROptions::$outputType` is set to `QROutputInterface::CUSTOM` (default: `null`)
     *
     * @deprecated 5.0.0 the nullable type will be removed in future versions
     *                   and the default value will be set to `QRMarkupSVG::class`
     */
    protected ?string $outputInterface = null;
    /**
     * Return the image resource instead of a render if applicable.
     *
     * - `QRGdImage`: `resource` (PHP < 8), `GdImage`
     * - `QRImagick`: `Imagick`
     * - `QRFpdf`:    `FPDF`
     *
     * This option overrides/ignores other output settings, such as `QROptions::$cachefile`
     * and `QROptions::$outputBase64`. (default: `false`)
     *
     * @see \chillerlan\QRCode\Output\QROutputInterface::dump()
     */
    protected bool $returnResource = \false;
    /**
     * Optional cache file path `/path/to/cache.file`
     *
     * Please note that the `$file` parameter in `QRCode::render()` and `QRCode::renderMatrix()`
     * takes precedence over the `QROptions::$cachefile` value. (default: `null`)
     *
     * @see \chillerlan\QRCode\QRCode::render()
     * @see \chillerlan\QRCode\QRCode::renderMatrix()
     */
    protected ?string $cachefile = null;
    /**
     * Toggle base64 data URI or raw data output (if applicable)
     *
     * (default: `true`)
     *
     * @see \chillerlan\QRCode\Output\QROutputAbstract::toBase64DataURI()
     */
    protected bool $outputBase64 = \true;
    /**
     * Newline string
     *
     * (default: `PHP_EOL`)
     */
    protected string $eol = PHP_EOL;
    /*
     * Common visual modifications
     */
    /**
     * Sets the image background color (if applicable)
     *
     * - `QRImagick`: defaults to `"white"`
     * - `QRGdImage`: defaults to `[255, 255, 255]`
     * - `QRFpdf`: defaults to blank internally (white page)
     *
     * @var mixed|null
     */
    protected $bgColor = null;
    /**
     * Whether to invert the matrix (reflectance reversal)
     *
     * (default: `false`)
     *
     * @see \chillerlan\QRCode\Data\QRMatrix::invert()
     */
    protected bool $invertMatrix = \false;
    /**
     * Whether to draw the light (false) modules
     *
     * (default: `true`)
     */
    protected bool $drawLightModules = \true;
    /**
     * Specify whether to draw the modules as filled circles
     *
     * a note for `GdImage` output:
     *
     * if `QROptions::$scale` is less than 20, the image will be upscaled internally, then the modules will be drawn
     * using `imagefilledellipse()` and then scaled back to the expected size
     *
     * No effect in: `QREps`, `QRFpdf`, `QRMarkupHTML`
     *
     * @see \imagefilledellipse()
     * @see https://github.com/chillerlan/php-qrcode/issues/23
     * @see https://github.com/chillerlan/php-qrcode/discussions/122
     */
    protected bool $drawCircularModules = \false;
    /**
     * Specifies the radius of the modules when `QROptions::$drawCircularModules` is set to `true`
     *
     * (default: 0.45)
     */
    protected float $circleRadius = 0.45;
    /**
     * Specifies which module types to exclude when `QROptions::$drawCircularModules` is set to `true`
     *
     * (default: `[]`)
     */
    protected array $keepAsSquare = [];
    /**
     * Whether to connect the paths for the several module types to avoid weird glitches when using gradients etc.
     *
     * This option is exclusive to output classes that use the module collector `QROutputAbstract::collectModules()`,
     * which converts the `$M_TYPE` of all modules to `QRMatrix::M_DATA` and `QRMatrix::M_DATA_DARK` respectively.
     *
     * Module types that should not be added to the connected path can be excluded via `QROptions::$excludeFromConnect`.
     *
     * Currentty used in `QREps` and `QRMarkupSVG`.
     *
     * @see \chillerlan\QRCode\Output\QROutputAbstract::collectModules()
     * @see \chillerlan\QRCode\QROptionsTrait::$excludeFromConnect
     * @see https://github.com/chillerlan/php-qrcode/issues/57
     */
    protected bool $connectPaths = \false;
    /**
     * Specify which paths/patterns to exclude from connecting if `QROptions::$connectPaths` is set to `true`
     *
     * @see \chillerlan\QRCode\QROptionsTrait::$connectPaths
     */
    protected array $excludeFromConnect = [];
    /**
     * Module values map
     *
     * - `QRImagick`, `QRMarkupHTML`, `QRMarkupSVG`: #ABCDEF, cssname, rgb(), rgba()...
     * - `QREps`, `QRFpdf`, `QRGdImage`: `[R, G, B]` // 0-255
     * - `QREps`: `[C, M, Y, K]` // 0-255
     *
     * @see \chillerlan\QRCode\Output\QROutputAbstract::setModuleValues()
     */
    protected array $moduleValues = [];
    /**
     * Toggles logo space creation
     *
     * @see \chillerlan\QRCode\QRCode::addMatrixModifications()
     * @see \chillerlan\QRCode\Data\QRMatrix::setLogoSpace()
     */
    protected bool $addLogoSpace = \false;
    /**
     * Width of the logo space
     *
     * if only `QROptions::$logoSpaceWidth` is given, the logo space is assumed a square of that size
     */
    protected ?int $logoSpaceWidth = null;
    /**
     * Height of the logo space
     *
     * if only `QROptions::$logoSpaceHeight` is given, the logo space is assumed a square of that size
     */
    protected ?int $logoSpaceHeight = null;
    /**
     * Optional horizontal start position of the logo space (top left corner)
     */
    protected ?int $logoSpaceStartX = null;
    /**
     * Optional vertical start position of the logo space (top left corner)
     */
    protected ?int $logoSpaceStartY = null;
    /*
     * Common raster image settings (QRGdImage, QRImagick)
     */
    /**
     * Pixel size of a QR code module
     */
    protected int $scale = 5;
    /**
     * Toggle transparency
     *
     * - `QRGdImage` and `QRImagick`: the given `QROptions::$transparencyColor` is set as transparent
     *
     * @see https://github.com/chillerlan/php-qrcode/discussions/121
     */
    protected bool $imageTransparent = \false;
    /**
     * Sets a transparency color for when `QROptions::$imageTransparent` is set to `true`.
     *
     * Defaults to `QROptions::$bgColor`.
     *
     * - `QRGdImage`: `[R, G, B]`, this color is set as transparent in `imagecolortransparent()`
     * - `QRImagick`: `"color_str"`, this color is set in `Imagick::transparentPaintImage()`
     *
     * @see \imagecolortransparent()
     * @see \Imagick::transparentPaintImage()
     *
     * @var mixed|null
     */
    protected $transparencyColor = null;
    /**
     * Compression quality
     *
     * The given value depends on the used output type:
     *
     * - `QRGdImageBMP`:  `[0...1]`
     * - `QRGdImageJPEG`: `[0...100]`
     * - `QRGdImageWEBP`: `[0...9]`
     * - `QRGdImagePNG`:  `[0...100]`
     * - `QRImagick`:     `[0...100]`
     *
     * @see \imagebmp()
     * @see \imagejpeg()
     * @see \imagepng()
     * @see \imagewebp()
     * @see \Imagick::setImageCompressionQuality()
     */
    protected int $quality = -1;
    /*
     * QRGdImage settings
     */
    /**
     * Toggles the usage of internal upscaling when `QROptions::$drawCircularModules` is set to `true` and
     * `QROptions::$scale` is less than 20
     *
     * @see \chillerlan\QRCode\Output\QRGdImage::createImage()
     * @see https://github.com/chillerlan/php-qrcode/issues/23
     */
    protected bool $gdImageUseUpscale = \true;
    /*
     * QRImagick settings
     */
    /**
     * Imagick output format
     *
     * @see \Imagick::setImageFormat()
     * @see https://www.imagemagick.org/script/formats.php
     */
    protected string $imagickFormat = 'png32';
    /*
     * Common markup output settings (QRMarkupSVG, QRMarkupHTML)
     */
    /**
     * A common css class
     */
    protected string $cssClass = 'qrcode';
    /*
     * QRMarkupSVG settings
     */
    /**
     * Whether to add an XML header line or not, e.g. to embed the SVG directly in HTML
     *
     * `<?xml version="1.0" encoding="UTF-8"?>`
     */
    protected bool $svgAddXmlHeader = \true;
    /**
     * Anything in the SVG `<defs>` tag
     *
     * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs
     */
    protected string $svgDefs = '';
    /**
     * Sets the value for the "preserveAspectRatio" on the `<svg>` element
     *
     * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio
     */
    protected string $svgPreserveAspectRatio = 'xMidYMid';
    /**
     * Whether to use the SVG `fill` attributes
     *
     * If set to `true` (default), the `fill` attribute will be set with the module value for the `<path>` element's `$M_TYPE`.
     * When set to `false`, the module values map will be ignored and the QR Code may be styled via CSS.
     *
     * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill
     */
    protected bool $svgUseFillAttributes = \true;
    /*
     * QRStringText settings
     */
    /**
     * An optional line prefix, e.g. empty space to align the QR Code in a console
     */
    protected string $textLineStart = '';
    /*
     * QRStringJSON settings
     */
    /**
     * Sets the flags to use for the `json_encode()` call
     *
     * @see https://www.php.net/manual/json.constants.php
     */
    protected int $jsonFlags = JSON_THROW_ON_ERROR;
    /**
     * Whether to return matrix values in JSON as booleans or `$M_TYPE` integers
     */
    protected bool $jsonAsBooleans = \false;
    /*
     * QRFpdf settings
     */
    /**
     * Measurement unit for `FPDF` output: `pt`, `mm`, `cm`, `in` (default: `pt`)
     *
     * @see FPDF::__construct()
     */
    protected string $fpdfMeasureUnit = 'pt';
    /*
     * QR Code reader settings
     */
    /**
     * Use Imagick (if available) when reading QR Codes
     */
    protected bool $readerUseImagickIfAvailable = \false;
    /**
     * Grayscale the image before reading
     */
    protected bool $readerGrayscale = \false;
    /**
     * Invert the colors of the image
     */
    protected bool $readerInvertColors = \false;
    /**
     * Increase the contrast before reading
     *
     * note that applying contrast works different in GD and Imagick, so mileage may vary
     */
    protected bool $readerIncreaseContrast = \false;
    /**
     * clamp min/max version number
     */
    protected function setMinMaxVersion(int $versionMin, int $versionMax) : void
    {
        $min = max(1, min(40, $versionMin));
        $max = max(1, min(40, $versionMax));
        $this->versionMin = min($min, $max);
        $this->versionMax = max($min, $max);
    }
    /**
     * sets the minimum version number
     */
    protected function set_versionMin(int $version) : void
    {
        $this->setMinMaxVersion($version, $this->versionMax);
    }
    /**
     * sets the maximum version number
     */
    protected function set_versionMax(int $version) : void
    {
        $this->setMinMaxVersion($this->versionMin, $version);
    }
    /**
     * sets/clamps the version number
     */
    protected function set_version(int $version) : void
    {
        $this->version = $version !== Version::AUTO ? max(1, min(40, $version)) : Version::AUTO;
    }
    /**
     * sets/clamps the quiet zone size
     */
    protected function set_quietzoneSize(int $quietzoneSize) : void
    {
        $this->quietzoneSize = max(0, min($quietzoneSize, 75));
    }
    /**
     * sets the FPDF measurement unit
     *
     * @codeCoverageIgnore
     */
    protected function set_fpdfMeasureUnit(string $unit) : void
    {
        $unit = strtolower($unit);
        if (in_array($unit, ['cm', 'in', 'mm', 'pt'], \true)) {
            $this->fpdfMeasureUnit = $unit;
        }
        // @todo throw or ignore silently?
    }
    /**
     * enables Imagick for the QR Code reader if the extension is available
     */
    protected function set_readerUseImagickIfAvailable(bool $useImagickIfAvailable) : void
    {
        $this->readerUseImagickIfAvailable = $useImagickIfAvailable && extension_loaded('imagick');
    }
    /**
     * clamp the logo space values between 0 and maximum length (177 modules at version 40)
     */
    protected function clampLogoSpaceValue(?int $value) : ?int
    {
        if ($value === null) {
            return null;
        }
        return (int) max(0, min(177, $value));
    }
    /**
     * clamp/set logo space width
     */
    protected function set_logoSpaceWidth(?int $value) : void
    {
        $this->logoSpaceWidth = $this->clampLogoSpaceValue($value);
    }
    /**
     * clamp/set logo space height
     */
    protected function set_logoSpaceHeight(?int $value) : void
    {
        $this->logoSpaceHeight = $this->clampLogoSpaceValue($value);
    }
    /**
     * clamp/set horizontal logo space start
     */
    protected function set_logoSpaceStartX(?int $value) : void
    {
        $this->logoSpaceStartX = $this->clampLogoSpaceValue($value);
    }
    /**
     * clamp/set vertical logo space start
     */
    protected function set_logoSpaceStartY(?int $value) : void
    {
        $this->logoSpaceStartY = $this->clampLogoSpaceValue($value);
    }
    /**
     * clamp/set SVG circle radius
     */
    protected function set_circleRadius(float $circleRadius) : void
    {
        $this->circleRadius = max(0.1, min(0.75, $circleRadius));
    }
    /*
     * redirect calls of deprecated variables to new/renamed property
     */
    /**
     * @deprecated 5.0.0 use QROptions::$outputBase64 instead
     * @see        \chillerlan\QRCode\QROptions::$outputBase64
     */
    protected bool $imageBase64;
    /**
     * redirect call to the new variable
     *
     * @deprecated 5.0.0 use QROptions::$outputBase64 instead
     * @see        \chillerlan\QRCode\QROptions::$outputBase64
     * @codeCoverageIgnore
     */
    protected function set_imageBase64(bool $imageBase64) : void
    {
        $this->outputBase64 = $imageBase64;
    }
    /**
     * redirect call to the new variable
     *
     * @deprecated 5.0.0 use QROptions::$outputBase64 instead
     * @see        \chillerlan\QRCode\QROptions::$outputBase64
     * @codeCoverageIgnore
     */
    protected function get_imageBase64() : bool
    {
        return $this->outputBase64;
    }
    /**
     * @deprecated 5.0.0 use QROptions::$quality instead
     * @see        \chillerlan\QRCode\QROptions::$quality
     */
    protected int $jpegQuality;
    /**
     * @deprecated 5.0.0 use QROptions::$quality instead
     * @see        \chillerlan\QRCode\QROptions::$quality
     * @codeCoverageIgnore
     */
    protected function set_jpegQuality(int $jpegQuality) : void
    {
        $this->quality = $jpegQuality;
    }
    /**
     * @deprecated 5.0.0 use QROptions::$quality instead
     * @see        \chillerlan\QRCode\QROptions::$quality
     * @codeCoverageIgnore
     */
    protected function get_jpegQuality() : int
    {
        return $this->quality;
    }
    /**
     * @deprecated 5.0.0 use QROptions::$quality instead
     * @see        \chillerlan\QRCode\QROptions::$quality
     */
    protected int $pngCompression;
    /**
     * @deprecated 5.0.0 use QROptions::$quality instead
     * @see        \chillerlan\QRCode\QROptions::$quality
     * @codeCoverageIgnore
     */
    protected function set_pngCompression(int $pngCompression) : void
    {
        $this->quality = $pngCompression;
    }
    /**
     * @deprecated 5.0.0 use QROptions::$quality instead
     * @see        \chillerlan\QRCode\QROptions::$quality
     * @codeCoverageIgnore
     */
    protected function get_pngCompression() : int
    {
        return $this->quality;
    }
    /**
     * @deprecated 5.0.0 use QROptions::$transparencyColor instead
     * @see        \chillerlan\QRCode\QROptions::$transparencyColor
     */
    protected array $imageTransparencyBG;
    /**
     * @deprecated 5.0.0 use QROptions::$transparencyColor instead
     * @see        \chillerlan\QRCode\QROptions::$transparencyColor
     * @codeCoverageIgnore
     */
    protected function set_imageTransparencyBG(?array $imageTransparencyBG) : void
    {
        $this->transparencyColor = $imageTransparencyBG;
    }
    /**
     * @deprecated 5.0.0 use QROptions::$transparencyColor instead
     * @see        \chillerlan\QRCode\QROptions::$transparencyColor
     * @codeCoverageIgnore
     */
    protected function get_imageTransparencyBG() : ?array
    {
        return $this->transparencyColor;
    }
    /**
     * @deprecated 5.0.0 use QROptions::$bgColor instead
     * @see        \chillerlan\QRCode\QROptions::$bgColor
     */
    protected string $imagickBG;
    /**
     * @deprecated 5.0.0 use QROptions::$bgColor instead
     * @see        \chillerlan\QRCode\QROptions::$bgColor
     * @codeCoverageIgnore
     */
    protected function set_imagickBG(?string $imagickBG) : void
    {
        $this->bgColor = $imagickBG;
    }
    /**
     * @deprecated 5.0.0 use QROptions::$bgColor instead
     * @see        \chillerlan\QRCode\QROptions::$bgColor
     * @codeCoverageIgnore
     */
    protected function get_imagickBG() : ?string
    {
        return $this->bgColor;
    }
}

```