RTFD!

This commit is contained in:
smiley
2023-07-13 18:33:06 +02:00
parent 1423638fa0
commit 3783ef7b0f
9 changed files with 641 additions and 32 deletions
+29
View File
@@ -0,0 +1,29 @@
# `QROutputInterface`
The full phpDocumentor API documentation can be found at [chillerlan.github.io/php-qrcode](https://chillerlan.github.io/php-qrcode/classes/chillerlan-QRCode-Output-QROutputInterface.html).
## Methods
| method | return | description |
|---------------------------------------|---------|---------------------------------------------------------------------|
| (static) `moduleValueIsValid($value)` | `bool` | Determines whether the given value is valid |
| `dump(string $file = null)` | `mixed` | Generates the output, optionally dumps it to a file, and returns it |
## Constants
| name | description |
|-------------------------|----------------------------------------------------|
| `MARKUP_HTML` | |
| `MARKUP_SVG` | |
| `GDIMAGE_PNG` | |
| `GDIMAGE_JPG` | |
| `GDIMAGE_GIF` | |
| `STRING_JSON` | |
| `STRING_TEXT` | |
| `IMAGICK` | |
| `FPDF` | |
| `EPS` | |
| `CUSTOM` | |
| `MODES` | Map of built-in output modes => class FQN |
| `DEFAULT_MODULE_VALUES` | Map of module type => default value |
| `LAYERNAMES` | Map of module type => readable name (for CSS etc.) |