QRCodeMonkey

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #android #machine-learning #macos #windows #awesome #kubernetes #awesome-list #vue #security #open-source

(★ 84)

A library using PHP to generate QRCode from https://www.qrcode-monkey.com free

File Explorer

Download Latest Version (.zip)

- - facebook.svg
  - jungle.svg
  - ninja.svg
  - rain.svg
  - twitter.svg
  - youtube.svg
- facebook.png
- - Constant.php
- - Data.php
  - Request.php
- QRCode.php
.gitignore
composer.json
example.php
LICENSE.md
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PHP Class Generate Free QRCode

> 👉 A library using PHP to generate QRCode from https://www.qrcode-monkey.com free 
> ✋ **NOTE:** Do not generate too many QRCode at once or your IP will be locked for a period of time

## Getting started

Use `composer` to integrate your PHP project

```shell
composer require nguyenary/qr-code-monkey
```

## Configuration

📘 You can configure to generate QRCode or use default configuration. Below is a list of configurations that you can use

<table>
 <thead>
 <tr>
 <th>Parameter</th>
 <th>Type</th>
 <th>Default</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>body</td>
 <td>String</td>
 <td>square</td>
 <td>
 <img width="30" src="image/src/qr/body/square.png" />
 &nbsp;&nbsp;&nbsp;&nbsp;square
 
 <img width="30" src="image/src/qr/body/mosaic.png" />
 &nbsp;&nbsp;&nbsp;&nbsp;mosaic
 
 <img width="30" src="image/src/qr/body/dot.png" />
 &nbsp;&nbsp;&nbsp;&nbsp;dot
 
 <img width="30" src="image/src/qr/body/circle.png" />
 &nbsp;&nbsp;&nbsp;&nbsp;circle
 
 <img width="30" src="image/src/qr/body/circle-zebra.png" />
 &nbsp;&nbsp;&nbsp;&nbsp;circle-zebra
 
 <img width="30" src="image/src/qr/body/circle-zebra-vertical.png" />
 &nbsp;&nbsp;&nbsp;&nbsp;circle-zebra-vertical
 
 <img width="30" src="image/src/qr/body/circular.png" />
 &nbsp;&nbsp;&nbsp;&nbsp;circular
 
 <img width="30" src="image/src/qr/body/edge-cut.png" />
 &nbsp;&nbsp;edge-cut
 
 <img width="30" src="image/src/qr/body/edge-cut-smooth.png" />
 &nbsp;&nbsp;edge-cut-smooth
 
 <img width="30" src="image/src/qr/body/japnese.png" />
 &nbsp;&nbsp;japnese
 
 <img width="30" src="image/src/qr/body/leaf.png" />
 &nbsp;&nbsp;leaf
 
 <img width="30" src="image/src/qr/body/pointed.png" />
 &nbsp;&nbsp;pointed
 
 <img width="30" src="image/src/qr/body/pointed-edge-cut.png" />
 &nbsp;&nbsp;pointed-edge-cut
 
 <img width="30" src="image/src/qr/body/pointed-in.png" />
 &nbsp;&nbsp;pointed-in
 
 <img width="30" src="image/src/qr/body/pointed-in-smooth.png" />
 &nbsp;&nbsp;pointed-in-smooth
 
 <img width="30" src="image/src/qr/body/pointed-smooth.png" />
 &nbsp;&nbsp;pointed-smooth
 
 <img width="30" src="image/src/qr/body/round.png" />
 &nbsp;&nbsp;round
 
 <img width="30" src="image/src/qr/body/rounded-in.png" />
 &nbsp;&nbsp;rounded-in
 
 <img width="30" src="image/src/qr/body/rounded-in-smooth.png" />
 &nbsp;&nbsp;rounded-in-smooth
 
 <img width="30" src="image/src/qr/body/rounded-pointed.png" />
 &nbsp;&nbsp;rounded-pointed
 
 <img width="30" src="image/src/qr/body/star.png" />
 &nbsp;&nbsp;star
 
 <img width="30" src="image/src/qr/body/diamond.png" />
 &nbsp;&nbsp;diamond
 
 </td>
 </tr>
 <tr>
 <td>eye</td>
 <td>String</td>
 <td>frame0</td>
 <td>
 
 <img width="30" src="image/src/qr/eye-frames/frame0.png" />
 &nbsp;&nbsp;frame0
 
 <img width="30" src="image/src/qr/eye-frames/frame1.png" />
 &nbsp;&nbsp;frame1
 
 <img width="30" src="image/src/qr/eye-frames/frame2.png" />
 &nbsp;&nbsp;frame2
 
 <img width="30" src="image/src/qr/eye-frames/frame3.png" />
 &nbsp;&nbsp;frame3
 
 <img width="30" src="image/src/qr/eye-frames/frame4.png" />
 &nbsp;&nbsp;frame4
 
 <img width="30" src="image/src/qr/eye-frames/frame5.png" />
 &nbsp;&nbsp;frame5
 
 <img width="30" src="image/src/qr/eye-frames/frame6.png" />
 &nbsp;&nbsp;frame6
 
 <img width="30" src="image/src/qr/eye-frames/frame7.png" />
 &nbsp;&nbsp;frame7
 
 <img width="30" src="image/src/qr/eye-frames/frame8.png" />
 &nbsp;&nbsp;frame8
 
 <img width="30" src="image/src/qr/eye-frames/frame10.png" />
 &nbsp;&nbsp;frame10
 
 <img width="30" src="image/src/qr/eye-frames/frame11.png" />
 &nbsp;&nbsp;frame11
 
 <img width="30" src="image/src/qr/eye-frames/frame12.png" />
 &nbsp;&nbsp;frame12
 
 <img width="30" src="image/src/qr/eye-frames/frame13.png" />
 &nbsp;&nbsp;frame13
 
 <img width="30" src="image/src/qr/eye-frames/frame14.png" />
 &nbsp;&nbsp;frame14
 
 <img width="30" src="image/src/qr/eye-frames/frame16.png" />
 &nbsp;&nbsp;frame16
 
 </td>
 </tr>
 <tr>
 <td>eyeBall</td>
 <td>String</td>
 <td>ball0</td>
 <td>
 
 <img width="30" src="image/src/qr/eye-balls/ball0.png" />
 &nbsp;&nbsp;ball0
 
 <img width="30" src="image/src/qr/eye-balls/ball1.png" />
 &nbsp;&nbsp;ball1
 
 <img width="30" src="image/src/qr/eye-balls/ball2.png" />
 &nbsp;&nbsp;ball2
 
 <img width="30" src="image/src/qr/eye-balls/ball3.png" />
 &nbsp;&nbsp;ball3
 
 <img width="30" src="image/src/qr/eye-balls/ball5.png" />
 &nbsp;&nbsp;ball5
 
 <img width="30" src="image/src/qr/eye-balls/ball6.png" />
 &nbsp;&nbsp;ball6
 
 <img width="30" src="image/src/qr/eye-balls/ball7.png" />
 &nbsp;&nbsp;ball7
 
 <img width="30" src="image/src/qr/eye-balls/ball8.png" />
 &nbsp;&nbsp;ball8
 
 <img width="30" src="image/src/qr/eye-balls/ball10.png" />
 &nbsp;&nbsp;ball10
 
 <img width="30" src="image/src/qr/eye-balls/ball11.png" />
 &nbsp;&nbsp;ball11
 
 <img width="30" src="image/src/qr/eye-balls/ball12.png" />
 &nbsp;&nbsp;ball12
 
 <img width="30" src="image/src/qr/eye-balls/ball13.png" />
 &nbsp;&nbsp;ball13
 
 <img width="30" src="image/src/qr/eye-balls/ball14.png" />
 &nbsp;&nbsp;ball14
 
 <img width="30" src="image/src/qr/eye-balls/ball15.png" />
 &nbsp;&nbsp;ball15
 
 <img width="30" src="image/src/qr/eye-balls/ball16.png" />
 &nbsp;&nbsp;ball16
 
 <img width="30" src="image/src/qr/eye-balls/ball17.png" />
 &nbsp;&nbsp;ball17
 
 <img width="30" src="image/src/qr/eye-balls/ball18.png" />
 &nbsp;&nbsp;ball18
 
 <img width="30" src="image/src/qr/eye-balls/ball19.png" />
 ball19
 </td>
 </tr>
 <tr>
 <td>erf1</td>
 <td>Array</td>
 <td>[ ]</td>
 <td>Rotate the upper left eye element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.</td>
 </tr>
 <tr>
 <td>erf2</td>
 <td>Array</td>
 <td>[ ]</td>
 <td>Rotate the upper right eye element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.</td>
 </tr>
 <tr>
 <td>erf3</td>
 <td>Array</td>
 <td>[ ]</td>
 <td>Rotate the lower left eye element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.</td>
 </tr>
 <tr>
 <td>brf1</td>
 <td>Array</td>
 <td>[ ]</td>
 <td>Rotate the upper left eye ball element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.</td>
 </tr>
 <tr>
 <td>brf2</td>
 <td>Array</td>
 <td>[ ]</td>
 <td>Rotate the upper right eye ball element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.</td>
 </tr>
 <tr>
 <td>brf3</td>
 <td>Array</td>
 <td>[ ]</td>
 <td>Rotate the lower left eye ball element. Add "fv" or "fh" to invert element vertically or horizontally. E.g. ["fv","fh"] inverts a element vertically and horziontally.</td>
 </tr>
 <tr>
 <td>bodyColor</td>
 <td>String</td>
 <td>#000000</td>
 <td>Color of QR code body as HEX value.</td>
 </tr>
 <tr>
 <td>bgColor</td>
 <td>String</td>
 <td>#ffffff</td>
 <td>Color of QR code background as HEX value. Note: the background should always have a lighter color to be scanable with all devices.</td>
 </tr>
 <tr>
 <td>eye1Color</td>
 <td>String</td>
 <td>#000000</td>
 <td>Color of the upper left eye as HEX value.</td>
 </tr>
 <tr>
 <td>eye2Color</td>
 <td>String</td>
 <td>#000000</td>
 <td>Color of the upper right eye as HEX value.</td>
 </tr>
 <tr>
 <td>eye3Color</td>
 <td>String</td>
 <td>#000000</td>
 <td>Color of the lower left eye as HEX value.</td>
 </tr>
 <tr>
 <td>eyeBall1Color</td>
 <td>String</td>
 <td>#000000</td>
 <td>Color of the upper left eye ball as HEX value.</td>
 </tr>
 <tr>
 <td>eyeBall2Color</td>
 <td>String</td>
 <td>#000000</td>
 <td>Color of the upper right eye ball as HEX value.</td>
 </tr>
 <tr>
 <td>eyeBall3Color</td>
 <td>String</td>
 <td>#000000</td>
 <td>Color of the lower left eye ball as HEX value.</td>
 </tr>
 <tr>
 <td>gradientColor1</td>
 <td>String</td>
 <td>null</td>
 <td>Color 1 for gradient color of body as HEX.</td>
 </tr>
 <tr>
 <td>gradientColor2</td>
 <td>String</td>
 <td>null</td>
 <td>Color 2 for gradient color of body as HEX.</td>
 </tr>
 <tr>
 <td>gradientType</td>
 <td>String</td>
 <td>linear</td>
 <td>Gradient type for color of body. Value can be "linear" or "radial".</td>
 </tr>
 <tr>
 <td>gradientOnEyes</td>
 <td>Boolean</td>
 <td>false</td>
 <td>Disable individual colors for the eye elements and set the gradient color for the complete QR code.</td>
 </tr>
 </tbody>
