├── .gitignore
├── .travis.yml
├── src
    ├── Exceptions
    │   ├── EmptyTextException.php
    │   └── MalformedUrlException.php
    ├── Facades
    │   └── QRCode.php
    ├── Providers
    │   └── QRCodeServiceProvider.php
    └── QRCodeFactory.php
├── docs
    ├── .sass-cache
    │   └── 441d4a9fb29c4706d6f17735c2df4713963ec2fb
    │   │   ├── normalize.scssc
    │   │   ├── variables.scssc
    │   │   ├── rouge-github.scssc
    │   │   └── jekyll-theme-cayman.scssc
    ├── _config.yml
    ├── text.md
    ├── me-card.md
    ├── url.md
    ├── phone.md
    ├── sms.md
    ├── email.md
    ├── wi-fi.md
    ├── calendar.md
    ├── index.md
    ├── v-card.md
    └── _layouts
    │   └── default.html
├── Gemfile
├── CONTRIBUTING.md
├── SECURITY.md
├── .github
    └── ISSUE_TEMPLATE
    │   ├── feature_request.md
    │   └── bug_report.yaml
├── composer.json
├── LICENSE.md
├── README.md
└── CODE_OF_CONDUCT.md


/.gitignore:
--------------------------------------------------------------------------------
1 | _site/
2 | .idea/
3 | vendor/
4 | composer.lock
5 | Gemfile.lock


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: php
2 | php:
3 |  - '7.1'
4 | install: composer install


--------------------------------------------------------------------------------
/src/Exceptions/EmptyTextException.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace LaravelQRCode\Exceptions;
4 | 
5 | class EmptyTextException extends \Exception
6 | {
7 | 
8 | }


--------------------------------------------------------------------------------
/src/Exceptions/MalformedUrlException.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace LaravelQRCode\Exceptions;
4 | 
5 | class MalformedUrlException extends \Exception
6 | {
7 | 
8 | }


--------------------------------------------------------------------------------
/docs/.sass-cache/441d4a9fb29c4706d6f17735c2df4713963ec2fb/normalize.scssc:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/giauphan/laravel-qr-code/HEAD/docs/.sass-cache/441d4a9fb29c4706d6f17735c2df4713963ec2fb/normalize.scssc


--------------------------------------------------------------------------------
/docs/.sass-cache/441d4a9fb29c4706d6f17735c2df4713963ec2fb/variables.scssc:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/giauphan/laravel-qr-code/HEAD/docs/.sass-cache/441d4a9fb29c4706d6f17735c2df4713963ec2fb/variables.scssc


--------------------------------------------------------------------------------
/docs/.sass-cache/441d4a9fb29c4706d6f17735c2df4713963ec2fb/rouge-github.scssc:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/giauphan/laravel-qr-code/HEAD/docs/.sass-cache/441d4a9fb29c4706d6f17735c2df4713963ec2fb/rouge-github.scssc


--------------------------------------------------------------------------------
/docs/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-cayman
2 | repository: werneckbh/laravel-qr-code
3 | title: Laravel QR Code Generator
4 | description: A QR Code Generator for PHP wrapper for Laravel
5 | show_downloads: true


--------------------------------------------------------------------------------
/docs/.sass-cache/441d4a9fb29c4706d6f17735c2df4713963ec2fb/jekyll-theme-cayman.scssc:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/giauphan/laravel-qr-code/HEAD/docs/.sass-cache/441d4a9fb29c4706d6f17735c2df4713963ec2fb/jekyll-theme-cayman.scssc


--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source 'https://rubygems.org'
2 | 
3 | gem 'wdm', '>= 0.1.0' if Gem.win_platform?
4 | 
5 | if Gem.win_platform?
6 |   gem 'github-pages', '170', group: :jekyll_plugins
7 | else
8 |   gem 'github-pages', group: :jekyll_plugins
9 | end


--------------------------------------------------------------------------------
/docs/text.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> Text
 2 | 
 3 | ---
 4 | # Text
 5 | 
 6 | ```php
 7 | <?php
 8 | Route::get('qr-code/examples/text', function () 
 9 | {
10 |     return  QRCode::text('Laravel QR Code Generator!')->png();   
11 | });    
12 | ```


--------------------------------------------------------------------------------
/docs/me-card.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> meCard
 2 | 
 3 | ---
 4 | # meCard
 5 | 
 6 | ```php
 7 | <?php
 8 | Route::get('qr-code/examples/me-card', function () 
 9 | {
10 |     return QRCode::meCard('John Doe', '1234 Main st.', '+1 001 555-1234', 'john.doe@example.com')->svg();
11 | });    
12 | ```


