Skip to content

Commit

Permalink
🚿
Browse files Browse the repository at this point in the history
  • Loading branch information
@codemasher
codemasher committed Sep 3, 2023
1 parent f1008bd commit 91975f1
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
6 changes: 4 additions & 2 deletions docs/API-QROptions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,10 @@ Inherited from [`SettingsContainerAbstract`](https://github.com/chillerlan/php-s
| `$svgPreserveAspectRatio` | `string` | `'xMidYMid'` | * | See [preserveAspectRatio on MDN](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio) |
| `$svgWidth` | `string\|null` | `null` | * | Optional "width" attribute with the specified value (note that the value is not checked!) |
| `$svgHeight` | `string\|null` | `null` | * | Optional "height" attribute with the specified value (note that the value is not checked!) |
| `$textDark` | `string` | `'🔴'` | * | String substitute for dark |
| `$textLight` | `string` | `'⭕'` | * | String substitute for light |
| `$textDark` | `string` | `'██'` | * | String substitute for dark |
| `$textLight` | `string` | `'░░'` | * | String substitute for light |
| `$textLineStart` | `string` | `''` | * | An optional line prefix, e.g. empty space to align the QR Code in a console |
| `$jsonAsBooleans` | `bool` | `false` | * | Whether to return matrix values in JSON as booleans or $M_TYPE integers |
| `$fpdfMeasureUnit` | `string` | `'pt'` | * | Measurement unit for FPDF output: pt, mm, cm, in |
| `$readerUseImagickIfAvailable` | `bool` | `false` | * | Use Imagick (if available) when reading QR Codes |
| `$readerGrayscale` | `bool` | `false` | * | Grayscale the image before reading |
Expand Down
8 changes: 4 additions & 4 deletions docs/API-QROutputInterface.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ The full phpDocumentor API documentation can be found at [chillerlan.github.io/p

## Methods
<!-- using non-breaking spaces chr(255) in the longest method signature to force the silly table to stretch -->
| 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 |
| method | return | description |
|---------------------------------------|---------|----------------------------------------------------------------------|
| (static) `moduleValueIsValid($value)` | `bool` | Checks whether the given value is valid for the current output class |
| `dump(string $file = null)` | `mixed` | Generates the output, optionally dumps it to a file, and returns it |


## Constants
Expand Down
8 changes: 5 additions & 3 deletions docs/Appendix-URI-Content.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ https://www.youtube.com/watch?v=dQw4w9WgXcQ

**See also:**

- [What is a URL? (Mozilla MDN)](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL)
- [URL (Wikipedia)](https://en.wikipedia.org/wiki/URL)
- [What is a URL? (Mozilla MDN)](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL)
- [URL (Wikipedia)](https://en.wikipedia.org/wiki/URL)


## E-Mail `mailto`
Expand Down Expand Up @@ -84,7 +84,7 @@ geo:<latitude>,<longitude>[,<altitude>;crs=<crs>;u=<num>]
```

The default coordinate system is WGS-84, for which latitude and longitude should be supplied as decimal degrees, the optional altitude in meters.
Te parameter `u` can be used to specify an *uncertainty* value (in meters), a different *coordinate reference system* may be supplied with `crs`.
The parameter `u` can be used to specify an *uncertainty* value (in meters), a different *coordinate reference system* may be supplied with `crs`.

Some applications support an additional query string with values of `z` for *zoom* level and `q` for a local search *query* (URL-encoded):
```
Expand Down Expand Up @@ -243,6 +243,8 @@ END:VEVENT
END:VCALENDAR
```

**See also:**

- [RFC 5545 - Internet Calendaring and Scheduling Core Object Specification (iCalendar)](https://datatracker.ietf.org/doc/html/rfc5545)
- [iCalendar (Wikipedia)](https://en.wikipedia.org/wiki/ICalendar)
- [vobject library for PHP (GitHub)](https://github.com/sabre-io/vobject)
Expand Down

0 comments on commit 91975f1

Please sign in to comment.