From 6a44b067ef0a99d1bd132af37dec5fd751ba2544 Mon Sep 17 00:00:00 2001 From: smiley Date: Tue, 11 Jul 2023 01:42:58 +0200 Subject: [PATCH] :sparkles: fuck it, read the docs --- .readthedocs.yml | 31 +++ docs/Appendix-License.rst | 443 +++++++++++++++++++++++++++++++++++ docs/Makefile | 20 ++ docs/Readme.md | 65 +++++ docs/Usage-Advanced-usage.md | 237 +++++++++++++++++++ docs/Usage-Installation.md | 94 ++++++++ docs/Usage-Overview.md | 56 +++++ docs/Usage-Quickstart.md | 66 ++++++ docs/conf.py | 239 +++++++++++++++++++ docs/index.rst | 25 ++ docs/make.bat | 36 +++ docs/requirements.txt | 3 + 12 files changed, 1315 insertions(+) create mode 100644 .readthedocs.yml create mode 100644 docs/Appendix-License.rst create mode 100644 docs/Makefile create mode 100644 docs/Readme.md create mode 100644 docs/Usage-Advanced-usage.md create mode 100644 docs/Usage-Installation.md create mode 100644 docs/Usage-Overview.md create mode 100644 docs/Usage-Quickstart.md create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..55336736c --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,31 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/Appendix-License.rst b/docs/Appendix-License.rst new file mode 100644 index 000000000..9755daa25 --- /dev/null +++ b/docs/Appendix-License.rst @@ -0,0 +1,443 @@ +******* +License +******* + +.. code-block:: text + + Copyright (c) 2023 smiley. + + This work is licensed under the Creative Commons + Attribution 4.0 International (CC BY 4.0) + + A summary of the license is given below, followed by the full legal + text. + + ----------------------------------------------------------------------- + + You are free to: + + Share + + - copy and redistribute the material in any medium or format + + Adapt + + - remix, transform, and build upon the material for any purpose, + even commercially. + + The licensor cannot revoke these freedoms as long as you follow the + license terms. + + + Under the following terms: + + Attribution + + - You must give appropriate credit, provide a link to the license, + and indicate if changes were made. + + - You may do so in any reasonable manner, but not in any way that + suggests the licensor endorses you or your use. + + No additional restrictions + + - You may not apply legal terms or technological measures that + legally restrict others from doing anything the license permits. + + ----------------------------------------------------------------------- + + Attribution 4.0 International + + ======================================================================= + + Creative Commons Corporation ("Creative Commons") is not a law firm and + does not provide legal services or legal advice. Distribution of + Creative Commons public licenses does not create a lawyer-client or + other relationship. Creative Commons makes its licenses and related + information available on an "as-is" basis. Creative Commons gives no + warranties regarding its licenses, any material licensed under their + terms and conditions, or any related information. Creative Commons + disclaims all liability for damages resulting from their use to the + fullest extent possible. + + Using Creative Commons Public Licenses + + Creative Commons public licenses provide a standard set of terms and + conditions that creators and other rights holders may use to share + original works of authorship and other material subject to copyright + and certain other rights specified in the public license below. The + following considerations are for informational purposes only, are not + exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + + ======================================================================= + + Creative Commons Attribution 4.0 International Public License + + By exercising the Licensed Rights (defined below), You accept and agree + to be bound by the terms and conditions of this Creative Commons + Attribution 4.0 International Public License ("Public License"). To the + extent this Public License may be interpreted as a contract, You are + granted the Licensed Rights in consideration of Your acceptance of + these terms and conditions, and the Licensor grants You such rights in + consideration of benefits the Licensor receives from making the + Licensed Material available under these terms and conditions. + + + Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + + Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + + Section 3 -- License Conditions. + + Your exercise of the Licensed Rights is expressly made subject to the + following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + + Section 4 -- Sui Generis Database Rights. + + Where the Licensed Rights include Sui Generis Database Rights that + apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + + For the avoidance of doubt, this Section 4 supplements and does not + replace Your obligations under this Public License where the Licensed + Rights include other Copyright and Similar Rights. + + + Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + + Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + + Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + + Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + + ======================================================================= + + Creative Commons is not a party to its public + licenses. Notwithstanding, Creative Commons may elect to apply one of + its public licenses to material it publishes and in those instances + will be considered the “Licensor.” The text of the Creative Commons + public licenses is dedicated to the public domain under the CC0 Public + Domain Dedication. Except for the limited purpose of indicating that + material is shared under a Creative Commons public license or as + otherwise permitted by the Creative Commons policies published at + creativecommons.org/policies, Creative Commons does not authorize the + use of the trademark "Creative Commons" or any other trademark or logo + of Creative Commons without its prior written consent including, + without limitation, in connection with any unauthorized modifications + to any of its public licenses or any other arrangements, + understandings, or agreements concerning use of licensed material. For + the avoidance of doubt, this paragraph does not form part of the + public licenses. + + Creative Commons may be contacted at creativecommons.org. diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..4bbaa7dfe --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = ../.build/sphinx + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 000000000..f38c79062 --- /dev/null +++ b/docs/Readme.md @@ -0,0 +1,65 @@ +# Documentation + +## Sources + +The markdown sources for the [Read the Docs online manual](https://php-qrcode.readthedocs.io) can of course be browsed on GitHub too! + + +### Usage +- [Overview](./Usage-Overview.md) +- [Installation](./Usage-Installation.md) +- [Quickstart](./Usage-Quickstart.md) +- [Advanced usage](./Usage-Advanced-usage.md) + +### Appendix +- [License](./Appendix-License.rst) + +## Auto generated documentation + +### User manual via Sphinx + +[![Documentation Status](https://readthedocs.org/projects/php-qrcode/badge/?version=latest)](https://php-qrcode.readthedocs.io/en/latest/?badge=latest) + +The user manual can be auto generated with [Sphinx](https://www.sphinx-doc.org) from the markdown sources contained in this directory, in order to upload it to [Read the Docs](https://readthedocs.org). +The online documentation can be found at [php-qrcode.readthedocs.io](https://php-qrcode.readthedocs.io) ([project page](https://readthedocs.org/projects/php-qrcode/)) + + +#### Run Sphinx locally + +Requirements: + +- [Python](https://www.python.org/downloads/) >= v3.10 + - [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) >= v7.0 + - [Sphinx RTD theme](https://pypi.org/project/sphinx-rtd-theme/) >= 1.2 + - [MyST Parser](https://myst-parser.readthedocs.io/en/latest/intro.html) >= 2.0 (see [Sphinx Markdown configuration](https://www.sphinx-doc.org/en/master/usage/markdown.html#markdown)) + + +- to install all in one go, run: `pip install sphinx myst-parser sphinx-rtd-theme` +- run in the `/docs` (this) directory: + - on Windows: `.\make.bat html` (make sure `sphinx-build.exe` is in `PATH`) + - on Linux: `make html` +- open [../.build/sphinx/html/index.html](../.build/sphinx/html/index.html) in a browser +- yay! + + +### API docs via phpDocumentor +[![pages-build-deployment](https://github.com/chillerlan/php-qrcode/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/chillerlan/php-qrcode/actions/workflows/pages/pages-build-deployment) + +The API documentation can be auto generated with [phpDocumentor](https://www.phpdoc.org/). +There is an [online version available](https://chillerlan.github.io/php-qrcode/) via the [gh-pages branch](https://github.com/chillerlan/php-qrcode/tree/gh-pages) that is [automatically deployed](https://github.com/chillerlan/php-qrcode/deployments) on each push to main. + + +#### Run phpDocumentor locally +If you'd like to create local docs, please follow these steps: + +- [download phpDocumentor](https://github.com/phpDocumentor/phpDocumentor/releases) v3+ as .phar archive +- run it in the repository root directory: + - on Windows `c:\path\to\php.exe c:\path\to\phpDocumentor.phar --config=phpdoc.xml` + - on Linux just `php /path/to/phpDocumentor.phar --config=phpdoc.xml` +- open [../.build/phpdocs/index.html](../.build/phpdocs/index.html) in a browser +- profit! + + +## License + +The documentation is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/). diff --git a/docs/Usage-Advanced-usage.md b/docs/Usage-Advanced-usage.md new file mode 100644 index 000000000..ee5bbc088 --- /dev/null +++ b/docs/Usage-Advanced-usage.md @@ -0,0 +1,237 @@ +# Advanced usage + +## Configuration via `QROptions` + +The [`QROptions`](https://github.com/chillerlan/php-qrcode/blob/main/src/QROptions.php) class is a container based on [chillerlan/php-settings-container](https://github.com/chillerlan/php-settings-container) that behaves similar to a [`\stdClass`](https://www.php.net/manual/class.stdclass) object, but with fixed properties. + +```php +$options = new QROptions; + +// set some values +$options->version = 7; // property "version" exists +$options->foo = 'bar'; // property "foo" does not exist (and will not be created) + +// retrieve values +var_dump($options->version); // -> 7 +var_dump($options->foo); // -> null (no error will be thrown) +``` + + +### Supply an `iterable` of options + +The constructor takes an `iterable` of `$key => $value` pairs. For each setting an optional setter will be called if present. + +```php +$myOptions = [ + 'version' => 5, + 'outputType' => QROutputInterface::GDIMAGE_PNG, + 'eccLevel' => EccLevel::M, +]; + +$options = new QROptions($myOptions); +``` + +You can also set an `iterable` of options on an existing QROptions instance: + +```php +$options->fromIterable($myOptions); +``` + + +### Load and save JSON + +The settings can be saved to and loaded from JSON, e.g. to store them in a database: + +```php +$json = $options->toJSON(JSON_THROW_ON_ERROR); +// via JsonSerializable interface +$json = json_encode($options, JSON_THROW_ON_ERROR); +// via __toString() +$json = (string)$options; + +$options = (new QROptions)->fromJSON($json); +// on an existing instance - properties will be overwriten +$options->fromJSON($json); +``` + +### Extending the `QROptions` class + +In case you need additional settings for your output module, just extend `QROptions`... + +```php +class MyCustomOptions extends QROptions{ + protected string $myParam = 'defaultValue'; + // ... +} +``` +...or use the [`SettingsContainerInterface`](https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerInterface.php), which is the more flexible approach. + +```php +trait MyCustomOptionsTrait{ + protected string $myParam = 'defaultValue'; + // ... + + // an optional magic setter, named "set_" + property name + protected function set_myParam(string $myParam):void{ + $this->myParam = trim($myParam); + } + + // an optional magic getter, named "get_" + property name + protected function get_myParam():string{ + return strtoupper($this->myParam); + } +} + +class MyCustomOptions extends SettingsContainerAbstract{ + use QROptionsTrait, MyCustomOptionsTrait; +} + +// set the options +$myCustomOptions = new MyCustomOptions; +$myCustomOptions->myParam = 'whatever value'; +``` + +Extend the `SettingsContainerInterface` on-the-fly: + +```php +$myOptions = [ + 'myParam' => 'whatever value', + // ... +]; + +$myCustomOptions = new class($myOptions) extends SettingsContainerAbstract{ + use QROptionsTrait, MyCustomOptionsTrait; +}; +``` + + +## `QRCode` methods + +Aside of invoking a `QRCode` instance with an optional `QROptions` object as parameter, you can also set the options instance after invocation. +After invocation of the `QROptions` instance, values can be set without calling `QRCode::setOptions()` again (instance is backreferenced), however, this may create side effects. + +```php +// instance will be invoked with default settings +$qrcode = new QRCode; + +// set options after QRCode invocation +$options = new QROptions; + +$qrcode->setOptions($options); +``` + + +### Save to file + +Save the QR Code output to `/path/to/qrcode.svg`: + +```php +$options->imageBase64 = false; +$options->cachefile = '/path/to/qrcode.svg'; + +$qrcode->render($data); +``` + +Alternatively, you can specify an output path, which will override the `QROptions::$cachefile` setting: + +```php +$qrcode->render($data, '/other/path/to/qrcode.svg'); + +printf('QR Code', '/other/path/to/qrcode.svg'); +``` + + +### Render a `QRMatrix` instance + +You can render a [`QRMatrix`](https://github.com/chillerlan/php-qrcode/blob/main/src/Data/QRMatrix.php) instance directly: + +```php +// a matrix from the current data segments +$matrix = $qrcode->getQRMatrix(); +// from the QR Code reader +$matrix = $readerResult->getQRMatrix(); +// manually invoked +$matrix = (new QRMatrix(new Version(7), new EccLevel(EccLevel::M)))->initFunctionalPatterns(); + +$output = $qrcode->renderMatrix($matrix); +// save to file +$qrcode->renderMatrix($matrix, '/path/to/qrcode.svg'); +``` + +Manual invocation of a `QROutputInterface` to render a `QRMatrix` instance: + +```php +class MyCustomOutput extends QRMarkupSVG{ + // ... +} + +$qrOutputInterface = new MyCustomOutput($options, $matrix); + +$output = $qrOutputInterface->dump() +// render to file +$qrOutputInterface->dump('/path/to/qrcode.svg'); +``` + + +### Mixed mode + +Mixed mode QR Codes can be generated by adding several data segments: + +```php +// make sure to set a proper internal encoding character set +// ideally, this should be set in php.ini internal_encoding, +// default_charset or mbstring.internal_encoding +mb_internal_encoding('UTF-8'); + +// clear any existing data segments +$qrcode->clearSegments(); + +$qrcode + ->addNumericSegment($numericData) + ->addAlphaNumSegment($alphaNumData) + ->addKanjiSegment($kanjiData) + ->addHanziSegment($hanziData) + ->addByteSegment($binaryData) + ->addEciSegment(ECICharset::GB18030, $encodedEciData) +; + +$output = $qrcode->render(); +// render to file +$qrcode->render(null, '/path/to/qrcode.svg'); +``` + +The [`QRDataModeInterface`](https://github.com/chillerlan/php-qrcode/blob/main/src/Data/QRDataModeInterface.php) offers the `validateString()` method (implemended for `AlphaNum`, `Byte`, `Hanzi`, `Kanji` and `Number`). +This method is used internally when a data mode is invoked, but it can come in handy if you need to check input data beforehand. + +```php +if(!Hanzi::validateString($data)){ + throw new Exception('invalid GB2312 data'); +} + +$qrcode->addHanziSegment($data); +``` + + +### QR Code reader + +In some cases it might be necessary to increase the contrast of a QR Code image: + +```php +$options->readerUseImagickIfAvailable = true; +$options->readerIncreaseContrast = true; +$options->readerGrayscale = true; + +$result = (new QRCode($options))->readFromFile('path/to/qrcode.png'); +``` + +The `QRMatrix` object from the [`DecoderResult`](https://github.com/chillerlan/php-qrcode/blob/main/src/Decoder/DecoderResult.php) can be reused: + +```php +$matrix = $result->getQRMatrix(); + +// ...matrix modification... + +$output = (new QRCode($options))->renderMatrix($matrix); + +// ...output +``` diff --git a/docs/Usage-Installation.md b/docs/Usage-Installation.md new file mode 100644 index 000000000..dfd54727b --- /dev/null +++ b/docs/Usage-Installation.md @@ -0,0 +1,94 @@ +# Installation + +## Installation with Composer + +**[Composer](https://getcomposer.org) is required to install this package. Please do not open an issue to complain about "monopolizing the implementation" or similar - we've been there before.** + + +### composer.json + +Installation via [`composer.json`](https://getcomposer.org/doc/04-schema.md): + +```json +{ + "require": { + "php": "^7.4", + "chillerlan/php-qrcode": "dev-main" + } +} +``` + +Note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^4.3` - see [releases](https://github.com/chillerlan/php-qrcode/releases) for valid versions. +In case you want to keep using `dev-main`, specify the hash of a commit to avoid running into unforseen issues, like so: `dev-main#cb69751c3bc090a7fdd2f2601bbe10f28d225f10` + + +#### Version switch + +If your application supports older PHP versions and uses the basic `QRCode` syntax `(new QRCode)->render($data)`, then you can add a version switch to your `composer.json` to allow installing a `php-qrcode` version that suits the platform it runs on: + +```json +{ + "require": { + "php": "^7.0 || ^8.0", + "chillerlan/php-qrcode": "^2.0 || ^3.4 || ^4.3 || ^5.0" + } +} +``` + +Most of the v2.0 API remains unchanged throughout the several versions up to v5.x, however, please test and verify the expected output before you deploy such a switch. + + +### Terminal + +To install `php-qrcode` on the terminal, use: + +`composer require chillerlan/php-qrcode` + +If you want to install the package from a specific tag or commit, do as follows: + +- `composer require chillerlan/php-qrcode:4.3.4` +- `composer require chillerlan/php-qrcode:dev-main#f15b0afe9d4128bf734c3bf1bcffae72bf7b3e53` + + +## Manual installation + +Download the desired version of the package from [main](https://github.com/chillerlan/php-qrcode/archive/refs/heads/main.zip) or +[release](https://github.com/chillerlan/php-qrcode/releases) and extract the contents to your project folder. +After that, run `composer install` in the package root directory to install the required dependencies and generate `./vendor/autoload.php`. + +Profit! + + +### Can i use this library without using composer? + +You can, but it's absolutely not recommended, nor supported. + +With that said, I'll leave you with this info: + +- download the .zip for a version of your choice and also all required dependencies listed in the `composer.json` for that version (you can find links to the respective repos [on packagist](https://packagist.org/packages/chillerlan/php-qrcode)) +- extract the files into your library folder +- include the files manually or with whatever autoloader you are using + +Good luck! + + +## Supported PHP versions & extension requirements + +The PHP built-in extensions [GdImage](https://www.php.net/manual/book.image.php) and [mbstring](https://www.php.net/manual/book.mbstring.php) are used across all versions, [ImageMagick](https://www.php.net/manual/book.imagick.php) is optional since v3.x. + +| version | branch/tag | PHP | supported | required extensions | optional extensions | info | +|---------|----------------------------------------------------------------------|------------------|-----------|---------------------|------------------------------------------------------------------------------------|---------------------------| +| **v5** | [`dev-main`](https://github.com/chillerlan/php-qrcode/tree/main) | `^7.4 \|\| ^8.0` | yes | `mbstring` | `gd` or `imagick` required for reading QR Codes, `fileinfo` is used in `QRImagick` | | +| **v4** | [`4.3.4`](https://github.com/chillerlan/php-qrcode/tree/v4.3.x) | `^7.4 \|\| ^8.0` | yes | `gd`, `mbstring` | `imagick` | | +| **v3** | [`3.4.1`](https://github.com/chillerlan/php-qrcode/tree/v3.2.x) | `^7.2` | no | `gd`, `mbstring` | `imagick` | v3.4.1 also supports PHP8 | +| **v2** | [`2.0.8`](https://github.com/chillerlan/php-qrcode/tree/v2.0.x) | `>=7.0.3` | no | `gd`, `mbstring` | | | +| **v1** | [`1.0.9`](https://github.com/chillerlan/php-qrcode/tree/v2.0.x-php5) | `>=5.6` | no | `gd`, `mbstring` | | please let PHP 5 die! | + +PSA: [PHP versions < 8.0 are EOL](https://www.php.net/supported-versions.php) and therefore the respective `QRCode` versions are also no longer supported! + + +## ImageMagick + +Please follow the installation guides for your operating system: +- ImageMagick: [imagemagick.org/script/download.php](https://imagemagick.org/script/download.php) +- PHP `ext-imagick`: [github.com/Imagick/imagick](https://github.com/Imagick/imagick) diff --git a/docs/Usage-Overview.md b/docs/Usage-Overview.md new file mode 100644 index 000000000..5c8cea390 --- /dev/null +++ b/docs/Usage-Overview.md @@ -0,0 +1,56 @@ +# Overview + +## Features + +- Creation of [Model 2 QR Codes](https://www.qrcode.com/en/codes/model12.html), [Version 1 to 40](https://www.qrcode.com/en/about/version.html) +- [ECC Levels](https://www.qrcode.com/en/about/error_correction.html) L/M/Q/H supported +- Mixed mode support (encoding modes can be combined within a QR symbol). Supported modes: + - numeric + - alphanumeric + - 8-bit binary + - 13-bit double-byte kanji (Japanese, Shift-JIS) and 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) + - Markup types: SVG, HTML, etc. + - String types: JSON, plain text, etc. + - Encapsulated Postscript (EPS) + - PDF via [FPDF](https://github.com/setasign/fpdf) +- QR Code reader (via GD and ImageMagick) + + +## Requirements +- PHP 7.4+ + - [`ext-mbstring`](https://www.php.net/manual/book.mbstring.php) + - optional: + - [`ext-fileinfo`](https://www.php.net/manual/book.fileinfo.php) (required by `QRImagick` output) + - [`ext-gd`](https://www.php.net/manual/book.image) + - [`ext-imagick`](https://github.com/Imagick/imagick) with [ImageMagick](https://imagemagick.org) installed + - [`setasign/fpdf`](https://github.com/setasign/fpdf) for the PDF output module + +For the QR Code reader, either `ext-gd` or `ext-imagick` is required! + + +## Framework Integration + +- Drupal: + - [Two-factor Authentication `tfa`](https://www.drupal.org/project/tfa) (Drupal 8+) + - [Google Authenticator Login `ga_login`](https://www.drupal.org/project/ga_login) (deprecated, Drupal 7) +- Symfony + - [phpqrcode-bundle](https://github.com/jonasarts/phpqrcode-bundle) +- WordPress: + - [wp-two-factor-auth](https://github.com/sjinks/wp-two-factor-auth) + - [simple-2fa](https://wordpress.org/plugins/simple-2fa/) + - [floating-share-button](https://github.com/qriouslad/floating-share-button) +- WoltLab Suite + - [two-step-verification](http://pluginstore.woltlab.com/file/3007-two-step-verification/) +- other uses: + - [dependents](https://github.com/chillerlan/php-qrcode/network/dependents) / [packages](https://github.com/chillerlan/php-qrcode/network/dependents?dependent_type=PACKAGE) + - [Appwrite](https://github.com/appwrite/appwrite) + - [Cachet](https://github.com/CachetHQ/Cachet) + - [GÉANT CAT](https://github.com/GEANT/CAT) + - [openITCOCKPIT](https://github.com/it-novum/openITCOCKPIT) + - [twill](https://github.com/area17/twill) + - [Elefant CMS](https://github.com/jbroadway/elefant) +- Articles: + - [Twilio: How to Create a QR Code in PHP](https://www.twilio.com/blog/create-qr-code-in-php) (featuring v4.3.x) diff --git a/docs/Usage-Quickstart.md b/docs/Usage-Quickstart.md new file mode 100644 index 000000000..938aba00d --- /dev/null +++ b/docs/Usage-Quickstart.md @@ -0,0 +1,66 @@ +# Quickstart + +## Import the library + +Import the main class(es) and include the autoloader (if necessary): +```php +use chillerlan\QRCode\{QRCode, QROptions}; + +require_once __DIR__.'/../vendor/autoload.php'; +``` + + +## Create your first QR Code + +We want to encode this URI for a mobile authenticator into a QRcode image: +```php +$data = 'otpauth://totp/test?secret=B3JX4VCVJDVNXNZ5&issuer=chillerlan.net'; +$qrcode = (new QRCode)->render($data); + +printf('QR Code', $qrcode); +``` + + +### Configuration + +Configuration using `QROptions`: + +```php +$options = new QROptions; +$options->version = 7; +$options->imageBase64 = false; // output raw image instead of base64 data URI + +header('Content-type: image/svg+xml'); // the image type is SVG by default + +echo (new QRCode($options))->render($data); +``` + +See [Advanced usage](./Usage-Advanced-usage.md) for a more in-depth usage guide. +Also, have a look [in the examples folder](https://github.com/chillerlan/php-qrcode/tree/main/examples) for some more usage examples. + + +## Reading QR Codes + +Using the built-in QR Code reader is pretty straight-forward: +```php +try{ + $result = (new QRCode)->readFromFile('path/to/file.png'); // -> DecoderResult +} +catch(Throwable $exception){ + // handle exception... + // throw ... +} + +// you can now use the result instance... +$content = $result->data; + +// ...or simply cast the result instance to string to get the content +$content = (string)$result; +``` +It's generally a good idea to wrap the reading in a try/catch block to handle any errors that may occur in the process. + + +## Notes +The QR encoder, especially the subroutines for mask pattern testing, can cause high CPU load on increased matrix size. +You can avoid a part of this load by choosing a fast output module, like SVG. +Oh hey and don't forget to sanitize any user input! diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..4a43a1fe3 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,239 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# ---------------------------------------------------------------------------- + +import os +import platform +import re +import shlex +import sys +from subprocess import Popen, PIPE + +def get_version(): + if os.environ.get('READTHEDOCS') == 'True': + return os.environ.get('READTHEDOCS_VERSION') + + grep = 'git branch | findstr \*' if platform.system() == 'Windows' else 'git branch | grep \*' + pipe = Popen(grep, stdout=PIPE, shell=True, universal_newlines=True) + version = pipe.stdout.read() + + if version: + return version[2:] + else: + return 'unknown' + +# ---------------------------------------------------------------------------- + +# loading PhpLexer +from sphinx.highlighting import lexers +from pygments.lexers.web import PhpLexer + +# enable highlighting for PHP code not between ```` by default +lexers['php'] = PhpLexer(startinline=True) +lexers['php-annotations'] = PhpLexer(startinline=True) + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = u'PHP-QRCode' +copyright = u'2023, smiley' +author = u'smiley' +epub_author = u'smiley' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = get_version().strip() + +# The full version, including alpha/beta/rc tags. +release = version + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = '5.3.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'myst_parser', + 'sphinx.ext.autodoc', +] + +# Add any paths that contain templates here, relative to this directory. +#templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = ['.rst', '.md'] + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build', 'Readme.md'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The default language to highlight source code in. The default is 'default'. +# It is similar to 'python3'; it is mostly a superset of 'python' but it +# fallbacks to 'none' without warning if failed. +highlight_language = 'none' + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinx_rtd_theme' +html_theme_options = { + 'collapse_navigation': False, + 'display_version': False +} + +html_context = { + 'display_github': True, + 'github_user': 'chillerlan', + 'github_repo': 'php-qrcode', + 'github_version': version, + 'conf_py_path': '/docs/', +} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = ['_templates'] + +#html_add_permalinks = '' + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +html_title = "PHP-QRCode %s Manual" % get_version() + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +html_show_sphinx = False + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +#htmlhelp_basename = '' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..f7249db54 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,25 @@ +.. php-qrcode documentation master file, created by sphinx-quickstart on Sun Jul 9 21:45:56 2023. + +================= +PHP-QRCode Manual +================= + +Edition for ``chillerlan/php-qrcode`` [|version|]. Updated on |today|. + +This work is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License. + +.. toctree:: + :maxdepth: 3 + :caption: Usage + + Usage-Overview + Usage-Installation + Usage-Quickstart + Usage-Advanced-usage + +.. toctree:: + :maxdepth: 3 + :caption: Appendix + + Appendix-License + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..0fc6d0b20 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) + +set SOURCEDIR=. +set BUILDDIR=../.build/sphinx + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..c13ad56bb --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +myst-parser==2.0.0 +Sphinx==7.0.0 +sphinx_rtd_theme==1.2.1