Download the PHP package neosidekick/qrcode without Composer

On this page you can find all versions of the php package neosidekick/qrcode. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package qrcode

Latest Stable Version

NEOSidekick.QRCode

Themed QR code generation for Neos CMS

NEOSidekick.QRCode generates PNG and SVG QR codes for URLs in Neos projects. It is built on chillerlan/php-qrcode, supports configurable color themes, and can optionally place project-specific logos in the center of generated QR codes.

The package exposes small Fusion helpers that create signed Neos URLs to the QR code endpoint and to a ZIP archive endpoint for bulk downloads. These package endpoints are intended for authenticated Neos backend usage and are granted to Neos.Neos:AbstractEditor by default. The package registers its controllers with the Neos backend authentication provider so existing editor sessions are evaluated for these routes. It does not override Neos shortcut rendering.

Installation

NEOSidekick.QRCode is available via Packagist:

We use semantic versioning, so every breaking change will increase the major version number.

Usage

Generate a QR code URL from Fusion:

The generated URL points to the package endpoint:

Supported formats are png and svg.

By default, the endpoint requires an authenticated Neos editor session. Projects that need public QR generation should add a project-specific public endpoint or controller action with suitable access control, throttling or input limits.

Generate a ZIP archive URL containing multiple themes and formats:

The generated URL points to the archive endpoint:

Shortcut backend override example

The package does not install a shortcut override by default. If a project wants QR code previews directly in the Neos backend shortcut view, add the override in the site package.

Example Fusion:

Example Fluid template excerpt:

Configuration

The package intentionally keeps configuration small. Out of the box it ships two themes and QR version 10 with high error correction:

Themes

Each theme needs a color. The color is used for the dark QR code modules in both PNG and SVG output.

Logos

Logos are disabled by default. A theme only renders a logo when the logo is explicitly configured for that theme.

Configure PNG and SVG separately. If only logo.png is configured, PNG output contains a logo and SVG output stays plain. If only logo.svg is configured, SVG output contains a logo and PNG output stays plain.

Module shape

The default moduleShape: 'round' renders connected round modules. Projects that need the older square-module output can set moduleShape: 'square'.

Archive endpoint

The ZIP archive endpoint is disabled by default. Enable it only in projects that intentionally use bulk downloads in authenticated backend views:

When enabled, the endpoint accepts the same uri payload as the single QR endpoint, plus comma-separated themes and formats arguments. It rejects duplicate entries, unknown themes and unsupported formats before rendering. It creates one file per requested theme/format pair and returns an application/zip response.

Capacity

The package validates the byte length of the URI before rendering. The maximum payload is computed from the configured QR code version and error correction level; it is not a separate setting. With the default version: 10 and eccLevel: 'H', the maximum byte length is 119 bytes.

If the payload is too long, the endpoint returns HTTP 400 with a plain-text error message.

The same capacity helpers are available in Fusion/Eel as NEOSidekickQRCode.getPayloadBytes(payload) and NEOSidekickQRCode.getMaximumPayloadBytes().

Defaults and intentional non-features

Development

Run the test suite from a Neos distribution with the package installed in DistributionPackages/NEOSidekick.QRCode:

GitHub Actions runs style checks, PHPStan and PHPUnit against Neos 8.3 and 8.4.

License

The GNU General Public License, please see License File for more information.

All versions of qrcode with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
neos/neos Version ^8.3 || ^9.0
chillerlan/php-qrcode Version ^5.0
setasign/fpdf Version ^1.8.6
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package neosidekick/qrcode contains the following files

Loading the files please wait ...