Skip to content

Commit

Permalink
📖
Browse files Browse the repository at this point in the history
  • Loading branch information
codemasher committed Jan 7, 2024
1 parent 3062cb5 commit e9cc23d
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,13 @@ It also features a QR Code reader based on a [PHP port](https://github.com/khana
- numeric
- alphanumeric
- 8-bit binary
- [ECI support](https://en.wikipedia.org/wiki/Extended_Channel_Interpretation)
- 13-bit double-byte:
- kanji (Japanese, Shift-JIS)
- hanzi (simplified Chinese, GB2312/GB18030) as [defined in GBT18284-2000](https://www.chinesestandard.net/PDF/English.aspx/GBT18284-2000)
- Flexible, easily extensible output modules, built-in support for the following output formats:
- [GdImage](https://www.php.net/manual/book.image)
- [ImageMagick](https://www.php.net/manual/book.imagick)
- [GdImage](https://www.php.net/manual/book.image) (raster graphics: bmp, gif, jpeg, png, webp)
- [ImageMagick](https://www.php.net/manual/book.imagick) ([multiple supported image formats](https://imagemagick.org/script/formats.php))
- Markup types: SVG, HTML, etc.
- String types: JSON, plain text, etc.
- Encapsulated Postscript (EPS)
Expand Down
14 changes: 14 additions & 0 deletions docs/Usage/Configuration-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,9 +232,18 @@ Specifies which module types to exclude when `QROptions::$drawCircularModules` i

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 also:**

- `\chillerlan\QRCode\Output\QROutputAbstract::collectModules()`
- `\chillerlan\QRCode\QROptionsTrait::$excludeFromConnect`
- [github.com/chillerlan/php-qrcode/issues/57](https://github.com/chillerlan/php-qrcode/issues/57)


Expand All @@ -243,6 +252,11 @@ Whether to connect the paths for the several module types to avoid weird glitche
Specify which paths/patterns to exclude from connecting if `QROptions::$connectPaths` is set to `true`


**See also:**

- `\chillerlan\QRCode\QROptionsTrait::$connectPaths`


## moduleValues

Module values map
Expand Down
5 changes: 3 additions & 2 deletions docs/Usage/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ It also features a QR Code reader based on a [PHP port](https://github.com/khana
- numeric
- alphanumeric
- 8-bit binary
- [ECI support](https://en.wikipedia.org/wiki/Extended_Channel_Interpretation)
- 13-bit double-byte:
- kanji (Japanese, Shift-JIS)
- hanzi (simplified Chinese, GB2312/GB18030) as [defined in GBT18284-2000](https://www.chinesestandard.net/PDF/English.aspx/GBT18284-2000)
- Flexible, easily extensible output modules, built-in support for the following output formats:
- [GdImage](https://www.php.net/manual/book.image)
- [ImageMagick](https://www.php.net/manual/book.imagick)
- [GdImage](https://www.php.net/manual/book.image) (raster graphics: bmp, gif, jpeg, png, webp)
- [ImageMagick](https://www.php.net/manual/book.imagick) ([multiple supported image formats](https://imagemagick.org/script/formats.php))
- Markup types: SVG, HTML, etc.
- String types: JSON, plain text, etc.
- Encapsulated Postscript (EPS)
Expand Down

0 comments on commit e9cc23d

Please sign in to comment.