--------------------------------------------------------------------------------
/docs/url.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> URL
 2 | 
 3 | ---
 4 | # URL
 5 | 
 6 | ```php
 7 | <?php
 8 | Route::get('qr-code/examples/url', function () 
 9 | {
10 |     return  QRCode::url('werneckbh.github.io/qr-code/')
11 |                   ->setSize(8)
12 |                   ->setMargin(2)
13 |                   ->png();
14 | });    
15 | ```


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 |  To contribute to this project, please do the following:
 2 |  
 3 |   - Fork it
 4 |   - Create a new branch for your contribution
 5 |   - Test it! Make sure it works and it won't break the master code
 6 |   - Send pull request
 7 |   
 8 |   Contributors will be added to package descriptor
 9 |   
10 |   Make sure you abide to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md)


--------------------------------------------------------------------------------
/docs/phone.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> Phone
 2 | 
 3 | ---
 4 | # Phone
 5 | 
 6 | ```php
 7 | <?php
 8 | Route::get('qr-code/examples/phone', function () 
 9 | {
10 |     return QRCode::phone('+55 31 1234-5678')
11 |                          ->setSize(4)
12 |                          ->setMargin(2)
13 |                          ->png();     
14 | });    
15 | ```


--------------------------------------------------------------------------------
/docs/sms.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> SMS
 2 | 
 3 | ---
 4 | # SMS
 5 | 
 6 | ```php
 7 | <?php
 8 | Route::get('qr-code/examples/sms', function () 
 9 | {
10 |     return QRCode::sms('+55 (31) 1234-5678', 'Text to send!')
11 |                          ->setSize(4)
12 |                          ->setMargin(2)
13 |                          ->png();     
14 | });    
15 | ```


--------------------------------------------------------------------------------
/docs/email.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> Email Message
 2 | 
 3 | ---
 4 | # Email Message
 5 | 
 6 | ```php
 7 | <?php
 8 | 
 9 | Route::get('qr-code/examples/email', function () 
10 | {
11 |       
12 |     $to = 'john.doe@example.com';
13 |     $subject = 'QR Code Message';
14 |     $body = 'This email was created from a QR Code!';
15 |   
16 |     return QRCode::email($to, $body, $subject)->png();
17 |       
18 | });    
19 | ```


--------------------------------------------------------------------------------
/src/Facades/QRCode.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace LaravelQRCode\Facades;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | /**
 8 |  * Class QRCode
 9 |  *
10 |  * Laravel QR Code Generator is distributed under MIT
11 |  * Copyright (C) 2018 Bruno Vaula Werneck <brunovaulawerneck at gmail dot com>
12 |  *
13 |  * @package LaravelQRCode\Facades
14 |  */
15 | class QRCode extends Facade
16 | {
17 |     protected static function getFacadeAccessor() {
18 |         return 'qr-code';
19 |     }
20 | }


--------------------------------------------------------------------------------
/docs/wi-fi.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> Wi-fi Network Settings
 2 | 
 3 | ---
 4 | # Wi-fi Network Settings
 5 | 
 6 | ```php
 7 | <?php
 8 | Route::get('qr-code/examples/wifi', function () 
 9 | {
10 |     $authenticationType = "WPA2";
11 |     $ssId = "MySuperSSID";
12 |     $ssIdisHidden = false;
13 |     $password = "Y0uC4n7f1nd7h3p4ssw0rd";
14 |   
15 |     return QRCode::wifi($authenticationType, $ssId, $password, $ssIdisHidden)
16 |               ->setOutfile('images/my-wifi.png')
17 |               ->png();
18 | });    
19 | ```


--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
 1 | # Security Policy
 2 | 
 3 | ## Supported Versions
 4 | 
 5 | Use this section to tell people about which versions of your project are
 6 | currently being supported with security updates.
 7 | 
 8 | | Version | Supported          |
 9 | | ------- | ------------------ |
