API-QROutputInterface.md.txt 2.0 KB

1234567891011121314151617181920212223242526272829
  1. # `QROutputInterface`
  2. 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).
  3. ## Methods
  4. | method | return | description |
  5. |---------------------------------------|---------|---------------------------------------------------------------------|
  6. | (static) `moduleValueIsValid($value)` | `bool` | Determines whether the given value is valid |
  7. | `dump(string $file = null)` | `mixed` | Generates the output, optionally dumps it to a file, and returns it |
  8. ## Constants
  9. | name | description |
  10. |-------------------------|----------------------------------------------------|
  11. | `MARKUP_HTML` | |
  12. | `MARKUP_SVG` | |
  13. | `GDIMAGE_PNG` | |
  14. | `GDIMAGE_JPG` | |
  15. | `GDIMAGE_GIF` | |
  16. | `STRING_JSON` | |
  17. | `STRING_TEXT` | |
  18. | `IMAGICK` | |
  19. | `FPDF` | |
  20. | `EPS` | |
  21. | `CUSTOM` | |
  22. | `MODES` | Map of built-in output modes => class FQN |
  23. | `DEFAULT_MODULE_VALUES` | Map of module type => default value |
  24. | `LAYERNAMES` | Map of module type => readable name (for CSS etc.) |