</table>

## Example Usage

> For details on the examples please see the file `example.php`

### First you need to initialize a QRCode instance

```php
require_once 'vendor/autoload.php';

use nguyenary\QRCodeMonkey\QRCode;

$qrcode = new QRCode('nguyenary');
```

### Example easy usage:

```php
print_r($qrcode->create());
```

The above code will return a URL containing a QR Code

### Example of saving QRCode as a file

```php
$qrcode->create('file_qrcode.png');
```

### Example for config:

```php
$qrcode = new QRCode('nguyenary');

$qrcode->setConfig([
    'bgColor' => '#FFFFFF',
    'body' => 'square',
    'bodyColor' => '#0277bd',
    'brf1' => [],
    'brf2' => [],
    'brf3' => [],
    'erf1' => [],
    'erf2' => [],
    'erf3' => [],
    'eye' => 'frame0',
    'eye1Color' => '#000000',
    'eye2Color' => '#000000',
    'eye3Color' => '#000000',
    'eyeBall' => 'ball0',
    'eyeBall1Color' => '#000000',
    'eyeBall2Color' => '#000000',
    'eyeBall3Color' => '#000000',
    'gradientColor1' => '#0277bd',
    'gradientColor2' => '#000000',
    'gradientOnEyes' => 'true',
    'gradientType' => 'linear',
]);
```

### Example for set logo, file type and size

```php
// Set logo path file to use
$qrcode->setLogo('image/facebook.png');

// Support png, svg, jpg, pdf, eps
$qrcode->setFileType('png');

// Size limit is 3480 pixel
$qrcode->setSize(200);
```

## Features

What's all the bells and whistles this project can perform?
- High quality images for printing
- Generate QRCode completely for free
- Many QRCode templates can be customized
- Can be exported as a URL or saved as a file
- Output format options (Support `png`, `svg`, `jpg`, `pdf`, `eps`)

✋ **NOTE:** Format `pdf` and `eps` no support for color gradients

## Contributing

This is a project I do in my spare time to contribute to the community. I would very much welcome if you would like to contribute to this project

## Licensing

The code in this project is licensed under MIT license

QRCodeMonkey

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

QRCodeMonkey

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README