mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-30 03:58:28 +00:00
Deploying to readthedocs from @ chillerlan/php-qrcode@b9b1e1fbfa 🚀
This commit is contained in:
+2
-2
@@ -412,11 +412,11 @@
|
||||
<td><p>*</p></td>
|
||||
<td><p>Optional cache file path</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$imageBase64</span></code></p></td>
|
||||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">$outputBase64</span></code></p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
|
||||
<td><p>*</p></td>
|
||||
<td><p>Toggle base64 or raw image data (if applicable)</p></td>
|
||||
<td><p>Toggle base64 data URI or raw data output (if applicable)</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">$eol</span></code></p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">string</span></code></p></td>
|
||||
|
||||
@@ -378,8 +378,8 @@ After invocation of the <code class="docutils literal notranslate"><span class="
|
||||
<section id="save-to-file">
|
||||
<h3>Save to file<a class="headerlink" href="#save-to-file" title="Link to this heading"></a></h3>
|
||||
<p>Save the QR Code output to <code class="docutils literal notranslate"><span class="pre">/path/to/qrcode.svg</span></code>:</p>
|
||||
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-></span><span class="na">imageBase64</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span>
|
||||
<span class="nv">$options</span><span class="o">-></span><span class="na">cachefile</span> <span class="o">=</span> <span class="s1">'/path/to/qrcode.svg'</span><span class="p">;</span>
|
||||
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span><span class="o">-></span><span class="na">outputBase64</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span>
|
||||
<span class="nv">$options</span><span class="o">-></span><span class="na">cachefile</span> <span class="o">=</span> <span class="s1">'/path/to/qrcode.svg'</span><span class="p">;</span>
|
||||
|
||||
<span class="nv">$qrcode</span><span class="o">-></span><span class="na">render</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
@@ -291,8 +291,8 @@
|
||||
<h3>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h3>
|
||||
<p>Configuration using <code class="docutils literal notranslate"><span class="pre">QROptions</span></code>:</p>
|
||||
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">QROptions</span><span class="p">;</span>
|
||||
<span class="nv">$options</span><span class="o">-></span><span class="na">version</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span>
|
||||
<span class="nv">$options</span><span class="o">-></span><span class="na">imageBase64</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span> <span class="c1">// output raw image instead of base64 data URI</span>
|
||||
<span class="nv">$options</span><span class="o">-></span><span class="na">version</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span>
|
||||
<span class="nv">$options</span><span class="o">-></span><span class="na">outputBase64</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span> <span class="c1">// output raw image instead of base64 data URI</span>
|
||||
|
||||
<span class="nb">header</span><span class="p">(</span><span class="s1">'Content-type: image/svg+xml'</span><span class="p">);</span> <span class="c1">// the image type is SVG by default</span>
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ Inherited from [`SettingsContainerAbstract`](https://github.com/chillerlan/php-s
|
||||
| `$outputInterface` | `string\|null` | `null` | * | The FQCN of the custom `QROutputInterface` if `QROptions::$outputType` is set to `QROutputInterface::CUSTOM` |
|
||||
| `$returnResource` | `bool` | `false` | * | Return the image resource instead of a render if applicable. |
|
||||
| `$cachefile` | `string\|null` | `null` | * | Optional cache file path |
|
||||
| `$imageBase64` | `bool` | `true` | * | Toggle base64 or raw image data (if applicable) |
|
||||
| `$outputBase64` | `bool` | `true` | * | Toggle base64 data URI or raw data output (if applicable) |
|
||||
| `$eol` | `string` | `PHP_EOL` | * | Newline string (HTML, SVG, TEXT) |
|
||||
| `$bgColor` | `mixed` | `null` | a valid FPDF, GD or Imagick color value | Sets the image background color (if applicable). QRImagick: defaults to "white", QRGdImage: defaults to [255, 255, 255], QRFpdf: defaults to blank internally (white page) |
|
||||
| `$drawLightModules` | `bool` | `true` | * | Whether to draw the light (false) modules |
|
||||
|
||||
@@ -126,8 +126,8 @@ $qrcode->setOptions($options);
|
||||
Save the QR Code output to `/path/to/qrcode.svg`:
|
||||
|
||||
```php
|
||||
$options->imageBase64 = false;
|
||||
$options->cachefile = '/path/to/qrcode.svg';
|
||||
$options->outputBase64 = false;
|
||||
$options->cachefile = '/path/to/qrcode.svg';
|
||||
|
||||
$qrcode->render($data);
|
||||
```
|
||||
|
||||
@@ -27,8 +27,8 @@ Configuration using `QROptions`:
|
||||
|
||||
```php
|
||||
$options = new QROptions;
|
||||
$options->version = 7;
|
||||
$options->imageBase64 = false; // output raw image instead of base64 data URI
|
||||
$options->version = 7;
|
||||
$options->outputBase64 = false; // output raw image instead of base64 data URI
|
||||
|
||||
header('Content-type: image/svg+xml'); // the image type is SVG by default
|
||||
|
||||
|
||||
+1
-1
@@ -268,7 +268,7 @@
|
||||
|
||||
<section id="php-qrcode-manual">
|
||||
<h1>PHP-QRCode Manual<a class="headerlink" href="#php-qrcode-manual" title="Link to this heading"></a></h1>
|
||||
<p>Edition for <a class="reference external" href="https://github.com/chillerlan/php-qrcode/">chillerlan/php-qrcode</a> [main]. Updated on Sep 03, 2023.</p>
|
||||
<p>Edition for <a class="reference external" href="https://github.com/chillerlan/php-qrcode/">chillerlan/php-qrcode</a> [main]. Updated on Sep 05, 2023.</p>
|
||||
<p>This work is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user