10 | | 1.x   | :white_check_mark: |
11 | 
12 | ## Reporting a Vulnerability
13 | 
14 | Use this section to tell people how to report a vulnerability.
15 | 
16 | Tell them where to go, how often they can expect to get an update on a
17 | reported vulnerability, what to expect if the vulnerability is accepted or
18 | declined, etc.
19 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 | 
13 | **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 | 
16 | **Describe alternatives you've considered**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 | 
19 | **Additional context**
20 | Add any other context or screenshots about the feature request here.
21 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "giauphan/laravel-qr-code",
 3 |     "description": "QR Code Generator for PHP wrapper for Laravel",
 4 |     "license": "MIT",
 5 |     "authors": [
 6 |         {
 7 |             "name": "Phan Nhut Giau",
 8 |             "email": "giauphan012@gmail.com"
 9 |         }
10 |     ],
11 |     "minimum-stability": "dev",
12 |     "require": {
13 |         "giauphan/qr-code":"1.0.2"
14 |     },
15 |     "autoload": {
16 |         "psr-4": {
17 |             "LaravelQRCode\\": "src/"
18 |         }
19 |     },
20 |     "extra": {
21 |         "laravel": {
22 |             "providers": [
23 |                 "LaravelQRCode\\Providers\\QRCodeServiceProvider"
24 |             ],
25 |             "aliases": {
26 |                 "QRCode": "LaravelQRCode\\Facades\\QRCode"
27 |             }
28 |         }
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/docs/calendar.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> Calendar Event
 2 | 
 3 | ---
 4 | # Calendar Event
 5 | 
 6 | ```php
 7 |   <?php
 8 | 
 9 |     Route::get('qr-code/examples/calendar', function () 
10 |     {
11 |         // Required params
12 |         $start = new \DateTime('next saturday 7pm');
13 |         $end = new \DateTime('next saturday 11pm');        
14 |         $summary = 'Interview with Neil DeGrasse Tyson';
15 |         
16 |         // Optional params
17 |         $description = 'Meet Mr. Tyson at Per Se and interview him about the asteroid Apophis';
18 |         $location = 'Time Warner Center, 10 Columbus Cir, New York, NY 10023, USA';
19 |         
20 |         return QRCode::calendar($start, $end, $summary, $description, $location)->svg();
21 |     });    
22 |   ```
23 |   
24 |   


--------------------------------------------------------------------------------
/src/Providers/QRCodeServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace LaravelQRCode\Providers;
 4 | 
 5 | use Illuminate\Support\ServiceProvider;
 6 | use LaravelQRCode\QRCodeFactory;
 7 | 
 8 | /**
 9 |  * Class QRCodeServiceProvider
10 |  *
11 |  * Laravel QR Code Generator is distributed under MIT
12 |  * Copyright (C) 2018 Bruno Vaula Werneck <brunovaulawerneck at gmail dot com>
13 |  *
14 |  * @package LaravelQRCode\Providers
15 |  */
16 | class QRCodeServiceProvider extends ServiceProvider
17 | {
18 |     /**
19 |      * Bootstrap the application services.
20 |      *
21 |      * @return void
22 |      */
23 |     public function boot()
24 |     {
25 |         //
26 |     }
27 | 
28 |     /**
29 |      * Register the application services.
30 |      *
31 |      * @return void
32 |      */
33 |     public function register()
34 |     {
35 |         $this->app->bind('qr-code', function () {
36 |             return new QRCodeFactory();
37 |         });
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | **(MIT)**
 2 | 
 3 | Copyright 2023 Giauphan
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 6 | 
 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 8 | 
 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Laravel QR Code Generator
 2 | 
 3 |  Create QR Codes with Laravel
 4 | 
 5 |  This is a wrapper for [QR Code Generator for PHP], a standalone library to generate QR Codes in PNG and SVG.
 6 | 
 7 | ## Installation
 8 | 
 9 |  Install using **composer**:
10 | 
11 |  ```bash
12 | composer require giauphan/laravel-qr-code:v1.0.3
13 |  ```
14 | ##### Laravel 5.4 (5.5+ can skip this step)
15 |  
16 |  You need to add provider and alias to your `config/app.php` file:
17 |  
18 |  ```php
19 |  <?php
20 |  
21 |  'providers' => [     
22 |        
23 |      LaravelQRCode\Providers\QRCodeServiceProvider::class,     
24 |    
25 |  ],
26 | 
27 |  
28 |  'aliases' => [
29 |     
30 |     'QRCode' => LaravelQRCode\Facades\QRCode::class,     
31 |        
32 |  ] 
33 |  ```
34 | ## QR Code Types
35 | 
36 |  Laravel QR Code Generator supports the following QR Codes:
37 | 
38 |   - Calendar Event
39 |   - Email Message
40 |   - Phone
41 |   - SMS
42 |   - Text
43 |   - URL
44 |   - meCard
45 |   - vCard v3
46 |   - Wi-fi Network Settings
47 |   
48 | ## Usage
49 |     
50 |   ```php
51 |   <?php
52 |   
53 |   Route::get('qr-code', function () {
54 |     $path = public_path().'/qr-code.png';
55 |     $filename = '/qr-code.png';
56 |     QRCode::text('QR Code Generator for Laravel!')
57 |         ->setOutfile($path )
58 |         ->png();
59 |     return '<img src=' . $filename . '>';
60 |   });
61 |   
62 |   ```
63 |   The above route should print a PNG image for a text QR Code.
64 |   
65 |    
66 | ## [Contributing](CONTRIBUTING.md)
67 |  
68 |  To contribute to this project, please do the following:
69 |  
70 |   - Fork it
71 |   - Create a new branch for your contribution
72 |   - Test it! Make sure it works and it won't break the master code
73 |   - Send pull request
74 | 
75 |   
76 | 
77 | 


--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
 1 | # Laravel QR Code Generator
 2 | 
 3 | Create QR Codes with Laravel
 4 | 
 5 | This is a wrapper for [QR Code Generator for PHP](https://giauphan.github.io/qr-code), a standalone library to generate QR Codes in PNG and SVG.
 6 | 
 7 | ## Installation
 8 | 
 9 | Install using **composer**:
10 | 
11 | ```bash
12 | $ composer require giauphan/laravel-qr-code
13 | ```
14 | ##### Laravel 5.4 (5.5+ can skip this step)
15 | 
16 | You need to add provider and alias to your `config/app.php` file:
17 |  
18 | ```php
19 | <?php
20 | 
21 | 'providers' => [     
22 |    
23 |  LaravelQRCode\Providers\QRCodeServiceProvider::class,     
24 | 
25 | ],
26 | 
27 | 
28 | 'aliases' => [
29 | 
30 | 'QRCode' => LaravelQRCode\Facades\QRCode::class,     
31 |    
32 | ] 
33 | ```
34 | ## <a id='code-types'></a>QR Code Types
35 | 
36 | Laravel QR Code Generator supports the following QR Codes:
37 | 
38 | - [Calendar Event](calendar.md)  
39 | - [Email Message](email.md)  
40 | - [Phone](phone.md)
41 | - [SMS](sms.md)
42 | - [Text](text.md)
43 | - [URL](url.md)
44 | - [meCard](me-card.md)
45 | - [vCard v3](v-card.md)
46 | - [Wi-fi Network Settings](wi-fi.md)
47 | 
48 | ### Common Options
49 | 
50 | These options are available to any of the QR Code types above.
51 | 
52 | Option | Return value | Expected Values
53 | -------|:-------------|:---------------
54 | `setErrorCorrectionLevel($level)`|$this|'L','M','Q' or 'H'
55 | `setSize(4)`|$this| Pixel size. 1 to 10
56 | `setMargin(3)`|$this| 1 to 10
57 | `setOutfile($file)`|$this|file path (public) and name.ext to save QR Code
58 | `png()`| |stream (or save if outfile is set) QR Code as a PNG image
59 | `svg()`| |stream (or save if outfile is set) QR Code as an SVG image
60 | 
61 | ## Notes
62 | 
63 | - If you set an outfile, you **MUST make sure the path exists**.  
64 | Don't forget to **set filename extension** according to your output (.png or .svg).
65 | - Since SVGs are scalable, use them to make complex QR Codes such as [Calendar Events](calendar.md), [meCards](me-card.md) and [vCards](v-card.md)


--------------------------------------------------------------------------------
/docs/v-card.md:
--------------------------------------------------------------------------------
 1 | > [Laravel QR Code Generator](index.md) >> [QR Code Types](index.md#code-types) >> vCard v3
 2 | 
 3 | ---
 4 | # vCard v3
 5 | 
 6 | ```php
 7 | <?php
 8 | 
 9 | Route::get('qr-code/examples/v-card', function () 
10 | {
11 |     // Personal Information
12 |     $firstName = 'John';
13 |     $lastName = 'Doe';
14 |     $title = 'Mr.';
15 |     $email = 'john.doe@example.com';
16 | 
17 |     $company = "Acme Inc.";
18 |     $job = "Developer";
19 |     $url = "https://example.com";
20 |     
21 |     // Addresses
22 |     $homeAddress = [
23 |         'type' => 'home',
24 |         'pref' => true,
25 |         'street' => '123 my street st',
26 |         'city' => 'My Beautiful Town',
27 |         'state' => 'LV',
28 |         'country' => 'Neverland',
29 |         'zip' => '12345-678'
30 |     ];
31 |     $wordAddress = [
32 |        'type' => 'work',
33 |        'pref' => false,
34 |        'street' => '123 my work street st',
35 |        'city' => 'My Dreadful Town',
36 |        'state' => 'LV',
37 |        'country' => 'Hell',
38 |        'zip' => '12345-678'
39 |     ];
40 |     
41 |     $addresses = [$homeAddress, $wordAddress];
42 |     
43 |     // Phones
44 |     $workPhone = [
45 |         'type' => 'work',
46 |         'number' => '001 555-1234',
47 |         'cellPhone' => false
48 |     ];
49 |     $homePhone = [
50 |         'type' => 'home',
51 |         'number' => '001 555-4321',
52 |         'cellPhone' => false
53 |     ];
54 |     $cellPhone = [
55 |         'type' => 'work',
56 |         'number' => '001 9999-8888',
57 |         'cellPhone' => true
58 |     ];
59 |     
60 |     $phones = [$workPhone, $homePhone, $cellPhone];
61 |     
62 |     return QRCode::vCard($firstName, $lastName, $title, $email, $company, $job, $url, $addresses, $phones)
63 |                 ->setErrorCorrectionLevel('H')
64 |                 ->setSize(4)
65 |                 ->setMargin(2)
66 |                 ->svg();
67 | });
68 | ```
69 | 
70 | ### Notes
71 | 
72 |  - You can have only one preferential address
73 |  - Error Correction Level is set to H(igh) because there is a lot of information
74 |  - Try using SVG when encoding complex information, since you can re-scale the image file at will without loss of quality
75 | 


--------------------------------------------------------------------------------
/docs/_layouts/default.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="{{ site.lang | default: "en-US" }}">
 3 | <head>
 4 |     <meta charset="UTF-8">
 5 | 
 6 |     {% seo %}
 7 |     <meta name="viewport" content="width=device-width, initial-scale=1">
 8 |     <meta name="theme-color" content="#157878">
 9 |     <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
10 |     <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
11 | </head>
12 | <body>
13 | <section class="page-header">
14 |     <h1 class="project-name">{{ site.title | default: site.github.repository_name }}</h1>
15 |     <h2 class="project-tagline">{{ site.description | default: site.github.project_tagline }}</h2>
16 |     {% if site.github.is_project_page %}
17 |     <a href="{{ site.github.repository_url }}" class="btn">View on GitHub</a>
18 |     {% endif %}
19 |     {% if site.show_downloads %}
20 |     <a href="{{ site.github.zip_url }}" class="btn">Download .zip</a>
21 |     <a href="{{ site.github.tar_url }}" class="btn">Download .tar.gz</a>
22 |     {% endif %}
23 | </section>
24 | 
25 | <section class="main-content">
26 |     {{ content }}
27 | 
28 |     <footer class="site-footer">
29 |         {% if site.github.is_project_page %}
30 |         <span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
31 |         {% endif %}
32 |         <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
33 |     </footer>
34 | </section>
35 | 
36 | {% if site.google_analytics %}
37 | <script type="text/javascript">
38 |     (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
39 |         (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
40 |         m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
41 |     })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
42 | 
43 |     ga('create', '{{ site.google_analytics }}', 'auto');
44 |     ga('send', 'pageview');
45 | </script>
46 | {% endif %}
47 | </body>
48 | </html>


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.yaml:
--------------------------------------------------------------------------------
 1 | name: Bug Report
 2 | description: Report an issue or unexpected behavior
 3 | labels: [bug, unconfirmed, medium priority]
 4 | projects: ['laravel-qr-code']
 5 | body:
 6 |   - type: markdown
 7 |     attributes:
 8 |       value: |
 9 |         **Before opening a bug report, please search the existing issues (both open and closed).**
10 | 
11 |         ---
12 |         
13 |         Thank you for reporting a bug! To help us resolve this issue quickly, please provide the following details.
14 | 
15 |   - type: input
16 |     id: package-version
17 |     attributes:
18 |       label: Package Version
19 |       description: Specify the version of the package you are using.
20 |       placeholder: e.g., v3.0.0
21 |     validations:
22 |       required: true
23 |   - type: input
24 |     id: laravel-version
25 |     attributes:
26 |       label: Laravel Version
27 |       description: Provide the Laravel version used in your project.
28 |       placeholder: e.g., v10.0.0
29 |     validations:
30 |       required: true
31 |   - type: input
32 |     id: php-version
33 |     attributes:
34 |       label: PHP Version
35 |       description: Specify the PHP version your server is running.
36 |       placeholder: e.g., PHP 8.3.0
37 |     validations:
38 |       required: true
39 |   - type: textarea
40 |     id: description
41 |     attributes:
42 |       label: Problem Description
43 |       description: Describe the issue you encountered in detail.
44 |     validations:
45 |       required: true
46 |   - type: textarea
47 |     id: expectation
48 |     attributes:
49 |       label: Expected Behavior
50 |       description: Explain what you expected to happen instead of the problem.
51 |     validations:
52 |       required: true
53 |   - type: textarea
54 |     id: steps
55 |     attributes:
56 |       label: Steps to Reproduce
57 |       description: Provide clear, step-by-step instructions to reproduce the issue. Include only the minimum required code to replicate the problem. **Issues with incomplete replication steps will be automatically closed.**
58 |     validations:
59 |       required: true
60 |   - type: textarea
61 |     id: logs
62 |     attributes:
63 |       label: Relevant Log Output
64 |       description: Include relevant log entries if applicable (no backticks needed).
65 |       render: shell
66 | 


--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Contributor Covenant Code of Conduct
 2 | 
 3 | 
 4 | ## Our Pledge
 5 | 
 6 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
 7 | 
 8 | ## Our Standards
 9 | 
10 | Examples of behavior that contributes to creating a positive environment include:
11 | 
12 | * Using welcoming and inclusive language
13 | * Being respectful of differing viewpoints and experiences
14 | * Gracefully accepting constructive criticism
15 | * Focusing on what is best for the community
16 | * Showing empathy towards other community members
17 | 
18 | Examples of unacceptable behavior by participants include:
19 | 
20 | * The use of sexualized language or imagery and unwelcome sexual attention or advances
21 | * Trolling, insulting/derogatory comments, and personal or political attacks
22 | * Public or private harassment
23 | * Publishing others' private information, such as a physical or electronic address, without explicit permission
24 | * Other conduct which could reasonably be considered inappropriate in a professional setting
25 | 
26 | ## Our Responsibilities
27 | 
28 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
29 | 
30 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
31 | 
32 | ## Scope
33 | 
34 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
35 | 
36 | ## Enforcement
37 | 
38 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at giauphan012@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
39 | 
40 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
41 | 
42 | ## Attribution
43 | 
44 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
45 | 
46 | [homepage]: http://contributor-covenant.org
47 | [version]: http://contributor-covenant.org/version/1/4/
48 | 


--------------------------------------------------------------------------------
/src/QRCodeFactory.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace LaravelQRCode;
  4 | 
  5 | use LaravelQRCode\Exceptions\EmptyTextException;
  6 | use LaravelQRCode\Exceptions\MalformedUrlException;
  7 | use QR_Code\Exceptions\InvalidVCardAddressEntryException;
  8 | use QR_Code\Exceptions\InvalidVCardPhoneEntryException;
  9 | use QR_Code\Types\QR_CalendarEvent;
 10 | use QR_Code\Types\QR_EmailMessage;
 11 | use QR_Code\Types\QR_meCard;
 12 | use QR_Code\Types\QR_Phone;
 13 | use QR_Code\Types\QR_Sms;
 14 | use QR_Code\Types\QR_Text;
 15 | use QR_Code\Types\QR_Url;
 16 | use QR_Code\Types\QR_VCard;
 17 | use QR_Code\Types\QR_WiFi;
 18 | use QR_Code\Types\vCard\Address;
 19 | use QR_Code\Types\vCard\Person;
 20 | use QR_Code\Types\vCard\Phone;
 21 | 
 22 | /**
 23 |  * Class QRCodeFactory
 24 |  *
 25 |  * Laravel QR Code Generator is distributed under MIT
 26 |  * Copyright (C) 2018 Bruno Vaula Werneck <brunovaulawerneck at gmail dot com>
 27 |  *
 28 |  * @package Werneckbh\QRCodeFactory
 29 |  */
 30 | class QRCodeFactory
 31 | {
 32 |     /**
 33 |      * Returns as QR_CalendarEvent object
 34 |      *
 35 |      * @param \DateTime $start
 36 |      * @param \DateTime $end
 37 |      * @param string    $summary
 38 |      * @param string    $description
 39 |      * @param string    $location
 40 |      *
 41 |      * @return \QR_Code\Types\QR_CalendarEvent
 42 |      * @throws \QR_Code\Exceptions\EmptyEventSummaryException
 43 |      * @throws \QR_Code\Exceptions\InvalidEventDateException
 44 |      */
 45 |     public function calendar(\DateTime $start, \DateTime $end, string $summary, string $description, string $location): QR_CalendarEvent
 46 |     {
 47 |         return new QR_CalendarEvent($start, $end, $summary, $description, $location);
 48 |     }
 49 | 
 50 |     /**
 51 |      * Returns a QR_EmailMessage object
 52 |      *
 53 |      * @param string $toEmail
 54 |      * @param string $body
 55 |      * @param string $subject
 56 |      *
 57 |      * @return \QR_Code\Types\QR_EmailMessage
 58 |      * @throws \LaravelQRCode\Exceptions\EmptyTextException
 59 |      */
 60 |     public function email(string $toEmail, string $body, string $subject): QR_EmailMessage
 61 |     {
 62 |         if (trim($toEmail) === null) {
 63 |             throw new EmptyTextException('Recipient email cannot be empty');
 64 |         }
 65 | 
 66 |         return new QR_EmailMessage($toEmail, $body, $subject);
 67 |     }
 68 | 
 69 |     /**
 70 |      * Returns a QR_meCard object
 71 |      *
 72 |      * @param string $name
 73 |      * @param string $address
 74 |      * @param string $phone
 75 |      * @param string $email
 76 |      * 
 77 |      *
 78 |      * @return \QR_Code\Types\QR_meCard
 79 |      */
 80 |     public function meCard(string $name, string $address, string $phone, string $email): QR_meCard
 81 |     {
 82 |         return new QR_meCard($name, $address, $phone, $email);
 83 |     }
 84 | 
 85 |     /**
 86 |      * Returns a QR_Phone object
 87 |      *
 88 |      * @param string $number
 89 |      *
 90 |      * @return \QR_Code\Types\QR_Phone
 91 |      */
 92 |     public function phone(string $number): QR_Phone
 93 |     {
 94 |         return new QR_Phone($number);
 95 |     }
 96 | 
 97 |     /**
 98 |      * Return a QR_Sms object
 99 |      *
100 |      * @param string $number
101 |      * @param string $text
102 |      *
103 |      * @return \QR_Code\Types\QR_Sms
104 |      */
105 |     public function sms(string $number, string $text): QR_Sms
106 |     {
107 |         return new QR_Sms($number, $text);
108 |     }
109 | 
110 |     /**
111 |      * Returns a QR_Text object
112 |      *
113 |      * @param string $data
114 |      *
115 |      * @return \QR_Code\Types\QR_Text
116 |      * @throws \LaravelQRCode\Exceptions\EmptyTextException
117 |      */
118 |     public function text(string $data): QR_Text
119 |     {
120 |         if (trim($data) === null) {
121 |             throw new EmptyTextException('Text cannot be empty');
122 |         }
123 | 
124 |         return new QR_Text($data);
125 |     }
126 | 
127 |     /**
128 |      * Returns a QR_Url object
129 |      *
130 |      * @param string $url
131 |      *
132 |      * @return \QR_Code\Types\QR_Url
133 |      * @throws \LaravelQRCode\Exceptions\EmptyTextException
134 |      * @throws \LaravelQRCode\Exceptions\MalformedUrlException
135 |      */
136 |     public function url(string $url = null): QR_Url
137 |     {
138 |         // if (trim($url) === null) {
139 |         //     throw new EmptyTextException('Url cannot be empty');
140 |         // }
141 | 
142 |         // if (startsWith($url, 'http://')) {
143 |         //     throw new MalformedUrlException('Url cannot start with http://');
144 |         // }
145 | 
146 |         // if (startswith($url, 'https://')) {
147 |         //     throw new MalformedUrlException('Url cannot start with https://');
148 |         // }
149 | 
150 |         return new QR_Url($url);
151 |     }
152 | 
153 |     /**
154 |      * Returns a QR_VCard object
155 |      *
156 |      * @param string $firstName
157 |      * @param string $lastName
158 |      * @param string $title Miss, Mrs., Mr., Doctor, etc
159 |      * @param string $email
160 |      * @param string $company
161 |      * @param string $job
162 |      * @param string $url
163 |      * @param array  $addresses
164 |      * @param array  $phones
165 |      * 
166 |      * @return \QR_Code\Types\QR_VCard
167 |      * @throws \QR_Code\Exceptions\InvalidVCardAddressEntryException
168 |      * @throws \QR_Code\Exceptions\InvalidVCardPhoneEntryException
169 |      */
170 |     public function vCard(string $firstName  = null, string $lastName  = null, string $title = null, string $email = null, string $company = null,string $job = null,string $url = null, array $addresses = [], array $phones = []): QR_VCard
171 |     {
172 |         // $this->validateVCardAddresses($addresses);
173 |         // $this->validatePrefAddresses($addresses);
174 |         $this->validateVCardPhones($phones);
175 | 
176 |         $person = new Person($firstName, $lastName, $title, $email, $company);
177 |         $person->setURL($url);
178 |         $person->setJob($job);
179 | 
180 |         $addressesArray = [];
181 |         foreach ($addresses as $address) {
182 |             $addressesArray[] = new Address(
183 |                 strtoupper($address['type']),
184 |                 $address['pref'] === true,
185 |                 $address['street'],
186 |                 $address['city'],
187 |                 $address['state'],
188 |                 $address['zip'],
189 |                 $address['country']
190 |             );
191 |         }
192 | 
193 |         $phonesArray = [];
194 |         foreach ($phones as $phone) {
195 |             $phonesArray[] = new Phone(strtoupper($phone['type']), $phone['number'], $phone['cellPhone']);
196 |         }
197 | 
198 |         return new QR_VCard($person, $phonesArray, $addressesArray);
199 |     }
200 |     /**
201 |      * Returns a QR_WiFi object
202 |      *
203 |      * @param string $authType
204 |      * @param string $ssId
205 |      * @param string $password
206 |      * @param bool   $ssdIDisHidden
207 |      *
208 |      * @return \QR_Code\Types\QR_WiFi
209 |      */
210 |     public function wifi(string $authType, string $ssId, string $password, bool $ssdIDisHidden): QR_WiFi
211 |     {
212 |         return new QR_WiFi($authType, $ssId, $password, $ssdIDisHidden);
213 |     }
214 | 
215 |     /**
216 |      * Validates vCard Addresses
217 |      *
218 |      * @param array $addresses
219 |      *
220 |      * @throws \QR_Code\Exceptions\InvalidVCardAddressEntryException
221 |      */
222 |     protected function validateVCardAddresses(array $addresses): void
223 |     {
224 |         $requiredKeys = ['type', 'pref', 'street', 'city', 'state', 'zip', 'country'];
225 | 
226 |         foreach ($addresses as $address) {
227 |             $keys = array_keys($address);
228 |             foreach ($keys as $key) {
229 |                 if (!in_array($key, $requiredKeys)) {
230 |                     throw new InvalidVCardAddressEntryException('Address requires ' . $key . ' key');
231 |                 }
232 |             }
233 |         }
234 |     }
235 | 
236 |     /**
237 |      * Validates preferential addresses
238 |      *
239 |      * @param array $addresses
240 |      *
241 |      * @throws \QR_Code\Exceptions\InvalidVCardAddressEntryException
242 |      */
243 |     protected function validatePrefAddresses(array $addresses): void
244 |     {
245 |         $preferentialAddressCount = 0;
246 | 
247 |         foreach ($addresses as $address) {
248 |             if ($address['pref'] === true) {
249 |                 $preferentialAddressCount++;
250 |             }
251 |         }
252 | 
253 |         if ($preferentialAddressCount > 1) {
254 |             throw new InvalidVCardAddressEntryException(
255 |                 "You can only have one preferential address.\nPreferential Addresses found: {$preferentialAddressCount}"
256 |             );
257 |         }
258 |     }
259 | 
260 |     /**
261 |      * Validates vCard Phones
262 |      *
263 |      * @param array $phones
264 |      *
265 |      * @throws \QR_Code\Exceptions\InvalidVCardPhoneEntryException
266 |      */
267 |     protected function validateVCardPhones(array $phones): void
268 |     {
269 |         $requiredKeys = ['type', 'number', 'cellPhone'];
270 |         foreach ($phones as $phone) {
271 |             $keys = array_keys($phone);
272 |             foreach ($keys as $key) {
273 | 
274 |                 if (!in_array($key, $requiredKeys)) {
275 |                     throw new InvalidVCardPhoneEntryException('Phone requires ' . $key . ' key');
276 |                 }
277 | 
278 |                 if ($key === 'cellPhone' && !is_bool($phone['cellPhone'])) {
279 |                     throw new InvalidVCardPhoneEntryException('Cellphone key must be boolean');
280 |                 }
281 |             }
282 |         }
283 |     }
284 | }
285 | 


--------------------------------------------------------------------------------