├── .editorconfig
├── .github
    ├── CODEOWNERS
    ├── ISSUE_TEMPLATE
    │   ├── Bug Report.yml
    │   ├── Feature Request.yml
    │   └── config.yml
    └── workflows
    │   ├── cron_snyk.yml
    │   ├── pr_await_changes.yml
    │   ├── pr_composer.yml
    │   ├── pr_pest.yml
    │   ├── pr_phpcsf.yml
    │   ├── pr_phpstan.yml
    │   ├── pr_psalm.yml
    │   ├── pr_rector.yml
    │   ├── pr_snyk.yml
    │   └── semgrep.yml
├── .gitignore
├── LICENSE
├── README.md
└── app
    ├── .editorconfig
    ├── .env.example
    ├── .php-cs-fixer.dist.php
    ├── .phpcs.xml.dist
    ├── README.md
    ├── composer.json
    ├── phpstan.neon.dist
    ├── phpunit.xml
    ├── psalm.xml.dist
    ├── public
        ├── bootstrap.php
        └── index.php
    ├── rector.php
    ├── src
        ├── Application.php
        ├── ApplicationErrorHandler.php
        ├── ApplicationRouter.php
        ├── ApplicationTemplates.php
        └── Contract
        │   └── QuickstartExample.php
    ├── templates
        ├── _json.php
        ├── error.php
        ├── logged-in.php
        ├── logged-out.php
        └── spa.php
    └── tests
        ├── Feature
            └── ExampleTest.php
        ├── Pest.php
        ├── TestCase.php
        └── Unit
            └── ExampleTest.php


/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | charset = utf-8
 5 | end_of_line = lf
 6 | trim_trailing_whitespace = true
 7 | insert_final_newline = true
 8 | 
 9 | # We use 4 space indentation for PHP
10 | [*.php]
11 | indent_style = space
12 | indent_size = 4
13 | 


--------------------------------------------------------------------------------
/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | *	@auth0-samples/dx-sdks-engineer
2 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/Bug Report.yml:
--------------------------------------------------------------------------------
 1 | name: 🐞 Report a bug
 2 | description: Have you found a bug or issue? Create a bug report for this sample
 3 | 
 4 | body:
 5 |   - type: markdown
 6 |     attributes:
 7 |       value: |
 8 |         **Please do not report security vulnerabilities here**. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.
 9 | 
10 |   - type: checkboxes
11 |     id: checklist
12 |     attributes:
13 |       label: Checklist
14 |       options:
15 |         - label: I have looked into the [Readme](https://github.com/auth0-samples/auth0-php-api-samples#readme) and have not found a suitable solution or answer.
16 |           required: true
17 |         - label: I have searched the [issues](https://github.com/auth0-samples/auth0-php-api-samples/issues) and have not found a suitable solution or answer.
18 |           required: true
19 |         - label: I have searched the [Auth0 Community](https://community.auth0.com) forums and have not found a suitable solution or answer.
20 |           required: true
21 |         - label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
22 |           required: true
23 | 
24 |   - type: textarea
25 |     id: description
26 |     attributes:
27 |       label: Description
28 |       description: Provide a clear and concise description of the issue, including what you expected to happen.
29 |     validations:
30 |       required: true
31 | 
32 |   - type: textarea
33 |     id: reproduction
34 |     attributes:
35 |       label: Reproduction
36 |       description: Detail the steps taken to reproduce this error, and whether this issue can be reproduced consistently or if it is intermittent.
37 |       placeholder: |
38 |         1. Step 1...
39 |         2. Step 2...
40 |         3. ...
41 |     validations:
42 |       required: true
43 | 
44 |   - type: textarea
45 |     id: additional-context
46 |     attributes:
47 |       label: Additional context
48 |       description: Any other relevant information you think would be useful.
49 |     validations:
50 |       required: false
51 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/Feature Request.yml:
--------------------------------------------------------------------------------
 1 | name: 🧩 Feature request
 2 | description: Suggest an idea or a feature for this sample
 3 | labels: ["feature request"]
 4 | 
 5 | body:
 6 |   - type: checkboxes
 7 |     id: checklist
 8 |     attributes:
 9 |       label: Checklist
10 |       options:
11 |         - label: I have looked into the [Readme](https://github.com/auth0-samples/auth0-php-api-samples#readme) and have not found a suitable solution or answer.
12 |           required: true
13 |         - label: I have searched the [issues](https://github.com/auth0-samples/auth0-php-api-samples/issues) and have not found a suitable solution or answer.
14 |           required: true
15 |         - label: I have searched the [Auth0 Community](https://community.auth0.com) forums and have not found a suitable solution or answer.
16 |           required: true
17 |         - label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
18 |           required: true
19 | 
20 |   - type: textarea
21 |     id: description
22 |     attributes:
23 |       label: Describe the problem you'd like to have solved
24 |       description: A clear and concise description of what the problem is.
25 |     validations:
26 |       required: true
27 | 
28 |   - type: textarea
29 |     id: ideal-solution
30 |     attributes:
31 |       label: Describe the ideal solution
32 |       description: A clear and concise description of what you want to happen.
33 |     validations:
34 |       required: true
35 | 
36 |   - type: textarea
37 |     id: alternatives-and-workarounds
38 |     attributes:
39 |       label: Alternatives and current workarounds
40 |       description: A clear and concise description of any alternatives you've considered or any workarounds that are currently in place.
41 |     validations:
42 |       required: false
43 | 
44 |   - type: textarea
45 |     id: additional-context
46 |     attributes:
47 |       label: Additional context
48 |       description: Add any other context or screenshots about the feature request here.
49 |     validations:
50 |       required: false
51 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | blank_issues_enabled: false
2 | contact_links:
3 |   - name: 🤔 Help & Questions
4 |     url: https://community.auth0.com
5 |     about: Ask general support or usage questions in the Auth0 Community forums.
6 | 


--------------------------------------------------------------------------------
/.github/workflows/cron_snyk.yml:
--------------------------------------------------------------------------------
 1 | name: "Snyk (Scheduled)"
 2 | 
 3 | # This workflow will run after a push to the main branch and as a scheduled job.
 4 | 
 5 | on:
 6 |   push:
 7 |     branches: ["master", "main"]
 8 | 
 9 | permissions: {}
10 | 
11 | defaults:
12 |   run:
13 |     working-directory: app
14 | 
15 | jobs:
16 |   snyk:
17 |     name: "Scan"
18 |     runs-on: ubuntu-latest
19 | 
20 |     steps:
21 |       - uses: shivammathur/setup-php@v2
22 |         with:
23 |           php-version: "8.1"
24 |           coverage: none
25 |           extensions: mbstring
26 |         env:
27 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
28 | 
29 |       - uses: actions/checkout@v3
30 | 
31 |       - run: composer install --no-progress
32 | 
33 |       - uses: snyk/actions/php@master
34 |         continue-on-error: true
35 |         env:
36 |           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
37 | 


--------------------------------------------------------------------------------
/.github/workflows/pr_await_changes.yml:
--------------------------------------------------------------------------------
 1 | name: "Pull Request Changes"
 2 | 
 3 | # Monitor for changes to pull requests.
 4 | 
 5 | on:
 6 |   pull_request:
 7 |     types: [opened, synchronize, reopened, closed]
 8 | 
 9 | permissions: {}
10 | 
11 | jobs:
12 |   wait:
13 |     name: "Watching"
14 |     runs-on: ubuntu-latest
15 | 
16 |     steps:
17 |       - run: echo "Child workflows triggered."
18 | 


--------------------------------------------------------------------------------
/.github/workflows/pr_composer.yml:
--------------------------------------------------------------------------------
 1 | name: "Composer"
 2 | 
 3 | on:
 4 |   pull_request:
 5 |   merge_group:
 6 |   push:
 7 |     branches: ["master", "main"]
 8 | 
 9 | permissions: {}
10 | 
11 | defaults:
12 |   run:
13 |     working-directory: app
14 | 
15 | jobs:
16 |   validate:
17 |     name: "Validate"
18 |     runs-on: ubuntu-latest
19 | 
20 |     steps:
21 |       - uses: actions/checkout@v3
22 | 
23 |       - run: composer validate
24 | 
25 |   normalize:
26 |     name: "Normalize"
27 |     runs-on: ubuntu-latest
28 | 
29 |     steps:
30 |       - uses: actions/checkout@v3
31 | 
32 |       - run: composer require --dev ergebnis/composer-normalize
33 | 
34 |       - run: composer config allow-plugins.ergebnis/composer-normalize true
35 | 
36 |       - run: composer normalize
37 | 


--------------------------------------------------------------------------------
/.github/workflows/pr_pest.yml:
--------------------------------------------------------------------------------
 1 | name: "PEST"
 2 | 
 3 | on:
 4 |   pull_request:
 5 |   merge_group:
 6 |   push:
 7 |     branches: ["master", "main"]
 8 | 
 9 | permissions: {}
10 | 
11 | defaults:
12 |   run:
13 |     working-directory: app
14 | 
15 | jobs:
16 |   pest:
17 |     name: "Scan"
18 |     runs-on: ubuntu-latest
19 | 
20 |     steps:
21 |       - uses: actions/checkout@v3
22 | 
23 |       - uses: shivammathur/setup-php@v2
24 |         with:
25 |           php-version: "8.1"
26 |           coverage: pcov
27 | 
28 |       - run: composer install --no-progress
29 | 
30 |       - run: vendor/bin/pest --order-by random --fail-on-risky --stop-on-defect --coverage --parallel
31 | 
32 |       - uses: codecov/codecov-action@v3
33 |         with:
34 |           directory: ./coverage/
35 |           flags: unittests
36 | 


--------------------------------------------------------------------------------
/.github/workflows/pr_phpcsf.yml:
--------------------------------------------------------------------------------
 1 | name: "PHP CS Fixer"
 2 | 
 3 | on:
 4 |   pull_request:
 5 |   merge_group:
 6 |   push:
 7 |     branches: ["master", "main"]
 8 | 
 9 | permissions: {}
10 | 
11 | defaults:
12 |   run:
13 |     working-directory: app
14 | 
15 | jobs:
16 |   phpcsf:
17 |     name: "Scan"
18 |     runs-on: ubuntu-latest
19 | 
20 |     steps:
21 |       - uses: actions/checkout@v3
22 | 
23 |       - uses: shivammathur/setup-php@v2
24 |         with:
25 |           php-version: "8.1"
26 | 
27 |       - run: composer install --no-progress
28 | 
29 |       - run: vendor/bin/php-cs-fixer fix src --dry-run --diff
30 | 


--------------------------------------------------------------------------------
/.github/workflows/pr_phpstan.yml:
--------------------------------------------------------------------------------
 1 | name: "PHPStan"
 2 | 
 3 | on:
 4 |   pull_request:
 5 |   merge_group:
 6 |   push:
 7 |     branches: ["master", "main"]
 8 | 
 9 | permissions: {}
10 | 
11 | defaults:
12 |   run:
13 |     working-directory: app
14 | 
15 | jobs:
16 |   phpstan:
17 |     name: "Scan"
18 |     runs-on: ubuntu-latest
19 | 
20 |     steps:
21 |       - uses: actions/checkout@v3
22 | 
23 |       - uses: shivammathur/setup-php@v2
24 |         with:
25 |           php-version: "8.1"
26 | 
27 |       - run: composer install --no-progress
28 | 
29 |       # - run: vendor/bin/phpstan analyze --no-ansi --no-progress --debug
30 | 


--------------------------------------------------------------------------------
/.github/workflows/pr_psalm.yml:
--------------------------------------------------------------------------------
 1 | name: "Psalm"
 2 | 
 3 | on:
 4 |   pull_request:
 5 |   merge_group:
 6 |   push:
 7 |     branches: ["master", "main"]
 8 | 
 9 | permissions: {}
10 | 
11 | defaults:
12 |   run:
13 |     working-directory: app
14 | 
15 | jobs:
16 |   psalm:
17 |     name: "Scan"
18 |     runs-on: ubuntu-latest
19 | 
20 |     steps:
21 |       - uses: actions/checkout@v3
22 | 
23 |       - uses: shivammathur/setup-php@v2
24 |         with:
25 |           php-version: "8.1"
26 | 
27 |       - run: composer install --no-progress
28 | 
29 |       # - run: vendor/bin/psalm
30 | 


--------------------------------------------------------------------------------
/.github/workflows/pr_rector.yml:
--------------------------------------------------------------------------------
 1 | name: "Rector"
 2 | 
 3 | on:
 4 |   pull_request:
 5 |   merge_group:
 6 |   push:
 7 |     branches: ["master", "main"]
 8 | 
 9 | permissions: {}
10 | 
11 | defaults:
12 |   run:
13 |     working-directory: app
14 | 
15 | jobs:
16 |   rector:
17 |     name: "Scan"
18 |     runs-on: ubuntu-latest
19 | 
20 |     steps:
21 |       - uses: actions/checkout@v3
22 | 
23 |       - uses: shivammathur/setup-php@v2
24 |         with:
25 |           php-version: "8.1"
26 | 
27 |       - run: composer install --no-progress
28 | 
29 |       - run: vendor/bin/rector process --dry-run
30 | 


--------------------------------------------------------------------------------
/.github/workflows/pr_snyk.yml:
--------------------------------------------------------------------------------
 1 | name: "Snyk"
 2 | 
 3 | on:
 4 |   workflow_run:
 5 |     workflows: ["Pull Request Changes"]
 6 |     types:
 7 |       - completed
 8 | 
 9 | permissions: {}
10 | 
11 | defaults:
12 |   run:
13 |     working-directory: app
14 | 
15 | jobs:
16 |   snyk:
17 |     name: "Scan"
18 |     runs-on: ubuntu-latest
19 | 
20 |     steps:
21 |       - uses: shivammathur/setup-php@v2
22 |         with:
23 |           php-version: "8.1"
24 |           coverage: none
25 |           extensions: mbstring
26 |         env:
27 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
28 | 
29 |       - uses: actions/checkout@v3
30 |         with:
31 |           ref: ${{ github.event.pull_request.head.sha }}
32 |           github-token: ${{ secrets.GITHUB_TOKEN }}
33 | 
34 |       - run: composer install --no-progress
35 | 
36 |       - uses: snyk/actions/php@master
37 |         continue-on-error: true
38 |         env:
39 |           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
40 | 


--------------------------------------------------------------------------------
/.github/workflows/semgrep.yml:
--------------------------------------------------------------------------------
 1 | name: Semgrep
 2 | 
 3 | on:
 4 |   pull_request_target: {}
 5 |   push:
 6 |     branches: ["master", "main"]
 7 | permissions:
 8 |   contents: read
 9 | jobs:
10 |   semgrep:
11 |     name: Scan
12 |     runs-on: ubuntu-latest
13 |     container:
14 |       image: returntocorp/semgrep
15 |     if: (github.actor != 'dependabot[bot]' && github.actor != 'snyk-bot')
16 |     steps:
17 |       - uses: actions/checkout@v3
18 |       - run: semgrep ci
19 |         env:
20 |           SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }}
21 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | vendor
2 | .env
3 | composer.lock
4 | .DS_Store
5 | app/.php-cs-fixer.cache
6 | 


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


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Auth0 + PHP Backend API Sample
 2 | 
 3 | This sample demonstrates how to add endpoint authorization to a [PHP](http://php.net/) backend API service using [Auth0](https://auth0.com). The project source code can be found in the [app directory](./app). Check the [PHP Quickstart](https://auth0.com/docs/quickstart/backend/php) to understand this sample better.
 4 | 
 5 | ## Vulnerability Reporting
 6 | 
 7 | Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
 8 | 
 9 | ## What is Auth0?
10 | 
11 | Auth0 helps you to easily:
12 | 
13 | - implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.)
14 | - log in users with username/password databases, passwordless, or multi-factor authentication
15 | - link multiple user accounts together
16 | - generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely
17 | - access demographics and analytics detailing how, when, and where users are logging in
18 | - enrich user profiles from other data sources using customizable JavaScript rules
19 | 
20 | [Why Auth0?](https://auth0.com/why-auth0)
21 | 
22 | ## License
23 | 
24 | This project is licensed under the MIT license. See the [LICENSE](https://github.com/auth0-samples/auth0-php-web-app/blob/master/LICENSE) file for more info.
25 | 


--------------------------------------------------------------------------------
/app/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | charset = utf-8
 5 | end_of_line = lf
 6 | insert_final_newline = true
 7 | indent_style = space
 8 | indent_size = 4
 9 | trim_trailing_whitespace = true
10 | 
11 | [*.md]
12 | trim_trailing_whitespace = false
13 | 
14 | [*.{yml,yaml}]
15 | indent_size = 2
16 | 
17 | [docker-compose.yml]
18 | indent_size = 4
19 | 


--------------------------------------------------------------------------------
/app/.env.example:
--------------------------------------------------------------------------------
 1 | # ---------
 2 | # Required:
 3 | # ---------
 4 | 
 5 | # Your Auth0 application's Client ID
 6 | AUTH0_CLIENT_ID={CLIENT_ID}
 7 | 
 8 | # The URL of your Auth0 tenant domain
 9 | AUTH0_DOMAIN={DOMAIN}
10 | 
11 | # Your Auth0 application's Client Secret
12 | AUTH0_CLIENT_SECRET={CLIENT_SECRET}
13 | 
14 | # The Identifier from your custom Auth0 API.
15 | AUTH0_AUDIENCE={API_IDENTIFIER}
16 | 
17 | # -------------------------------------------------------------------------
18 | # Optional: Remove the leading # from the following options to enable them:
19 | # -------------------------------------------------------------------------
20 | 
21 | # An Organization Id for testing Organizations.
22 | # AUTH0_ORGANIZATION={ORGANIZATION_ID}
23 | 


--------------------------------------------------------------------------------
/app/.php-cs-fixer.dist.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | return (new PhpCsFixer\Config())
  6 |     ->setRiskyAllowed(true)
  7 |     ->setRules([
  8 |         'array_indentation' => true,
  9 |         'array_push' => true,
 10 |         'array_syntax' => ['syntax' => 'short'],
 11 |         'assign_null_coalescing_to_coalesce_equal' => true,
 12 |         'backtick_to_shell_exec' => true,
 13 |         'binary_operator_spaces' => true,
 14 |         'blank_line_after_namespace' => true,
 15 |         'blank_line_after_opening_tag' => true,
 16 |         'blank_line_before_statement' => true,
 17 |         'blank_line_between_import_groups' => true,
 18 |         'braces' => true,
 19 |         'cast_spaces' => true,
 20 |         'class_attributes_separation' => ['elements' => ['const' => 'one', 'method' => 'one', 'property' => 'one', 'trait_import' => 'one', 'case' => 'one']],
 21 |         'class_definition' => ['multi_line_extends_each_single_line' => true, 'single_line' => true, 'single_item_single_line' => true, 'space_before_parenthesis' => false, 'inline_constructor_arguments' => false],
 22 |         'class_reference_name_casing' => true,
 23 |         'clean_namespace' => true,
 24 |         'combine_consecutive_issets' => true,
 25 |         'combine_consecutive_unsets' => true,
 26 |         'combine_nested_dirname' => true,
 27 |         'comment_to_phpdoc' => ['ignored_tags' => ['codeCoverageIgnoreStart', 'codeCoverageIgnoreEnd', 'phpstan-ignore-next-line']],
 28 |         'compact_nullable_typehint' => true,
 29 |         'concat_space' => ['spacing' => 'one'],
 30 |         'constant_case' => ['case' => 'lower'],
 31 |         'curly_braces_position' => ['control_structures_opening_brace' => 'same_line', 'functions_opening_brace' => 'next_line_unless_newline_at_signature_end', 'anonymous_functions_opening_brace' => 'same_line', 'classes_opening_brace' => 'next_line_unless_newline_at_signature_end', 'anonymous_classes_opening_brace' => 'same_line', 'allow_single_line_empty_anonymous_classes' => true, 'allow_single_line_anonymous_functions' => true],
 32 |         'date_time_create_from_format_call' => true,
 33 |         'date_time_immutable' => true,
 34 |         'declare_equal_normalize' => ['space' => 'none'],
 35 |         'declare_parentheses' => true,
 36 |         'declare_strict_types' => true,
 37 |         'dir_constant' => true,
 38 |         'doctrine_annotation_array_assignment' => true,
 39 |         'doctrine_annotation_braces' => true,
 40 |         'doctrine_annotation_indentation' => true,
 41 |         'doctrine_annotation_spaces' => true,
 42 |         'echo_tag_syntax' => ['format' => 'long'],
 43 |         'elseif' => true,
 44 |         'empty_loop_body' => true,
 45 |         'empty_loop_condition' => true,
 46 |         'encoding' => true,
 47 |         'ereg_to_preg' => true,
 48 |         'error_suppression' => true,
 49 |         'escape_implicit_backslashes' => true,
 50 |         'explicit_indirect_variable' => true,
 51 |         'explicit_string_variable' => true,
 52 |         'final_class' => true,
 53 |         'final_internal_class' => true,
 54 |         'final_public_method_for_abstract_class' => true,
 55 |         'fopen_flag_order' => true,
 56 |         'fopen_flags' => true,
 57 |         'full_opening_tag' => true,
 58 |         'fully_qualified_strict_types' => true,
 59 |         'function_declaration' => true,
 60 |         'function_to_constant' => true,
 61 |         'function_typehint_space' => true,
 62 |         'general_phpdoc_annotation_remove' => true,
 63 |         'general_phpdoc_tag_rename' => true,
 64 |         'get_class_to_class_keyword' => true,
 65 |         'global_namespace_import' => ['import_classes' => true, 'import_constants' => true, 'import_functions' => true],
 66 |         'group_import' => true,
 67 |         'heredoc_indentation' => true,
 68 |         'heredoc_to_nowdoc' => true,
 69 |         'implode_call' => true,
 70 |         'include' => true,
 71 |         'increment_style' => ['style' => 'pre'],
 72 |         'indentation_type' => true,
 73 |         'integer_literal_case' => true,
 74 |         'is_null' => true,
 75 |         'lambda_not_used_import' => true,
 76 |         'line_ending' => true,
 77 |         'linebreak_after_opening_tag' => true,
 78 |         'list_syntax' => ['syntax' => 'short'],
 79 |         'logical_operators' => true,
 80 |         'lowercase_cast' => true,
 81 |         'lowercase_keywords' => true,
 82 |         'lowercase_static_reference' => true,
 83 |         'magic_constant_casing' => true,
 84 |         'magic_method_casing' => true,
 85 |         'mb_str_functions' => false,
 86 |         'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline', 'after_heredoc' => true],
 87 |         'method_chaining_indentation' => true,
 88 |         'modernize_strpos' => true,
 89 |         'modernize_types_casting' => true,
 90 |         'multiline_comment_opening_closing' => true,
 91 |         'multiline_whitespace_before_semicolons' => true,
 92 |         'native_function_casing' => true,
 93 |         'native_function_invocation' => true,
 94 |         'native_function_type_declaration_casing' => true,
 95 |         'new_with_braces' => true,
 96 |         'no_alias_functions' => true,
 97 |         'no_alias_language_construct_call' => true,
 98 |         'no_alternative_syntax' => true,
 99 |         'no_binary_string' => true,
100 |         'no_blank_lines_after_class_opening' => true,
101 |         'no_blank_lines_after_phpdoc' => true,
102 |         'no_break_comment' => true,
103 |         'no_closing_tag' => true,
104 |         'no_empty_comment' => true,
105 |         'no_empty_phpdoc' => true,
106 |         'no_empty_statement' => true,
107 |         'no_extra_blank_lines' => true,
108 |         'no_homoglyph_names' => true,
109 |         'no_leading_import_slash' => true,
110 |         'no_leading_namespace_whitespace' => true,
111 |         'no_mixed_echo_print' => true,
112 |         'no_multiline_whitespace_around_double_arrow' => true,
113 |         'no_multiple_statements_per_line' => true,
114 |         'no_php4_constructor' => true,
115 |         'no_short_bool_cast' => true,
116 |         'no_singleline_whitespace_before_semicolons' => true,
117 |         'no_space_around_double_colon' => true,
118 |         'no_spaces_after_function_name' => true,
119 |         'no_spaces_around_offset' => true,
120 |         'no_spaces_inside_parenthesis' => true,
121 |         'no_superfluous_elseif' => true,
122 |         'no_trailing_comma_in_singleline' => true,
123 |         'no_trailing_whitespace_in_comment' => true,
124 |         'no_trailing_whitespace_in_string' => true,
125 |         'no_trailing_whitespace' => true,
126 |         'no_unneeded_control_parentheses' => true,
127 |         'no_unneeded_curly_braces' => true,
128 |         'no_unneeded_final_method' => true,
129 |         'no_unneeded_import_alias' => true,
130 |         'no_unreachable_default_argument_value' => true,
131 |         'no_unset_cast' => true,
132 |         'no_unused_imports' => true,
133 |         'no_useless_concat_operator' => true,
134 |         'no_useless_else' => true,
135 |         'no_useless_nullsafe_operator' => true,
136 |         'no_useless_return' => true,
137 |         'no_useless_sprintf' => true,
138 |         'no_whitespace_before_comma_in_array' => true,
139 |         'no_whitespace_in_blank_line' => true,
140 |         'non_printable_character' => true,
141 |         'normalize_index_brace' => true,
142 |         'not_operator_with_successor_space' => true,
143 |         'nullable_type_declaration_for_default_null_value' => true,
144 |         'object_operator_without_whitespace' => true,
145 |         'octal_notation' => true,
146 |         'operator_linebreak' => true,
147 |         'ordered_class_elements' => ['sort_algorithm' => 'alpha', 'order' => ['use_trait', 'case', 'constant', 'constant_private', 'constant_protected', 'constant_public', 'property_private', 'property_private_readonly', 'property_private_static', 'property_protected', 'property_protected_readonly', 'property_protected_static', 'property_public', 'property_public_readonly', 'property_public_static', 'property_static', 'protected', 'construct', 'destruct', 'magic', 'method', 'public', 'method_public', 'method_abstract', 'method_public_abstract', 'method_public_abstract_static', 'method_public_static', 'method_static', 'method_private', 'method_private_abstract', 'method_private_abstract_static', 'method_private_static', 'method_protected', 'method_protected_abstract', 'method_protected_abstract_static', 'method_protected_static', 'phpunit', 'private', 'property']],
148 |         'ordered_imports' => ['sort_algorithm' => 'alpha', 'imports_order' => ['const', 'class', 'function']],
149 |         'ordered_interfaces' => true,
150 |         'ordered_traits' => true,
151 |         'php_unit_fqcn_annotation' => true,
152 |         'phpdoc_add_missing_param_annotation' => ['only_untyped' => false],
153 |         'phpdoc_align' => ['align' => 'vertical'],
154 |         'phpdoc_indent' => true,
155 |         'phpdoc_inline_tag_normalizer' => true,
156 |         'phpdoc_line_span' => true,
157 |         'phpdoc_no_access' => true,
158 |         'phpdoc_no_empty_return' => true,
159 |         'phpdoc_no_package' => true,
160 |         'phpdoc_no_useless_inheritdoc' => true,
161 |         'phpdoc_order_by_value' => true,
162 |         'phpdoc_order' => true,
163 |         'phpdoc_return_self_reference' => ['replacements' => ['this' => 'self']],
164 |         'phpdoc_scalar' => true,
165 |         'phpdoc_separation' => true,
166 |         'phpdoc_single_line_var_spacing' => true,
167 |         'phpdoc_summary' => true,
168 |         'phpdoc_tag_type' => true,
169 |         'phpdoc_to_comment' => ['ignored_tags' => ['var']],
170 |         'phpdoc_trim_consecutive_blank_line_separation' => true,
171 |         'phpdoc_trim' => true,
172 |         'phpdoc_types_order' => true,
173 |         'phpdoc_types' => true,
174 |         'phpdoc_var_annotation_correct_order' => true,
175 |         'phpdoc_var_without_name' => true,
176 |         'pow_to_exponentiation' => true,
177 |         'protected_to_private' => true,
178 |         'psr_autoloading' => true,
179 |         'random_api_migration' => true,
180 |         'regular_callable_call' => true,
181 |         'return_assignment' => true,
182 |         'return_type_declaration' => ['space_before' => 'none'],
183 |         'return_type_declaration' => true,
184 |         'self_accessor' => true,
185 |         'self_static_accessor' => true,
186 |         'semicolon_after_instruction' => true,
187 |         'set_type_to_cast' => true,
188 |         'short_scalar_cast' => true,
189 |         'simple_to_complex_string_variable' => true,
190 |         'simplified_if_return' => true,
191 |         'single_blank_line_at_eof' => true,
192 |         'single_blank_line_before_namespace' => true,
193 |         'single_class_element_per_statement' => true,
194 |         'single_line_after_imports' => true,
195 |         'single_line_comment_spacing' => true,
196 |         'single_line_comment_style' => ['comment_types' => ['hash']],
197 |         'single_line_throw' => true,
198 |         'single_quote' => true,
199 |         'single_space_after_construct' => true,
200 |         'single_space_around_construct' => true,
201 |         'single_trait_insert_per_statement' => true,
202 |         'space_after_semicolon' => true,
203 |         'standardize_increment' => true,
204 |         'standardize_not_equals' => true,
205 |         'statement_indentation' => true,
206 |         'static_lambda' => true,
207 |         'strict_comparison' => true,
208 |         'strict_param' => true,
209 |         'string_length_to_empty' => true,
210 |         'string_line_ending' => true,
211 |         'switch_case_semicolon_to_colon' => true,
212 |         'switch_case_space' => true,
213 |         'switch_continue_to_break' => true,
214 |         'ternary_operator_spaces' => true,
215 |         'ternary_to_elvis_operator' => true,
216 |         'ternary_to_null_coalescing' => true,
217 |         'trailing_comma_in_multiline' => ['after_heredoc' => true, 'elements' => ['arguments', 'arrays', 'match', 'parameters']],
218 |         'trim_array_spaces' => true,
219 |         'types_spaces' => ['space' => 'single', 'space_multiple_catch' => 'single'],
220 |         'unary_operator_spaces' => true,
221 |         'use_arrow_functions' => true,
222 |         'visibility_required' => true,
223 |         'void_return' => true,
224 |         'whitespace_after_comma_in_array' => true,
225 |         'yoda_style' => true,
226 |     ])
227 |     ->setFinder(
228 |         PhpCsFixer\Finder::create()
229 |             ->exclude('vendor')
230 |             ->in([__DIR__ . '/src/']),
231 |     );
232 | 


--------------------------------------------------------------------------------
/app/.phpcs.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <ruleset>
 3 |     <rule ref="Squiz.Commenting.FunctionComment">
 4 |         <properties>
 5 |             <property name="minimumVisibility" value="public" />
 6 |             <property name="skipIfInheritdoc" value="true" />
 7 |         </properties>
 8 |     </rule>
 9 | 
10 | 	<rule ref="Generic.PHP.Syntax">
11 | 		<exclude name="Generic.PHP.Syntax" />
12 | 	</rule>
13 | </ruleset>
14 | 


--------------------------------------------------------------------------------
/app/README.md:
--------------------------------------------------------------------------------
 1 | # Auth0 PHP Web App Sample
 2 | 
 3 | This sample demonstrates how to add endpoint authorization to a [PHP](http://php.net/) backend API service using [Auth0](https://auth0.com). Check the [PHP Quickstart](https://auth0.com/docs/quickstart/backend/php) to understand this sample better.
 4 | 
 5 | ## Configuration
 6 | 
 7 | ### Create a free account in Auth0
 8 | 
 9 | 1. Go to [Auth0](https://auth0.com) and click Sign Up.
10 | 2. Use Google, GitHub or Microsoft Account to login.
11 | 
12 | ### Create an Auth0 Application
13 | 
14 | You will need to create a Regular Web Application using the [Auth0 Dashboard](https://manage.auth0.com). This will give you a Domain, Client ID, and Client Secret you will need below.
15 | 
16 | ### Configure Credentials
17 | 
18 | Your project needs to be configured with your Auth0 Domain, Client ID, and Client Secret for the authentication flow to work.
19 | 
20 | Copy .env.example into a new file in the same folder called .env, and replace the values with your Auth0 application credentials:
21 | 
22 | ```sh
23 | # Your Auth0 application's Client ID
24 | AUTH0_CLIENT_ID='YOUR_AUTH0_CLIENT_ID'
25 | 
26 | # The url of your Auth0 tenant domain
27 | AUTH0_DOMAIN='https://YOUR_AUTH0_DOMAIN.auth0.com'
28 | 
29 | # Your Auth0 application's Client Secret
30 | AUTH0_CLIENT_SECRET='YOUR_AUTH0_CLIENT_SECRET'
31 | 
32 | # A long secret value used to encrypt the session cookie
33 | AUTH0_COOKIE_SECRET='LONG_RANDOM_VALUE'
34 | ```
35 | 
36 | **Note**: Make sure you replace `LONG_RANDOM_VALUE` with your secret (you can generate a suitable string using `openssl rand -hex 32` on the command line).
37 | 
38 | **Note**: Ensure you are consistent in your use of 'localhost' and/or '127.0.0.1' when testing. These must match your Auth0 Application settings or you will encounter errors. They must also match for session cookies to work correctly.
39 | 
40 | ## Install dependencies
41 | 
42 | Please ensure you have [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos) installed and accessible from your shell. This is required.
43 | 
44 | ```bash
45 | composer install --no-dev
46 | ```
47 | 
48 | ## Run the sample
49 | 
50 | Before continuing, please ensure you have [PHP](https://www.php.net/manual/en/install.php) 7.4+ and [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos) installed and accessible from your shell. These are required.
51 | 
52 | Next, use the following command to install the necessary dependencies and start the sample:
53 | 
54 | ```bash
55 | php -S 127.0.0.1:3000 public/index.php
56 | ```
57 | 
58 | Your Quickstart should now be accessible at [http://127.0.0.1:3000/](http://127.0.0.1:3000/) from your web browser.
59 | 
60 | ## Vulnerability Reporting
61 | 
62 | Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
63 | 
64 | ## What is Auth0?
65 | 
66 | Auth0 helps you to easily:
67 | 
68 | - implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.)
69 | - log in users with username/password databases, passwordless, or multi-factor authentication
70 | - link multiple user accounts together
71 | - generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely
72 | - access demographics and analytics detailing how, when, and where users are logging in
73 | - enrich user profiles from other data sources using customizable JavaScript rules
74 | 
75 | [Why Auth0?](https://auth0.com/why-auth0)
76 | 
77 | ## License
78 | 
79 | This project is licensed under the MIT license. See the [LICENSE](https://github.com/auth0-samples/auth0-php-web-app/blob/master/LICENSE) file for more info.
80 | 


--------------------------------------------------------------------------------
/app/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "auth0-samples/auth0-php-web-app",
 3 |     "description": "Auth0 Integration Samples for PHP Web Applications.",
 4 |     "require": {
 5 |         "php": "^8.0",
 6 |         "auth0/auth0-php": "^8.0",
 7 |         "guzzlehttp/guzzle": "^7.3",
 8 |         "guzzlehttp/psr7": "^2.2",
 9 |         "http-interop/http-factory-guzzle": "^1.0",
10 |         "hyperf/event": "^2.1",
11 |         "php-http/httplug": "^2.2",
12 |         "vlucas/phpdotenv": "^5.3"
13 |     },
14 |     "require-dev": {
15 |         "friendsofphp/php-cs-fixer": "^3",
16 |         "mockery/mockery": "^1",
17 |         "nunomaduro/larastan": "^2",
18 |         "orchestra/testbench": "^7 || ^8",
19 |         "pestphp/pest": "^2",
20 |         "pestphp/pest-plugin-laravel": "^2",
21 |         "phpstan/phpstan": "^1",
22 |         "phpstan/phpstan-strict-rules": "^1",
23 |         "psalm/plugin-laravel": "^2",
24 |         "rector/rector": "0.17.0",
25 |         "spatie/laravel-ray": "^1",
26 |         "squizlabs/php_codesniffer": "^3",
27 |         "symfony/cache": "^6",
28 |         "vimeo/psalm": "^5",
29 |         "wikimedia/composer-merge-plugin": "^2"
30 |     },
31 |     "config": {
32 |         "optimize-autoloader": true,
33 |         "sort-packages": true,
34 |         "allow-plugins": {
35 |             "dealerdirect/phpcodesniffer-composer-installer": true,
36 |             "friendsofphp/well-known-implementations": false,
37 |             "wikimedia/composer-merge-plugin": true,
38 |             "php-http/discovery": false,
39 |             "pestphp/pest-plugin": true
40 |         }
41 |     },
42 |     "scripts": {
43 |         "pest:coverage": "@php vendor/bin/pest --coverage --parallel --no-progress",
44 |         "pest:debug": "@php vendor/bin/pest --fail-on-risky --stop-on-defect",
45 |         "pest:profile": "@php vendor/bin/pest --profile",
46 |         "pest": "@php vendor/bin/pest --order-by random --fail-on-risky --stop-on-defect --coverage --parallel",
47 |         "phpcs:fix": "@php vendor/bin/php-cs-fixer fix",
48 |         "phpcs": "@php vendor/bin/php-cs-fixer fix --dry-run --diff",
49 |         "phpstan": "@php vendor/bin/phpstan analyze",
50 |         "psalm:fix": "@php vendor/bin/psalter --issues=all",
51 |         "psalm": "@php vendor/bin/psalm",
52 |         "rector:fix": "@php vendor/bin/rector process src",
53 |         "rector": "@php vendor/bin/rector process src --dry-run",
54 |         "test": [
55 |             "Composer\\Config::disableProcessTimeout",
56 |             "@pest",
57 |             "@phpstan",
58 |             "@psalm",
59 |             "@rector",
60 |             "@phpcs"
61 |         ]
62 |     },
63 |     "license": "MIT"
64 | }
65 | 


--------------------------------------------------------------------------------
/app/phpstan.neon.dist:
--------------------------------------------------------------------------------
 1 | includes:
 2 |     - ./vendor/phpstan/phpstan-strict-rules/rules.neon
 3 |     - ./vendor/nunomaduro/larastan/extension.neon
 4 | 
 5 | parameters:
 6 |     level: max
 7 | 
 8 |     paths:
 9 |         - src
10 | 
11 |     ignoreErrors:
12 |         - '#Method (.*) has parameter (.*) with no value type specified in iterable type array.#'
13 |         - '#no value type specified in iterable type array.#'
14 | 
15 |     reportUnmatchedIgnoredErrors: false
16 |     treatPhpDocTypesAsCertain: false
17 |     checkGenericClassInNonGenericObjectType: false
18 | 


--------------------------------------------------------------------------------
/app/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 |          xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
 4 |          bootstrap="vendor/autoload.php"
 5 |          colors="true"
 6 | >
 7 |     <testsuites>
 8 |         <testsuite name="Test Suite">
 9 |             <directory suffix="Test.php">./tests</directory>
10 |         </testsuite>
11 |     </testsuites>
12 |     <coverage>
13 |         <include>
14 |             <directory suffix=".php">./src</directory>
15 |         </include>
16 |     </coverage>
17 | </phpunit>
18 | 


--------------------------------------------------------------------------------
/app/psalm.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <psalm
 3 |     errorLevel="1"
 4 |     resolveFromConfigFile="true"
 5 |     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 6 |     xmlns="https://getpsalm.org/schema/config"
 7 |     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 8 |     findUnusedBaselineEntry="true"
 9 |     findUnusedCode="false"
10 | >
11 |     <projectFiles>
12 |         <directory name="src"/>
13 |     </projectFiles>
14 | 
15 |     <issueHandlers>
16 |         <MixedArgument errorLevel="suppress"/>
17 |         <MixedArgumentTypeCoercion errorLevel="suppress"/>
18 |         <MixedAssignment errorLevel="suppress"/>
19 |         <MixedInferredReturnType errorLevel="suppress"/>
20 |         <MixedReturnStatement errorLevel="suppress"/>
21 |         <DeprecatedClass errorLevel="suppress"/>
22 |         <DeprecatedInterface errorLevel="suppress"/>
23 |     </issueHandlers>
24 | 
25 |     <plugins>
26 |         <pluginClass class="Psalm\LaravelPlugin\Plugin" />
27 |     </plugins>
28 | </psalm>
29 | 


--------------------------------------------------------------------------------
/app/public/bootstrap.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | define('APP_ROOT', realpath(__DIR__ . DIRECTORY_SEPARATOR . '..'));
 6 | 
 7 | // The following globals don't get set during tests: apply some safe defaults.
 8 | if (! isset($_SERVER['SERVER_PORT'])) {
 9 |     $_SERVER['SERVER_PORT'] = 80;
10 | }
11 | 
12 | if (! isset($_SERVER['SERVER_NAME'])) {
13 |     $_SERVER['SERVER_NAME'] = '127.0.0.1';
14 | }
15 | 
16 | if (! isset($_SERVER['REQUEST_URI'])) {
17 |     $_SERVER['REQUEST_URI'] = '/';
18 | }
19 | 


--------------------------------------------------------------------------------
/app/public/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | use Auth0\Quickstart\Application;
 6 | 
 7 | /**
 8 |  * This file bootstraps our application.
 9 |  */
10 | 
11 | require __DIR__ . DIRECTORY_SEPARATOR . 'bootstrap.php';
12 | 
13 | // Import the files necessary for our Quickstart Application.
14 | foreach ([
15 |     'vendor/autoload.php', // Composer autoloader, for our dependencies, such as the SDK itself.
16 | 
17 |     // These classes are application boilerplate and not directly relevant to SDK usage:
18 |     'src/ApplicationRouter.php',
19 |     'src/ApplicationTemplates.php',
20 |     'src/ApplicationErrorHandler.php',
21 | 
22 |     // Import our Application class, where our app logic resides, and where we'll make our SDK calls.
23 |     'src/Application.php',
24 | ] as $import) {
25 |     require_once join(DIRECTORY_SEPARATOR, [APP_ROOT, $import]);
26 | }
27 | 
28 | // Load configuration from .env file in project root.
29 | (Dotenv\Dotenv::createImmutable(APP_ROOT))->load();
30 | 
31 | // Instantiate our Quickstart Application using the .env configuration.
32 | $app = new Application($_ENV);
33 | 
34 | $app->run();
35 | 


--------------------------------------------------------------------------------
/app/rector.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | use Rector\Arguments\Rector\ClassMethod\ArgumentAdderRector;
  6 | use Rector\Arguments\Rector\FuncCall\FunctionArgumentDefaultValueReplacerRector;
  7 | use Rector\Arguments\Rector\MethodCall\SwapMethodCallArgumentsRector;
  8 | use Rector\Arguments\ValueObject\{ArgumentAdder,
  9 |     ReplaceFuncCallArgumentDefaultValue};
 10 | use Rector\CodeQuality\Rector\Array_\CallableThisArrayToAnonymousFunctionRector;
 11 | use Rector\CodeQuality\Rector\Assign\CombinedAssignRector;
 12 | use Rector\CodeQuality\Rector\BooleanAnd\SimplifyEmptyArrayCheckRector;
 13 | use Rector\CodeQuality\Rector\BooleanNot\{ReplaceMultipleBooleanNotRector,
 14 |     SimplifyDeMorganBinaryRector};
 15 | use Rector\CodeQuality\Rector\Catch_\ThrowWithPreviousExceptionRector;
 16 | use Rector\CodeQuality\Rector\Class_\{CompleteDynamicPropertiesRector,
 17 |     InlineConstructorDefaultToPropertyRector};
 18 | use Rector\CodeQuality\Rector\ClassMethod\{InlineArrayReturnAssignRector,
 19 |     OptionalParametersAfterRequiredRector,
 20 |     ReturnTypeFromStrictScalarReturnExprRector};
 21 | use Rector\CodeQuality\Rector\Concat\JoinStringConcatRector;
 22 | use Rector\CodeQuality\Rector\Empty_\SimplifyEmptyCheckOnEmptyArrayRector;
 23 | use Rector\CodeQuality\Rector\Equal\UseIdenticalOverEqualWithSameTypeRector;
 24 | use Rector\CodeQuality\Rector\Expression\{InlineIfToExplicitIfRector,
 25 |     TernaryFalseExpressionToIfRector};
 26 | use Rector\CodeQuality\Rector\For_\ForRepeatedCountToOwnVariableRector;
 27 | use Rector\CodeQuality\Rector\Foreach_\{ForeachItemsAssignToEmptyArrayToAssignRector,
 28 |     ForeachToInArrayRector,
 29 |     SimplifyForeachToArrayFilterRector,
 30 |     SimplifyForeachToCoalescingRector,
 31 |     UnusedForeachValueToArrayKeysRector};
 32 | use Rector\CodeQuality\Rector\FuncCall\{ArrayKeysAndInArrayToArrayKeyExistsRector,
 33 |     ArrayMergeOfNonArraysToSimpleArrayRector,
 34 |     BoolvalToTypeCastRector,
 35 |     CallUserFuncWithArrowFunctionToInlineRector,
 36 |     ChangeArrayPushToArrayAssignRector,
 37 |     CompactToVariablesRector,
 38 |     FloatvalToTypeCastRector,
 39 |     InlineIsAInstanceOfRector,
 40 |     IntvalToTypeCastRector,
 41 |     IsAWithStringWithThirdArgumentRector,
 42 |     RemoveSoleValueSprintfRector,
 43 |     SetTypeToCastRector,
 44 |     SimplifyFuncGetArgsCountRector,
 45 |     SimplifyInArrayValuesRector,
 46 |     SimplifyRegexPatternRector,
 47 |     SimplifyStrposLowerRector,
 48 |     SingleInArrayToCompareRector,
 49 |     StrvalToTypeCastRector,
 50 |     UnwrapSprintfOneArgumentRector};
 51 | use Rector\CodeQuality\Rector\FunctionLike\{RemoveAlwaysTrueConditionSetInConstructorRector,
 52 |     SimplifyUselessVariableRector};
 53 | use Rector\CodeQuality\Rector\Identical\{BooleanNotIdenticalToNotIdenticalRector,
 54 |     FlipTypeControlToUseExclusiveTypeRector,
 55 |     GetClassToInstanceOfRector,
 56 |     SimplifyArraySearchRector,
 57 |     SimplifyBoolIdenticalTrueRector,
 58 |     SimplifyConditionsRector,
 59 |     StrlenZeroToIdenticalEmptyStringRector};
 60 | use Rector\CodeQuality\Rector\If_\{CombineIfRector,
 61 |     ConsecutiveNullCompareReturnsToNullCoalesceQueueRector,
 62 |     ExplicitBoolCompareRector,
 63 |     ShortenElseIfRector,
 64 |     SimplifyIfElseToTernaryRector,
 65 |     SimplifyIfNotNullReturnRector,
 66 |     SimplifyIfNullableReturnRector,
 67 |     SimplifyIfReturnBoolRector};
 68 | use Rector\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector;
 69 | use Rector\CodeQuality\Rector\Isset_\IssetOnPropertyObjectToPropertyExistsRector;
 70 | use Rector\CodeQuality\Rector\LogicalAnd\{AndAssignsToSeparateLinesRector,
 71 |     LogicalToBooleanRector};
 72 | use Rector\CodeQuality\Rector\New_\NewStaticToNewSelfRector;
 73 | use Rector\CodeQuality\Rector\NotEqual\CommonNotEqualRector;
 74 | use Rector\CodeQuality\Rector\NullsafeMethodCall\CleanupUnneededNullsafeOperatorRector;
 75 | use Rector\CodeQuality\Rector\Switch_\SingularSwitchToIfRector;
 76 | use Rector\CodeQuality\Rector\Ternary\{ArrayKeyExistsTernaryThenValueToCoalescingRector,
 77 |     SimplifyTautologyTernaryRector,
 78 |     SwitchNegatedTernaryRector,
 79 |     TernaryEmptyArrayArrayDimFetchToCoalesceRector,
 80 |     UnnecessaryTernaryExpressionRector};
 81 | use Rector\CodingStyle\Rector\ArrowFunction\StaticArrowFunctionRector;
 82 | use Rector\CodingStyle\Rector\Assign\SplitDoubleAssignRector;
 83 | use Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector;
 84 | use Rector\CodingStyle\Rector\Class_\AddArrayDefaultToArrayPropertyRector;
 85 | use Rector\CodingStyle\Rector\ClassConst\{RemoveFinalFromConstRector, SplitGroupedClassConstantsRector, VarConstantCommentRector};
 86 | use Rector\CodingStyle\Rector\ClassMethod\{FuncGetArgsToVariadicParamRector, MakeInheritedMethodVisibilitySameAsParentRector, NewlineBeforeNewAssignSetRector, UnSpreadOperatorRector};
 87 | use Rector\CodingStyle\Rector\Closure\StaticClosureRector;
 88 | use Rector\CodingStyle\Rector\Encapsed\{EncapsedStringsToSprintfRector, WrapEncapsedVariableInCurlyBracesRector};
 89 | use Rector\CodingStyle\Rector\FuncCall\{CallUserFuncArrayToVariadicRector, CallUserFuncToMethodCallRector, ConsistentImplodeRector, CountArrayToEmptyArrayComparisonRector, StrictArraySearchRector, VersionCompareFuncCallToConstantRector};
 90 | use Rector\CodingStyle\Rector\If_\NullableCompareToNullRector;
 91 | use Rector\CodingStyle\Rector\Plus\UseIncrementAssignRector;
 92 | use Rector\CodingStyle\Rector\PostInc\PostIncDecToPreIncDecRector;
 93 | use Rector\CodingStyle\Rector\Property\SplitGroupedPropertiesRector;
 94 | use Rector\CodingStyle\Rector\String_\{SymplifyQuoteEscapeRector, UseClassKeywordForClassNameResolutionRector};
 95 | use Rector\CodingStyle\Rector\Switch_\BinarySwitchToIfElseRector;
 96 | use Rector\CodingStyle\Rector\Ternary\TernaryConditionVariableAssignmentRector;
 97 | use Rector\CodingStyle\Rector\Use_\SeparateMultiUseImportsRector;
 98 | use Rector\Config\RectorConfig;
 99 | use Rector\DeadCode\Rector\Array_\RemoveDuplicatedArrayKeyRector;
100 | use Rector\DeadCode\Rector\Assign\{RemoveDoubleAssignRector,
101 |     RemoveUnusedVariableAssignRector};
102 | use Rector\DeadCode\Rector\BooleanAnd\RemoveAndTrueRector;
103 | use Rector\DeadCode\Rector\ClassConst\RemoveUnusedPrivateClassConstantRector;
104 | use Rector\DeadCode\Rector\ClassMethod\{RemoveDelegatingParentCallRector,
105 |     RemoveEmptyClassMethodRector,
106 |     RemoveLastReturnRector,
107 |     RemoveUnusedConstructorParamRector,
108 |     RemoveUnusedPrivateMethodParameterRector,
109 |     RemoveUnusedPrivateMethodRector,
110 |     RemoveUnusedPromotedPropertyRector,
111 |     RemoveUselessReturnTagRector};
112 | use Rector\DeadCode\Rector\Expression\{RemoveDeadStmtRector,
113 |     SimplifyMirrorAssignRector};
114 | use Rector\DeadCode\Rector\For_\{RemoveDeadContinueRector,
115 |     RemoveDeadIfForeachForRector,
116 |     RemoveDeadLoopRector};
117 | use Rector\DeadCode\Rector\Foreach_\RemoveUnusedForeachKeyRector;
118 | use Rector\DeadCode\Rector\FunctionLike\RemoveDeadReturnRector;
119 | use Rector\DeadCode\Rector\If_\{RemoveUnusedNonEmptyArrayBeforeForeachRector,
120 |     SimplifyIfElseWithSameContentRector,
121 |     UnwrapFutureCompatibleIfPhpVersionRector};
122 | use Rector\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector;
123 | use Rector\DeadCode\Rector\Plus\RemoveDeadZeroAndOneOperationRector;
124 | use Rector\DeadCode\Rector\Property\{RemoveUnusedPrivatePropertyRector,
125 |     RemoveUselessVarTagRector};
126 | use Rector\DeadCode\Rector\PropertyProperty\RemoveNullPropertyInitializationRector;
127 | use Rector\DeadCode\Rector\Return_\RemoveDeadConditionAboveReturnRector;
128 | use Rector\DeadCode\Rector\StaticCall\RemoveParentCallWithoutParentRector;
129 | use Rector\DeadCode\Rector\Stmt\RemoveUnreachableStatementRector;
130 | use Rector\DeadCode\Rector\StmtsAwareInterface\{RemoveJustPropertyFetchForAssignRector,
131 |     RemoveJustVariableAssignRector};
132 | use Rector\DeadCode\Rector\Switch_\RemoveDuplicatedCaseInSwitchRector;
133 | use Rector\DeadCode\Rector\Ternary\TernaryToBooleanOrFalseToBooleanAndRector;
134 | use Rector\DeadCode\Rector\TryCatch\RemoveDeadTryCatchRector;
135 | use Rector\DependencyInjection\Rector\Class_\ActionInjectionToConstructorInjectionRector;
136 | use Rector\EarlyReturn\Rector\Foreach_\ChangeNestedForeachIfsToEarlyContinueRector;
137 | use Rector\EarlyReturn\Rector\If_\{ChangeIfElseValueAssignToEarlyReturnRector,
138 |     ChangeNestedIfsToEarlyReturnRector,
139 |     ChangeOrIfContinueToMultiContinueRector,
140 |     RemoveAlwaysElseRector};
141 | use Rector\EarlyReturn\Rector\Return_\{PreparedValueToEarlyReturnRector,
142 |     ReturnBinaryAndToEarlyReturnRector,
143 |     ReturnBinaryOrToEarlyReturnRector};
144 | use Rector\EarlyReturn\Rector\StmtsAwareInterface\ReturnEarlyIfVariableRector;
145 | use Rector\Naming\Rector\Foreach_\{RenameForeachValueVariableToMatchExprVariableRector,
146 |     RenameForeachValueVariableToMatchMethodCallReturnTypeRector};
147 | use Rector\Php52\Rector\Property\VarToPublicPropertyRector;
148 | use Rector\Php70\Rector\StmtsAwareInterface\IfIssetToCoalescingRector;
149 | use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
150 | use Rector\Php80\Rector\Catch_\RemoveUnusedVariableInCatchRector;
151 | use Rector\Php80\Rector\Class_\{ClassPropertyAssignToConstructorPromotionRector,
152 |     StringableForToStringRector};
153 | use Rector\Php80\Rector\ClassConstFetch\ClassOnThisVariableObjectRector;
154 | use Rector\Php80\Rector\ClassMethod\{AddParamBasedOnParentClassMethodRector,
155 |     FinalPrivateToPrivateVisibilityRector,
156 |     SetStateToStaticRector};
157 | use Rector\Php80\Rector\FuncCall\{ClassOnObjectRector,
158 |     Php8ResourceReturnToObjectRector};
159 | use Rector\Php80\Rector\Identical\{StrEndsWithRector,
160 |     StrStartsWithRector};
161 | use Rector\Php80\Rector\NotIdentical\StrContainsRector;
162 | use Rector\Php80\Rector\Switch_\ChangeSwitchToMatchRector;
163 | use Rector\Php80\Rector\Ternary\GetDebugTypeRector;
164 | use Rector\PHPUnit\Rector\ClassMethod\RemoveEmptyTestMethodRector;
165 | use Rector\Privatization\Rector\Class_\{ChangeGlobalVariablesToPropertiesRector,
166 |     FinalizeClassesWithoutChildrenRector};
167 | use Rector\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector;
168 | use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
169 | use Rector\PSR4\Rector\FileWithoutNamespace\NormalizeNamespaceByPSR4ComposerAutoloadRector;
170 | use Rector\PSR4\Rector\Namespace_\MultipleClassFileToPsr4ClassesRector;
171 | use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;
172 | use Rector\Transform\Rector\FuncCall\FuncCallToConstFetchRector;
173 | use Rector\Transform\Rector\StaticCall\StaticCallToFuncCallRector;
174 | use Rector\Transform\ValueObject\StaticCallToFuncCall;
175 | use Rector\TypeDeclaration\Rector\ArrowFunction\AddArrowFunctionReturnTypeRector;
176 | use Rector\TypeDeclaration\Rector\Class_\{PropertyTypeFromStrictSetterGetterRector,
177 |     ReturnTypeFromStrictTernaryRector};
178 | use Rector\TypeDeclaration\Rector\ClassMethod\{AddMethodCallBasedStrictParamTypeRector,
179 |     AddParamTypeBasedOnPHPUnitDataProviderRector,
180 |     AddReturnTypeDeclarationBasedOnParentClassMethodRector,
181 |     AddVoidReturnTypeWhereNoReturnRector,
182 |     ArrayShapeFromConstantArrayReturnRector,
183 |     BoolReturnTypeFromStrictScalarReturnsRector,
184 |     ParamTypeByMethodCallTypeRector,
185 |     ParamTypeByParentCallTypeRector,
186 |     ReturnAnnotationIncorrectNullableRector,
187 |     ReturnNeverTypeRector,
188 |     ReturnTypeFromReturnDirectArrayRector,
189 |     ReturnTypeFromReturnNewRector,
190 |     ReturnTypeFromStrictBoolReturnExprRector,
191 |     ReturnTypeFromStrictConstantReturnRector,
192 |     ReturnTypeFromStrictNativeCallRector,
193 |     ReturnTypeFromStrictNewArrayRector,
194 |     ReturnTypeFromStrictTypedCallRector,
195 |     ReturnTypeFromStrictTypedPropertyRector};
196 | use Rector\TypeDeclaration\Rector\Closure\AddClosureReturnTypeRector;
197 | use Rector\TypeDeclaration\Rector\Empty_\EmptyOnNullableObjectToInstanceOfRector;
198 | use Rector\TypeDeclaration\Rector\FunctionLike\{AddParamTypeSplFixedArrayRector,
199 |     AddReturnTypeDeclarationFromYieldsRector};
200 | use Rector\TypeDeclaration\Rector\Param\ParamTypeFromStrictTypedPropertyRector;
201 | use Rector\TypeDeclaration\Rector\Property\{TypedPropertyFromAssignsRector,
202 |     TypedPropertyFromStrictConstructorRector,
203 |     TypedPropertyFromStrictGetterMethodReturnTypeRector,
204 |     TypedPropertyFromStrictSetUpRector,
205 |     VarAnnotationIncorrectNullableRector};
206 | 
207 | return static function (RectorConfig $rectorConfig): void {
208 |     $rectorConfig->paths([
209 |         __DIR__ . '/config',
210 |         __DIR__ . '/src',
211 |     ]);
212 | 
213 |     $rectorConfig->ruleWithConfiguration(
214 |         RenameFunctionRector::class,
215 |         [
216 |             'chop' => 'rtrim',
217 |             'doubleval' => 'floatval',
218 |             'fputs' => 'fwrite',
219 |             'gzputs' => 'gzwrites',
220 |             'ini_alter' => 'ini_set',
221 |             'is_double' => 'is_float',
222 |             'is_integer' => 'is_int',
223 |             'is_long' => 'is_int',
224 |             'is_real' => 'is_float',
225 |             'is_writeable' => 'is_writable',
226 |             'join' => 'implode',
227 |             'key_exists' => 'array_key_exists',
228 |             'mbstrcut' => 'mb_strcut',
229 |             'mbstrlen' => 'mb_strlen',
230 |             'mbstrpos' => 'mb_strpos',
231 |             'mbstrrpos' => 'mb_strrpos',
232 |             'mbsubstr' => 'mb_substr',
233 |             'pos' => 'current',
234 |             'sizeof' => 'count',
235 |             'split' => 'explode',
236 |             'strchr' => 'strstr',
237 |         ],
238 |     );
239 | 
240 |     $rectorConfig->ruleWithConfiguration(
241 |         StaticCallToFuncCallRector::class,
242 |         [
243 |             new StaticCallToFuncCall('Nette\\Utils\\Strings', 'contains', 'str_contains'),
244 |             new StaticCallToFuncCall('Nette\\Utils\\Strings', 'endsWith', 'str_ends_with'),
245 |             new StaticCallToFuncCall('Nette\\Utils\\Strings', 'startsWith', 'str_starts_with'),
246 |         ],
247 |     );
248 | 
249 |     $rectorConfig->ruleWithConfiguration(
250 |         ArgumentAdderRector::class,
251 |         [new ArgumentAdder('Nette\\Utils\\Strings', 'replace', 2, 'replacement', '')],
252 |     );
253 | 
254 |     $rectorConfig->ruleWithConfiguration(
255 |         RenameFunctionRector::class,
256 |         [
257 |             'pg_clientencoding' => 'pg_client_encoding',
258 |             'pg_cmdtuples' => 'pg_affected_rows',
259 |             'pg_errormessage' => 'pg_last_error',
260 |             'pg_fieldisnull' => 'pg_field_is_null',
261 |             'pg_fieldname' => 'pg_field_name',
262 |             'pg_fieldnum' => 'pg_field_num',
263 |             'pg_fieldprtlen' => 'pg_field_prtlen',
264 |             'pg_fieldsize' => 'pg_field_size',
265 |             'pg_fieldtype' => 'pg_field_type',
266 |             'pg_freeresult' => 'pg_free_result',
267 |             'pg_getlastoid' => 'pg_last_oid',
268 |             'pg_loclose' => 'pg_lo_close',
269 |             'pg_locreate' => 'pg_lo_create',
270 |             'pg_loexport' => 'pg_lo_export',
271 |             'pg_loimport' => 'pg_lo_import',
272 |             'pg_loopen' => 'pg_lo_open',
273 |             'pg_loread' => 'pg_lo_read',
274 |             'pg_loreadall' => 'pg_lo_read_all',
275 |             'pg_lounlink' => 'pg_lo_unlink',
276 |             'pg_lowrite' => 'pg_lo_write',
277 |             'pg_numfields' => 'pg_num_fields',
278 |             'pg_numrows' => 'pg_num_rows',
279 |             'pg_result' => 'pg_fetch_result',
280 |             'pg_setclientencoding' => 'pg_set_client_encoding',
281 |         ],
282 |     );
283 | 
284 |     $rectorConfig->ruleWithConfiguration(
285 |         FunctionArgumentDefaultValueReplacerRector::class,
286 |         [
287 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, 'gte', 'ge'),
288 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, 'lte', 'le'),
289 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, '', '!='),
290 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, '!', '!='),
291 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, 'g', 'gt'),
292 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, 'l', 'lt'),
293 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, 'gte', 'ge'),
294 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, 'lte', 'le'),
295 |             new ReplaceFuncCallArgumentDefaultValue('version_compare', 2, 'n', 'ne'),
296 |         ],
297 |     );
298 | 
299 |     $rectorConfig->ruleWithConfiguration(
300 |         FuncCallToConstFetchRector::class,
301 |         [
302 |             'php_sapi_name' => 'PHP_SAPI',
303 |             'pi' => 'M_PI',
304 |         ],
305 |     );
306 | 
307 |     $rectorConfig->rules([
308 |         AbsolutizeRequireAndIncludePathRector::class,
309 |         ActionInjectionToConstructorInjectionRector::class,
310 |         AddArrayDefaultToArrayPropertyRector::class,
311 |         AddArrowFunctionReturnTypeRector::class,
312 |         AddClosureReturnTypeRector::class,
313 |         AddMethodCallBasedStrictParamTypeRector::class,
314 |         AddParamBasedOnParentClassMethodRector::class,
315 |         AddParamTypeBasedOnPHPUnitDataProviderRector::class,
316 |         AddParamTypeSplFixedArrayRector::class,
317 |         AddReturnTypeDeclarationBasedOnParentClassMethodRector::class,
318 |         AddReturnTypeDeclarationFromYieldsRector::class,
319 |         AddVoidReturnTypeWhereNoReturnRector::class,
320 |         AndAssignsToSeparateLinesRector::class,
321 |         ArrayKeyExistsTernaryThenValueToCoalescingRector::class,
322 |         ArrayKeysAndInArrayToArrayKeyExistsRector::class,
323 |         ArrayMergeOfNonArraysToSimpleArrayRector::class,
324 |         ArrayShapeFromConstantArrayReturnRector::class,
325 |         BinarySwitchToIfElseRector::class,
326 |         BooleanNotIdenticalToNotIdenticalRector::class,
327 |         BoolvalToTypeCastRector::class,
328 |         CallableThisArrayToAnonymousFunctionRector::class,
329 |         CallUserFuncArrayToVariadicRector::class,
330 |         CallUserFuncToMethodCallRector::class,
331 |         CallUserFuncToMethodCallRector::class,
332 |         CallUserFuncWithArrowFunctionToInlineRector::class,
333 |         CatchExceptionNameMatchingTypeRector::class,
334 |         ChangeArrayPushToArrayAssignRector::class,
335 |         ChangeGlobalVariablesToPropertiesRector::class,
336 |         ChangeIfElseValueAssignToEarlyReturnRector::class,
337 |         ChangeNestedForeachIfsToEarlyContinueRector::class,
338 |         ChangeNestedIfsToEarlyReturnRector::class,
339 |         ChangeOrIfContinueToMultiContinueRector::class,
340 |         ChangeSwitchToMatchRector::class,
341 |         ClassOnObjectRector::class,
342 |         ClassOnThisVariableObjectRector::class,
343 |         ClassPropertyAssignToConstructorPromotionRector::class,
344 |         CombinedAssignRector::class,
345 |         CombineIfRector::class,
346 |         CommonNotEqualRector::class,
347 |         CompactToVariablesRector::class,
348 |         CompleteDynamicPropertiesRector::class,
349 |         ConsecutiveNullCompareReturnsToNullCoalesceQueueRector::class,
350 |         ConsistentImplodeRector::class,
351 |         CountArrayToEmptyArrayComparisonRector::class,
352 |         CountArrayToEmptyArrayComparisonRector::class,
353 |         EmptyOnNullableObjectToInstanceOfRector::class,
354 |         EncapsedStringsToSprintfRector::class,
355 |         ExplicitBoolCompareRector::class,
356 |         FinalizeClassesWithoutChildrenRector::class,
357 |         FinalPrivateToPrivateVisibilityRector::class,
358 |         FlipTypeControlToUseExclusiveTypeRector::class,
359 |         FloatvalToTypeCastRector::class,
360 |         ForeachItemsAssignToEmptyArrayToAssignRector::class,
361 |         ForeachToInArrayRector::class,
362 |         ForRepeatedCountToOwnVariableRector::class,
363 |         FuncGetArgsToVariadicParamRector::class,
364 |         FuncGetArgsToVariadicParamRector::class,
365 |         GetClassToInstanceOfRector::class,
366 |         GetDebugTypeRector::class,
367 |         InlineArrayReturnAssignRector::class,
368 |         InlineConstructorDefaultToPropertyRector::class,
369 |         InlineIfToExplicitIfRector::class,
370 |         InlineIsAInstanceOfRector::class,
371 |         IntvalToTypeCastRector::class,
372 |         IsAWithStringWithThirdArgumentRector::class,
373 |         IssetOnPropertyObjectToPropertyExistsRector::class,
374 |         JoinStringConcatRector::class,
375 |         LogicalToBooleanRector::class,
376 |         MakeInheritedMethodVisibilitySameAsParentRector::class,
377 |         MultipleClassFileToPsr4ClassesRector::class,
378 |         NewlineBeforeNewAssignSetRector::class,
379 |         NewStaticToNewSelfRector::class,
380 |         NormalizeNamespaceByPSR4ComposerAutoloadRector::class,
381 |         NullableCompareToNullRector::class,
382 |         OptionalParametersAfterRequiredRector::class,
383 |         OptionalParametersAfterRequiredRector::class,
384 |         ParamTypeByMethodCallTypeRector::class,
385 |         ParamTypeByParentCallTypeRector::class,
386 |         ParamTypeFromStrictTypedPropertyRector::class,
387 |         Php8ResourceReturnToObjectRector::class,
388 |         PostIncDecToPreIncDecRector::class,
389 |         PreparedValueToEarlyReturnRector::class,
390 |         PrivatizeFinalClassMethodRector::class,
391 |         PrivatizeFinalClassPropertyRector::class,
392 |         PropertyTypeFromStrictSetterGetterRector::class,
393 |         RemoveAlwaysElseRector::class,
394 |         RemoveAlwaysTrueConditionSetInConstructorRector::class,
395 |         RemoveAndTrueRector::class,
396 |         RemoveDeadConditionAboveReturnRector::class,
397 |         RemoveDeadContinueRector::class,
398 |         RemoveDeadIfForeachForRector::class,
399 |         RemoveDeadLoopRector::class,
400 |         RemoveDeadReturnRector::class,
401 |         RemoveDeadStmtRector::class,
402 |         RemoveDeadTryCatchRector::class,
403 |         RemoveDeadZeroAndOneOperationRector::class,
404 |         RemoveDelegatingParentCallRector::class,
405 |         RemoveDoubleAssignRector::class,
406 |         RemoveDuplicatedArrayKeyRector::class,
407 |         RemoveDuplicatedCaseInSwitchRector::class,
408 |         RemoveEmptyClassMethodRector::class,
409 |         RemoveEmptyTestMethodRector::class,
410 |         RemoveExtraParametersRector::class,
411 |         RemoveFinalFromConstRector::class,
412 |         RemoveJustPropertyFetchForAssignRector::class,
413 |         RemoveJustVariableAssignRector::class,
414 |         RemoveLastReturnRector::class,
415 |         RemoveNonExistingVarAnnotationRector::class,
416 |         RemoveNullPropertyInitializationRector::class,
417 |         RemoveParentCallWithoutParentRector::class,
418 |         RemoveParentCallWithoutParentRector::class,
419 |         RemoveSoleValueSprintfRector::class,
420 |         RemoveUnreachableStatementRector::class,
421 |         RemoveUnusedConstructorParamRector::class,
422 |         RemoveUnusedForeachKeyRector::class,
423 |         RemoveUnusedNonEmptyArrayBeforeForeachRector::class,
424 |         RemoveUnusedPrivateClassConstantRector::class,
425 |         RemoveUnusedPrivateMethodParameterRector::class,
426 |         RemoveUnusedPrivatePropertyRector::class,
427 |         RemoveUnusedPromotedPropertyRector::class,
428 |         RemoveUnusedVariableAssignRector::class,
429 |         RemoveUnusedVariableInCatchRector::class,
430 |         RemoveUselessReturnTagRector::class,
431 |         RemoveUselessVarTagRector::class,
432 |         RenameForeachValueVariableToMatchExprVariableRector::class,
433 |         RenameForeachValueVariableToMatchMethodCallReturnTypeRector::class,
434 |         ReplaceMultipleBooleanNotRector::class,
435 |         ReturnAnnotationIncorrectNullableRector::class,
436 |         ReturnBinaryAndToEarlyReturnRector::class,
437 |         ReturnBinaryOrToEarlyReturnRector::class,
438 |         ReturnEarlyIfVariableRector::class,
439 |         ReturnNeverTypeRector::class,
440 |         ReturnTypeFromReturnDirectArrayRector::class,
441 |         ReturnTypeFromReturnNewRector::class,
442 |         ReturnTypeFromStrictBoolReturnExprRector::class,
443 |         ReturnTypeFromStrictConstantReturnRector::class,
444 |         ReturnTypeFromStrictNativeCallRector::class,
445 |         ReturnTypeFromStrictNewArrayRector::class,
446 |         ReturnTypeFromStrictScalarReturnExprRector::class,
447 |         ReturnTypeFromStrictScalarReturnExprRector::class,
448 |         ReturnTypeFromStrictTernaryRector::class,
449 |         ReturnTypeFromStrictTypedCallRector::class,
450 |         ReturnTypeFromStrictTypedPropertyRector::class,
451 |         SeparateMultiUseImportsRector::class,
452 |         SetStateToStaticRector::class,
453 |         SetTypeToCastRector::class,
454 |         ShortenElseIfRector::class,
455 |         SimplifyArraySearchRector::class,
456 |         SimplifyBoolIdenticalTrueRector::class,
457 |         SimplifyConditionsRector::class,
458 |         SimplifyDeMorganBinaryRector::class,
459 |         SimplifyEmptyArrayCheckRector::class,
460 |         SimplifyEmptyCheckOnEmptyArrayRector::class,
461 |         SimplifyForeachToArrayFilterRector::class,
462 |         SimplifyForeachToCoalescingRector::class,
463 |         SimplifyFuncGetArgsCountRector::class,
464 |         SimplifyIfElseToTernaryRector::class,
465 |         SimplifyIfElseWithSameContentRector::class,
466 |         SimplifyIfNotNullReturnRector::class,
467 |         SimplifyIfNullableReturnRector::class,
468 |         SimplifyIfReturnBoolRector::class,
469 |         SimplifyInArrayValuesRector::class,
470 |         SimplifyMirrorAssignRector::class,
471 |         SimplifyRegexPatternRector::class,
472 |         SimplifyStrposLowerRector::class,
473 |         SimplifyTautologyTernaryRector::class,
474 |         SimplifyUselessVariableRector::class,
475 |         SingleInArrayToCompareRector::class,
476 |         SingularSwitchToIfRector::class,
477 |         SplitDoubleAssignRector::class,
478 |         SplitGroupedClassConstantsRector::class,
479 |         SplitGroupedPropertiesRector::class,
480 |         StaticArrowFunctionRector::class,
481 |         StaticClosureRector::class,
482 |         StrContainsRector::class,
483 |         StrEndsWithRector::class,
484 |         StrictArraySearchRector::class,
485 |         StringableForToStringRector::class,
486 |         StrlenZeroToIdenticalEmptyStringRector::class,
487 |         StrStartsWithRector::class,
488 |         StrvalToTypeCastRector::class,
489 |         SwitchNegatedTernaryRector::class,
490 |         SymplifyQuoteEscapeRector::class,
491 |         TernaryConditionVariableAssignmentRector::class,
492 |         TernaryEmptyArrayArrayDimFetchToCoalesceRector::class,
493 |         TernaryFalseExpressionToIfRector::class,
494 |         TernaryToBooleanOrFalseToBooleanAndRector::class,
495 |         ThrowWithPreviousExceptionRector::class,
496 |         TypedPropertyFromAssignsRector::class,
497 |         TypedPropertyFromStrictConstructorRector::class,
498 |         TypedPropertyFromStrictGetterMethodReturnTypeRector::class,
499 |         TypedPropertyFromStrictSetUpRector::class,
500 |         UnnecessaryTernaryExpressionRector::class,
501 |         UnSpreadOperatorRector::class,
502 |         UnusedForeachValueToArrayKeysRector::class,
503 |         UnwrapFutureCompatibleIfPhpVersionRector::class,
504 |         UnwrapSprintfOneArgumentRector::class,
505 |         UseClassKeywordForClassNameResolutionRector::class,
506 |         UseIdenticalOverEqualWithSameTypeRector::class,
507 |         UseIncrementAssignRector::class,
508 |         VarAnnotationIncorrectNullableRector::class,
509 |         VarConstantCommentRector::class,
510 |         VarToPublicPropertyRector::class,
511 |         VersionCompareFuncCallToConstantRector::class,
512 |         WrapEncapsedVariableInCurlyBracesRector::class,
513 |         IfIssetToCoalescingRector::class,
514 |         CleanupUnneededNullsafeOperatorRector::class,
515 |         BoolReturnTypeFromStrictScalarReturnsRector::class,
516 |     ]);
517 | };
518 | 


--------------------------------------------------------------------------------
/app/src/Application.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace Auth0\Quickstart;
  6 | 
  7 | use Auth0\SDK\Auth0;
  8 | use Auth0\SDK\Configuration\SdkConfiguration;
  9 | use Auth0\SDK\Exception\InvalidTokenException;
 10 | 
 11 | final class Application
 12 | {
 13 |     /**
 14 |      * An instance of our SDK's Auth0 configuration, so we could potentially make changes later.
 15 |      */
 16 |     private SdkConfiguration $configuration;
 17 | 
 18 |     /**
 19 |      * An instance of our application's error handling class, for gracefully reporting exceptions.
 20 |      */
 21 |     private ApplicationErrorHandler $errorHandler;
 22 | 
 23 |     /**
 24 |      * An instance of our application's router class, for handling end-user requests to URIs.
 25 |      */
 26 |     private ApplicationRouter $router;
 27 | 
 28 |     /**
 29 |      * An instance of the Auth0 SDK.
 30 |      */
 31 |     private Auth0 $sdk;
 32 | 
 33 |     /**
 34 |      * An instance of our application's template rendering helper class, for sending responses.
 35 |      */
 36 |     private ApplicationTemplates $templates;
 37 | 
 38 |     /**
 39 |      * Setup our Quickstart application.
 40 |      *
 41 |      * @param array<string,mixed> $env Auth0 configuration imported from .env file.
 42 |      */
 43 |     public function __construct(
 44 |         array $env,
 45 |     ) {
 46 |         // Configure the SDK using our .env configuration.
 47 |         $this->setupAuth0($env);
 48 | 
 49 |         // Setup our template engine, for sending responses back to the browser.
 50 |         $this->templates = new ApplicationTemplates($this);
 51 |         $this->errorHandler = new ApplicationErrorHandler($this);
 52 |         $this->router = new ApplicationRouter($this);
 53 |     }
 54 | 
 55 |     /**
 56 |      * Return our instance of Auth0.
 57 |      */
 58 |     public function &getSdk(): Auth0
 59 |     {
 60 |         return $this->sdk;
 61 |     }
 62 | 
 63 |     /**
 64 |      * Return our instance of SdkConfiguration.
 65 |      */
 66 |     public function &getConfiguration(): SdkConfiguration
 67 |     {
 68 |         return $this->configuration;
 69 |     }
 70 | 
 71 |     /**
 72 |      * Return our instance of ApplicationTemplates.
 73 |      */
 74 |     public function &getTemplate(): ApplicationTemplates
 75 |     {
 76 |         return $this->templates;
 77 |     }
 78 | 
 79 |     /**
 80 |      * Return our instance of ApplicationErrorHandler.
 81 |      */
 82 |     public function &getErrorHandler(): ApplicationErrorHandler
 83 |     {
 84 |         return $this->errorHandler;
 85 |     }
 86 | 
 87 |     /**
 88 |      * Return our instance of ApplicationRouter.
 89 |      */
 90 |     public function &getRouter(): ApplicationRouter
 91 |     {
 92 |         return $this->router;
 93 |     }
 94 | 
 95 |     /**
 96 |      * Called from the ApplicationRouter when end user loads '/api'.
 97 |      *
 98 |      * @param ApplicationRouter $router
 99 |      */
100 |     public function onApiRoute(
101 |         ApplicationRouter $router,
102 |     ): void {
103 |         $session = $this->getToken();
104 | 
105 |         // Send response to browser.
106 |         $this->templates->render('logged-' . ($session instanceof \Auth0\SDK\Contract\TokenInterface ? 'in' : 'out'), [
107 |             'session' => $session,
108 |             'router' => $router,
109 |         ]);
110 |     }
111 | 
112 |     /**
113 |      * Called from the ApplicationRouter when end user loads an unknown route.
114 |      *
115 |      * @param ApplicationRouter $router
116 |      */
117 |     public function onError404(
118 |         ApplicationRouter $router,
119 |     ): void {
120 |         $router->setHttpStatus(404);
121 |     }
122 | 
123 |     /**
124 |      * Called from the ApplicationRouter when end user loads '/'.
125 |      *
126 |      * @param ApplicationRouter $router
127 |      */
128 |     public function onIndexRoute(
129 |         ApplicationRouter $router,
130 |     ): void {
131 |         // Send response to browser.
132 |         $this->templates->render('spa', [
133 |             'config' => $this->getConfiguration(),
134 |             'router' => $router,
135 |         ]);
136 |     }
137 | 
138 |     /**
139 |      * "Run" our application, responding to end-user requests.
140 |      */
141 |     public function run(): void
142 |     {
143 |         // Intercept exceptions to gracefully report them.
144 |         $this->errorHandler->hook();
145 | 
146 |         // Handle incoming requests through the router.
147 |         $this->router->run();
148 |     }
149 | 
150 |     /**
151 |      * Configure the Auth0 SDK using the .env configuration.
152 |      *
153 |      * @param array<string,mixed> $env Auth0 configuration imported from .env file.
154 |      */
155 |     public function setupAuth0(
156 |         array $env,
157 |     ): void {
158 |         // Build our SdkConfiguration.
159 |         $this->configuration = new SdkConfiguration([
160 |             'domain' => $env['AUTH0_DOMAIN'] ?? null,
161 |             'clientId' => $env['AUTH0_CLIENT_ID'] ?? null,
162 |             'clientSecret' => $env['AUTH0_CLIENT_SECRET'] ?? null,
163 |             'audience' => ($env['AUTH0_AUDIENCE'] ?? null) !== null ? [trim($env['AUTH0_AUDIENCE'])] : null,
164 |             'organization' => ($env['AUTH0_ORGANIZATION'] ?? null) !== null ? [trim($env['AUTH0_ORGANIZATION'])] : null,
165 |             'strategy' => SdkConfiguration::STRATEGY_API,
166 |         ]);
167 | 
168 |         // Setup the Auth0 SDK.
169 |         $this->sdk = new Auth0($this->configuration);
170 |     }
171 | 
172 |     /**
173 |      * Process a token from the request query or via request headers.
174 |      *
175 |      * @throws InvalidTokenException When an invalid token is provided.
176 |      */
177 |     private function getToken(): ?\Auth0\SDK\Contract\TokenInterface
178 |     {
179 |         // Look for token in ?token=... param, followed by an `HTTP_AUTHORIZATION` or `Authorization` header.
180 |         $token = $_GET['token'] ?? $_SERVER['HTTP_AUTHORIZATION'] ?? $_SERVER['Authorization'] ?? null;
181 | 
182 |         // If no token was present, abort processing.
183 |         if (null === $token) {
184 |             return null;
185 |         }
186 | 
187 |         // Trim whitespace from token string.
188 |         $token = trim($token);
189 | 
190 |         // Remove the 'Bearer ' prefix, if present, in the event we're using an Authorization header that's using it.
191 |         if (str_starts_with($token, 'Bearer ')) {
192 |             $token = substr($token, 7);
193 |         }
194 | 
195 |         return $this->getSdk()->decode($token, null, null, null, null, null, null, \Auth0\SDK\Token::TYPE_TOKEN);
196 |     }
197 | }
198 | 


--------------------------------------------------------------------------------
/app/src/ApplicationErrorHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Auth0\Quickstart;
 6 | 
 7 | use Auth0\SDK\Exception\Auth0Exception;
 8 | use Throwable;
 9 | 
10 | use function array_key_exists;
11 | 
12 | final class ApplicationErrorHandler
13 | {
14 |     /**
15 |      * An instance of our Quickstart Application.
16 |      */
17 |     private Application $app;
18 | 
19 |     /**
20 |      * ApplicationErrorHandler constructor.
21 |      *
22 |      * @param Application $app An instance of our Quickstart Application.
23 |      */
24 |     public function __construct(
25 |         Application &$app,
26 |     ) {
27 |         $this->app = &$app;
28 |     }
29 | 
30 |     /**
31 |      * Setup onException() as the exception handler with PHP for this request.
32 |      */
33 |     public function hook(): void
34 |     {
35 |         set_exception_handler(function (Throwable $throwable): void {
36 |             $this->onException($throwable);
37 |         });
38 |     }
39 | 
40 |     /**
41 |      * Render a throwable error in a graceful way.
42 |      *
43 |      * @param Throwable $throwable The throwable to report.
44 |      */
45 |     public function onException(
46 |         Throwable $throwable,
47 |     ): void {
48 |         $exception = $throwable;
49 | 
50 |         $code = $exception->getCode();
51 |         $error = $exception->getMessage();
52 |         $file = $exception->getFile();
53 |         $line = $exception->getLine();
54 | 
55 |         if ($exception instanceof Auth0Exception) {
56 |             $backtrace = $exception->getTrace();
57 | 
58 |             if (array_key_exists(1, $backtrace)) {
59 |                 $code = $backtrace[1]['line'];
60 |                 $file = $backtrace[1]['file'];
61 |                 $line = $backtrace[1]['line'];
62 |             }
63 |         }
64 | 
65 |         $this->app->getTemplate()->render('error', [
66 |             'code' => $code,
67 |             'error' => $error,
68 |             'file' => $file,
69 |             'line' => $line,
70 |             'router' => $this->app->getRouter(),
71 |         ]);
72 | 
73 |         exit;
74 |     }
75 | }
76 | 


--------------------------------------------------------------------------------
/app/src/ApplicationRouter.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace Auth0\Quickstart;
  6 | 
  7 | use function array_key_exists;
  8 | 
  9 | final class ApplicationRouter
 10 | {
 11 |     /**
 12 |      * An instance of our Quickstart Application.
 13 |      */
 14 |     private Application $app;
 15 | 
 16 |     /**
 17 |      * ApplicationRouter constructor.
 18 |      *
 19 |      * @param Application $app An instance of our Quickstart Application.
 20 |      */
 21 |     public function __construct(
 22 |         Application &$app,
 23 |     ) {
 24 |         $this->app = &$app;
 25 |     }
 26 | 
 27 |     /**
 28 |      * Return the request method (GET, POST, etc.).
 29 |      */
 30 |     public function getMethod(): string
 31 |     {
 32 |         return $_SERVER['REQUEST_METHOD'] ?? 'GET';
 33 |     }
 34 | 
 35 |     /**
 36 |      * Return (and optionally manipulate) the currently requested uri.
 37 |      *
 38 |      * @param null|string $path  Unless null, manipulates the resulting path to match the value.
 39 |      * @param null|string $query Unless, manipulates the resulting query to match the value.
 40 |      */
 41 |     public function getUri(
 42 |         ?string $path = null,
 43 |         ?string $query = null,
 44 |     ): string {
 45 |         $httpScheme = $_SERVER['HTTPS'] ?? '';
 46 |         $httpScheme = 'on' === $httpScheme ? 'https' : 'http';
 47 | 
 48 |         $httpPort = (int) $_SERVER['SERVER_PORT'];
 49 |         $httpHost = $_SERVER['HTTP_HOST'] ?? $_SERVER['SERVER_NAME'];
 50 |         $httpHost = preg_replace('/\:' . $httpPort . '$/', '', $httpHost);
 51 | 
 52 |         $httpRequest = (string) $_SERVER['REQUEST_URI'];
 53 |         $httpUri = $httpScheme . '://' . $httpHost . (80 !== $httpPort ? ':' . $httpPort : '') . $httpRequest;
 54 | 
 55 |         // If we aren't making changes, simply return the uri.
 56 |         if (null === $path && null === $query) {
 57 |             return $httpUri;
 58 |         }
 59 | 
 60 |         // Parse a url into it's components so we can manipulate them more easily.
 61 |         $parsedUri = parse_url($httpUri);
 62 | 
 63 |         if (false === $parsedUri) {
 64 |             return $httpUri;
 65 |         }
 66 | 
 67 |         $parsedUri['scheme'] ??= 'http';
 68 |         $parsedUri['host'] ??= $httpHost;
 69 |         $parsedUri['path'] ??= '';
 70 |         $parsedUri['query'] = '?' . ($parsedUri['query'] ?? '');
 71 | 
 72 |         // Manipulate the /path portion of the uri.
 73 |         if (null !== $path) {
 74 |             $parsedUri['path'] = $path;
 75 |         }
 76 | 
 77 |         // Manipulate the ?query portion of the uri.
 78 |         if (null !== $query) {
 79 |             $parsedUri['query'] = $query;
 80 |         }
 81 | 
 82 |         if (! array_key_exists('port', $parsedUri)) {
 83 |             $parsedUri['port'] = 80;
 84 |         }
 85 | 
 86 |         if ('?' === $parsedUri['query']) {
 87 |             $parsedUri['query'] = '';
 88 |         }
 89 | 
 90 |         if ('' !== $parsedUri['query']) {
 91 |             $parsedUri['query'] = '?' . $parsedUri['query'];
 92 |         }
 93 | 
 94 |         // Reconstruct the manipulated uri and return it.
 95 |         return $parsedUri['scheme'] . '://' . $parsedUri['host'] . (80 !== $parsedUri['port'] ? ':' . $parsedUri['port'] : '') . $parsedUri['path'] . $parsedUri['query'];
 96 |     }
 97 | 
 98 |     /**
 99 |      * Process the current request and route it to the class handler.
100 |      *
101 |      * @param string $uri The new uri to redirect the end user to.
102 |      */
103 |     public function redirect(
104 |         string $uri,
105 |     ): void {
106 |         header('Location: ' . $uri, true, 303);
107 |         exit;
108 |     }
109 | 
110 |     /**
111 |      * Process the current request and route it to the class handler.
112 |      */
113 |     public function run(): void
114 |     {
115 |         $requestUri = parse_url($this->getUri(), PHP_URL_PATH);
116 | 
117 |         $routed = false;
118 | 
119 |         if ('/' === $requestUri) {
120 |             $this->app->onIndexRoute($this);
121 |             $routed = true;
122 |         }
123 | 
124 |         if ('/api' === $requestUri) {
125 |             $this->setHeaders();
126 |             $this->app->onApiRoute($this);
127 |             $routed = true;
128 |         }
129 | 
130 |         if (false === $routed) {
131 |             $this->setHeaders();
132 |             $this->app->onError404($this);
133 |         }
134 | 
135 |         exit;
136 |     }
137 | 
138 |     /**
139 |      * Issue HTTP headers to disable browser caching.
140 |      */
141 |     public function setHeaders(): void
142 |     {
143 |         header('Access-Control-Allow-Origin: *');
144 |         header('Content-Type: application/json; charset=UTF-8');
145 |         header('Access-Control-Allow-Methods: GET');
146 |         header('Access-Control-Max-Age: 3600');
147 |         header('Access-Control-Allow-Headers: Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With');
148 |         header('Cache-Control: no-cache, must-revalidate');
149 |         header('Expires: Sat, 26 Jul 1997 05:00:00 GMT');
150 |     }
151 | 
152 |     /**
153 |      * Issue a HTTP response code header.
154 |      *
155 |      * @param int $status The HTTP status code to send.
156 |      */
157 |     public function setHttpStatus(
158 |         int $status,
159 |     ): void {
160 |         http_response_code($status);
161 |     }
162 | }
163 | 


--------------------------------------------------------------------------------
/app/src/ApplicationTemplates.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace Auth0\Quickstart;
  6 | 
  7 | use Exception;
  8 | use LogicException;
  9 | use Throwable;
 10 | 
 11 | use function array_key_exists;
 12 | 
 13 | final class ApplicationTemplates
 14 | {
 15 |     /**
 16 |      * An instance of our Quickstart Application.
 17 |      */
 18 |     private Application $app;
 19 | 
 20 |     /**
 21 |      * State machine of the template being rendered.
 22 |      *
 23 |      * @var array{section: null|string, sections: array<string>, layout: null|array{name: string, variables: array<mixed>}}
 24 |      */
 25 |     private array $state = [
 26 |         'sections' => [],
 27 |         'section' => null,
 28 |         'layout' => null,
 29 |     ];
 30 | 
 31 |     /**
 32 |      * ApplicationTemplates constructor.
 33 |      *
 34 |      * @param Application $app An instance of our Quickstart Application.
 35 |      */
 36 |     public function __construct(
 37 |         Application &$app,
 38 |     ) {
 39 |         $this->app = &$app;
 40 |     }
 41 | 
 42 |     /**
 43 |      * Render a template as the browser response, then exit.
 44 |      *
 45 |      * @param string       $template  The name of the template to use.
 46 |      * @param array<mixed> $variables Any variables the template should have access to use.
 47 |      */
 48 |     public function render(
 49 |         string $template,
 50 |         array $variables = [],
 51 |     ): void {
 52 |         $this->state = [
 53 |             'sections' => [],
 54 |             'section' => null,
 55 |             'layout' => null,
 56 |         ];
 57 | 
 58 |         while (ob_get_level() >= 1) {
 59 |             ob_end_clean();
 60 |         }
 61 | 
 62 |         echo $this->renderTemplate($template, $variables);
 63 |         exit;
 64 |     }
 65 | 
 66 |     /**
 67 |      * Define a container layout in which to render a template.
 68 |      *
 69 |      * @param string       $name      The name of the layout template to use.
 70 |      * @param array<mixed> $variables Any additional variables the layout template should have access to use.
 71 |      */
 72 |     private function layout(
 73 |         string $name,
 74 |         array $variables = [],
 75 |     ): void {
 76 |         $this->state['layout'] = [
 77 |             'name' => $name,
 78 |             'variables' => $variables,
 79 |         ];
 80 |     }
 81 | 
 82 |     /**
 83 |      * Render a template, and return the content as a string.
 84 |      *
 85 |      * @param string       $template  The name of the template to use.
 86 |      * @param array<mixed> $variables Any variables the template should have access to use.
 87 |      */
 88 |     private function renderTemplate(
 89 |         string $template,
 90 |         array $variables = [],
 91 |     ): string {
 92 |         // Keep track of the output buffering 'level'.
 93 |         $level = 0;
 94 | 
 95 |         // Resolve the requested template to it's file path:
 96 |         $templatePath = implode(DIRECTORY_SEPARATOR, [APP_ROOT, 'templates', $template . '.php']);
 97 | 
 98 |         // Extract $variables into current scope, for use in template.
 99 |         extract($variables);
100 | 
101 |         if (! file_exists($templatePath)) {
102 |             throw new Exception(sprintf('Template file not found: %s', $template));
103 |         }
104 | 
105 |         try {
106 |             $level = ob_get_level();
107 |             ob_start();
108 | 
109 |             include $templatePath;
110 | 
111 |             $content = ob_get_clean();
112 | 
113 |             if (null !== $this->state['layout']) {
114 |                 $layoutTemplate = $this->state['layout']['name'];
115 |                 $layoutVariables = array_merge($variables, $this->state['layout']['variables']);
116 | 
117 |                 $this->state['sections']['content'] = $content;
118 |                 $this->state['layout'] = null;
119 | 
120 |                 $content = $this->renderTemplate($layoutTemplate, $layoutVariables);
121 |             }
122 | 
123 |             if (false !== $content) {
124 |                 return trim($content);
125 |             }
126 | 
127 |             return '';
128 |         } catch (Throwable $throwable) {
129 |             while (ob_get_level() > $level) {
130 |                 ob_end_clean();
131 |             }
132 | 
133 |             throw $throwable;
134 |         }
135 |     }
136 | 
137 |     /**
138 |      * Render a section into the template, if it's content has been set.
139 |      *
140 |      * @param string $sectionName Name of the section to render into the template.
141 |      */
142 |     private function section(
143 |         string $sectionName,
144 |     ): string {
145 |         return $this->state['sections'][$sectionName] ?? '';
146 |     }
147 | 
148 |     /**
149 |      * Start capturing a template block as new section content.
150 |      *
151 |      * @param string $sectionName Name of the section to begin capturing.
152 |      */
153 |     private function start(
154 |         string $sectionName,
155 |     ): void {
156 |         if (null !== $this->state['section']) {
157 |             throw new LogicException('Nested sections are not supported.');
158 |         }
159 | 
160 |         $this->state['section'] = $sectionName;
161 | 
162 |         ob_start();
163 |     }
164 | 
165 |     /**
166 |      * Stop capturing a previously started template block, and store the section content for use.
167 |      */
168 |     private function stop(): void
169 |     {
170 |         if (null === $this->state['section']) {
171 |             throw new LogicException('You must start a section before stopping it.');
172 |         }
173 | 
174 |         if (array_key_exists($this->state['section'], $this->state['sections'])) {
175 |             $this->state['sections'][$this->state['section']] = '';
176 |         }
177 | 
178 |         $this->state['sections'][$this->state['section']] = ob_get_clean();
179 |         $this->state['section'] = null;
180 |     }
181 | }
182 | 


--------------------------------------------------------------------------------
/app/src/Contract/QuickstartExample.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Auth0\Quickstart\Contract;
 6 | 
 7 | interface QuickstartExample
 8 | {
 9 |     public function setup(): self;
10 | }
11 | 


--------------------------------------------------------------------------------
/app/templates/_json.php:
--------------------------------------------------------------------------------
1 | {
2 |     <?php echo trim($this->section('body')) ?>,
3 |     "meta": {
4 |         "bugs": "https://github.com/auth0-samples/auth0-php-api-samples",
5 |         "questions": "https://community.auth0.com/tag/auth0-php"
6 |     }
7 | }
8 | 


--------------------------------------------------------------------------------
/app/templates/error.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 |     $this->layout('_json');
 3 |     $this->start('body');
 4 | ?>
 5 |     "errors": [
 6 |         {
 7 |             "title": "<?php echo addcslashes($error, '"') ?>"
 8 |         }
 9 |     ]
10 | <?php $this->stop() ?>
11 | 


--------------------------------------------------------------------------------
/app/templates/logged-in.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 |     $this->layout('_json');
 3 |     $this->start('body');
 4 | ?>
 5 |     "data": {
 6 |         "authenticated": true,
 7 |         "user": <?php
 8 |             $user = json_encode($session->toArray(), JSON_PRETTY_PRINT);
 9 | 
10 |             if ($user !== false) {
11 |                 echo str_replace('}', "\t}", str_replace('    ', "\t\t", $user));
12 |             } else {
13 |                 echo 'Error processing token';
14 |             }
15 |         ?>
16 | 
17 |     }
18 | <?php $this->stop() ?>
19 | 


--------------------------------------------------------------------------------
/app/templates/logged-out.php:
--------------------------------------------------------------------------------
1 | <?php
2 |     $this->layout('_json');
3 |     $this->start('body');
4 | ?>
5 |     "data": {
6 |         "authenticated": false
7 |     }
8 | <?php $this->stop() ?>
9 | 


--------------------------------------------------------------------------------
/app/templates/spa.php:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html lang="eng">
  3 | 
  4 |     <head>
  5 |         <meta charset="UTF-8" />
  6 |         <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  7 |         <link href="//unpkg.com/tailwindcss@^2/dist/tailwind.min.css" rel="stylesheet">
  8 |         <script src="https://cdn.auth0.com/js/auth0-spa-js/2.0/auth0-spa-js.production.js"></script>
  9 | 
 10 |         <title>Auth0 PHP Quickstart for Backend APIs</title>
 11 | 
 12 |         <style>
 13 |             .text-auth0 {
 14 |                 color: #635dff;
 15 |             }
 16 | 
 17 |             .bg-auth0 {
 18 |                 background-color: #635dff;
 19 |             }
 20 | 
 21 |             textarea {
 22 |                 min-height: 15em;
 23 |             }
 24 |         </style>
 25 |     </head>
 26 | 
 27 |     <body class="home">
 28 |         <div class="relative bg-gray-900 overflow-hidden">
 29 |             <div class="hidden sm:block sm:absolute sm:inset-0" aria-hidden="true">
 30 |                 <svg class="absolute bottom-0 right-0 transform translate-x-1/2 mb-48 text-gray-700 lg:top-0 lg:mt-28 lg:mb-0 xl:transform-none xl:translate-x-0" width="364" height="384" viewBox="0 0 364 384" fill="none">
 31 |                     <defs>
 32 |                         <pattern id="eab71dd9-9d7a-47bd-8044-256344ee00d0" x="0" y="0" width="20" height="20" patternUnits="userSpaceOnUse">
 33 |                             <rect x="0" y="0" width="4" height="4" fill="currentColor" />
 34 |                         </pattern>
 35 |                     </defs>
 36 |                     <rect width="364" height="384" fill="url(#eab71dd9-9d7a-47bd-8044-256344ee00d0)" />
 37 |                 </svg>
 38 |             </div>
 39 |             <div class="relative pt-6 pb-16 sm:pb-24">
 40 |                 <div>
 41 |                     <nav class="relative max-w-7xl mx-auto flex items-center justify-between px-4 sm:px-6" aria-label="Global">
 42 |                         <div class="flex items-center flex-1">
 43 |                             <div class="flex items-center justify-between w-full md:w-auto">
 44 |                                 <a href="#">
 45 |                                     <span class="sr-only">Auth0</span>
 46 |                                     <svg width="81" height="24" viewBox="0 0 81 24" fill="none" xmlns="http://www.w3.org/2000/svg">
 47 |                                         <path d="M18.5334 0H10.7619L13.1617 7.51092H20.9333L14.6477 11.984L17.0475 19.5348C21.0922 16.5767 22.4192 12.0956 20.9333 7.50295L18.5334 0ZM0.590492 7.51092H8.36206L10.7619 0H2.9903L0.590492 7.51092C-0.895483 12.1036 0.431564 16.5846 4.47628 19.5428L6.87609 11.992L0.590492 7.51092ZM4.47628 19.5348L10.7619 23.9999L17.0475 19.5348L10.7619 14.99L4.47628 19.5348ZM63.1286 7.31956C61.293 7.31956 60.1169 8.15677 59.5686 9.52022H59.4256V3.34085H56.6682V19.5029H59.4891V12.4863C59.4891 10.7481 60.5619 9.75145 62.0797 9.75145C63.5577 9.75145 64.4318 10.7003 64.4318 12.3189V19.5029H67.2527V11.8484C67.2448 8.93816 65.6078 7.31956 63.1286 7.31956ZM74.8733 3.30895C71.0591 3.30895 68.7546 6.30694 68.7467 11.5136C68.7467 16.7361 71.0352 19.774 74.8733 19.774C78.7035 19.782 81 16.7441 81 11.5136C80.9921 6.31492 78.6876 3.30895 74.8733 3.30895ZM71.663 11.5136C71.6709 7.71026 72.9026 5.70894 74.8733 5.70894C76.2242 5.70894 77.2255 6.63385 77.7261 8.42786L71.7107 12.8132C71.6789 12.4146 71.663 11.976 71.663 11.5136ZM74.8733 17.3421C73.4827 17.3421 72.4576 16.3534 71.9729 14.4398L78.0201 10.0305C78.0678 10.493 78.0916 10.9873 78.0916 11.5215C78.0916 15.3488 76.8599 17.3421 74.8733 17.3421ZM43.9698 14.4557C43.9698 16.2816 42.6666 17.1906 41.419 17.1906C40.0602 17.1906 39.1623 16.2258 39.1623 14.7029V7.49498H36.3413V15.1415C36.3413 18.0278 37.9783 19.6624 40.3304 19.6624C42.1263 19.6624 43.3818 18.7135 43.9301 17.374H44.0572V19.5109H46.7908V7.49498H43.9698V14.4557ZM29.9603 7.31159C27.4413 7.31159 25.5104 8.43584 24.8906 10.6285L27.5208 11.0033C27.7989 10.182 28.5936 9.48035 29.9762 9.48035C31.2874 9.48035 32.0026 10.1501 32.0026 11.3302V11.378C32.0026 12.1913 31.1523 12.2312 29.0386 12.4544C26.7182 12.7016 24.4932 13.4033 24.4932 16.1062C24.4932 18.4664 26.2176 19.7182 28.4982 19.7182C30.3736 19.7182 31.494 18.8331 32.0105 17.8285H32.1059V19.479H34.8156V11.4418C34.8235 8.2684 32.2489 7.31159 29.9603 7.31159ZM32.0105 15.1654C32.0105 16.5049 30.9378 17.6371 29.2372 17.6371C28.0612 17.6371 27.2188 17.0949 27.2188 16.0584C27.2188 14.974 28.1645 14.5195 29.42 14.3361C30.159 14.2325 31.637 14.0491 32.0105 13.7461V15.1654ZM52.8142 4.48901H49.9932V7.49498H48.2847V9.75145H49.9932V16.4012C49.9773 18.6577 51.6143 19.774 53.7359 19.7102C54.3717 19.6943 54.8484 19.5906 55.1742 19.4949V17.2544C54.9597 17.2863 54.4591 17.3501 54.1015 17.3581C53.3942 17.374 52.8221 17.1109 52.8221 15.9627V9.75145H55.1742V7.50295H52.8142V4.48901Z" fill="#fff"></path>
 48 |                                     </svg>
 49 |                                 </a>
 50 |                             </div>
 51 |                             <div class="hidden space-x-10 md:flex md:ml-10">
 52 |                                 <a href="#" class="font-medium text-white hover:text-gray-300">Documentation</a>
 53 |                                 <a href="#" class="font-medium text-white hover:text-gray-300">GitHub</a>
 54 |                             </div>
 55 |                         </div>
 56 |                         <div class="hidden md:flex">
 57 |                             <button id="login" class="hidden inline-flex items-center px-4 py-2 border border-transparent text-sm font-medium rounded-md text-white bg-gray-600 hover:bg-gray-700">Log in</button>
 58 |                             <button id="logout" class="hidden inline-flex items-center px-4 py-2 border border-transparent text-sm font-medium rounded-md text-white bg-gray-600 hover:bg-gray-700">Log out</button>
 59 |                         </div>
 60 |                     </nav>
 61 |                 </div>
 62 | 
 63 |                 <main class="mt-16 sm:mt-24">
 64 |                     <div class="px-4 sm:px-6 sm:text-center md:max-w-7xl md:mx-auto lg:col-span-6 lg:text-left lg:flex lg:items-center">
 65 |                         <div>
 66 |                             <a href="#" class="inline-flex items-center text-white bg-gray-800 rounded-full p-1 pr-2 sm:text-base lg:text-sm xl:text-base hover:text-gray-200">
 67 |                                 <span id="state" class="px-3 py-0.5 text-white text-xs font-semibold leading-5 uppercase tracking-wide bg-gray-500 rounded-full">Loading...</span>
 68 |                                 <span class="ml-4 text-sm">PHP Quickstart</span>
 69 |                                 <svg class="ml-2 w-5 h-5 text-gray-500" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
 70 |                                     <path fill-rule="evenodd" d="M7.293 14.707a1 1 0 010-1.414L10.586 10 7.293 6.707a1 1 0 011.414-1.414l4 4a1 1 0 010 1.414l-4 4a1 1 0 01-1.414 0z" clip-rule="evenodd" />
 71 |                                 </svg>
 72 |                             </a>
 73 | 
 74 |                             <h1 class="mt-4 text-4xl tracking-tight font-extrabold text-white sm:mt-5 sm:leading-none lg:mt-6 lg:text-5xl xl:text-6xl">
 75 |                                 <span class="md:block">Welcome</span>
 76 |                                 <span id="name" class="text-gray-400 md:block">Guest</span>
 77 |                             </h1>
 78 | 
 79 |                             <p id="note" class="mt-3 text-base text-gray-300 sm:mt-5 sm:text-xl lg:text-lg xl:text-xl"></p>
 80 |                         </div>
 81 |                     </div>
 82 |                 </main>
 83 |             </div>
 84 |         </div>
 85 | 
 86 |         <main class="mt-4 md:mt-16">
 87 |             <div class="px-4 sm:px-6 sm:text-center md:max-w-7xl md:mx-auto lg:col-span-6 lg:text-left lg:flex lg:items-center">
 88 |                 <div class="mb-16 w-full lg:grid lg:grid-cols-12 lg:gap-x-5">
 89 |                     <aside class="py-6 px-2 sm:px-6 lg:py-0 lg:px-0 lg:col-span-3">
 90 |                         <nav class="space-y-1">
 91 |                             <a href="#user" class="bg-gray-50 text-indigo-700 hover:text-indigo-700 hover:bg-white group rounded-md px-3 py-2 flex items-center text-sm font-medium" aria-current="page">
 92 |                                 <svg class="text-indigo-500 group-hover:text-indigo-500 flex-shrink-0 -ml-1 mr-3 h-6 w-6" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" aria-hidden="true">
 93 |                                     <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5.121 17.804A13.937 13.937 0 0112 16c2.5 0 4.847.655 6.879 1.804M15 10a3 3 0 11-6 0 3 3 0 016 0zm6 2a9 9 0 11-18 0 9 9 0 0118 0z" />
 94 |                                 </svg>
 95 |                                 <span class="truncate">
 96 |                                     Example API Response
 97 |                                 </span>
 98 |                             </a>
 99 |                         </nav>
100 |                     </aside>
101 | 
102 |                     <div class="space-y-6 sm:px-6 lg:px-0 lg:col-span-9">
103 |                         <div id="cookies">
104 |                             <div class="shadow sm:rounded-md sm:overflow-hidden">
105 |                                 <div class="bg-white">
106 |                                     <div class="px-4 py-5 sm:px-6 bg-gray-100">
107 |                                         <h3 class="text-lg leading-6 font-medium text-gray-900">Example API Response</h3>
108 |                                     </div>
109 | 
110 |                                     <div class="px-4 py-5 sm:px-6 grid grid-cols-6 gap-6">
111 |                                         <div class="col-span-6">
112 |                                             <textarea id="backendApiResponse" readonly="readonly" class="mt-1 block w-full bg-white border border-gray-300 rounded-md shadow-sm py-2 px-3 focus:outline-none focus:ring-indigo-500 focus:border-indigo-500 sm:text-sm"></textarea>
113 |                                         </div>
114 |                                     </div>
115 |                                 </div>
116 |                             </div>
117 |                         </div>
118 |                     </div>
119 |                 </div>
120 |             </div>
121 |         </main>
122 | 
123 |         <script>
124 |             auth0.createAuth0Client({
125 |                 domain: '<?php echo $config->getDomain(); ?>',
126 |                 clientId: '<?php echo $config->getClientId(); ?>',
127 |                 authorizationParams: {
128 |                     audience: '<?php echo $config->defaultAudience(); ?>',
129 |                     redirect_uri: '<?php echo $router->getUri('/', ''); ?>',
130 |                     scope: '<?php echo $config->formatScope(); ?>'
131 |                 }
132 |             }).then(auth0Instance => {
133 |                 var hasAuthParams = window.location.href.indexOf('code=') !== -1 && window.location.href.indexOf('state=') !== -1;
134 | 
135 |                 document.getElementById('login').addEventListener('click', () => {
136 |                     auth0Instance.loginWithRedirect().catch(() => {});
137 |                 });
138 | 
139 |                 document.getElementById('logout').addEventListener('click', () => {
140 |                     auth0Instance.logout({
141 |                         logoutParams: {
142 |                             returnTo: '<?php echo $router->getUri('/', ''); ?>'
143 |                         }
144 |                     });
145 |                 });
146 | 
147 |                 auth0Instance.getUser().then(user => {
148 |                     if (user) {
149 |                         setAppState(true, user);
150 |                         callBackendApi(auth0Instance);
151 |                         return;
152 |                     } else if (hasAuthParams) {
153 |                         auth0Instance.handleRedirectCallback().then(redirectResult => {
154 |                             auth0Instance.getUser().then(user => {
155 |                                 setAppState(true, user);
156 |                                 callBackendApi(auth0Instance);
157 |                             });
158 |                         }).catch(() => {
159 |                             setAppState(false);
160 |                             callBackendApi();
161 |                         });
162 |                     } else {
163 |                         setAppState(false);
164 |                         callBackendApi();
165 |                     }
166 |                 });
167 |             });
168 | 
169 |             function setAppState(loggedIn, user) {
170 |                 var name = document.getElementById('name');
171 |                 var note = document.getElementById('note');
172 |                 var state = document.getElementById('state');
173 |                 var login = document.getElementById('login');
174 |                 var logout = document.getElementById('logout');
175 | 
176 |                 if (loggedIn === true) {
177 |                     state.classList.remove('bg-gray-500');
178 |                     state.classList.add('bg-green-500');
179 |                     state.innerText = 'Logged in';
180 | 
181 |                     login.classList.add('hidden');
182 |                     logout.classList.remove('hidden');
183 | 
184 |                     name.classList.remove('text-gray-400');
185 |                     name.classList.add('text-auth0');
186 | 
187 |                     note.innerText = 'You are authenticated.';
188 | 
189 |                     if (user) {
190 |                         name.innerHTML = '<span class="inline-block relative"><img class="h-12 w-12 rounded-full" src="' + user.picture + '"></span> ' + user.name;
191 |                         note.innerHTML = 'You successfully authenticated as <span class="font-mono bg-gray-800 p-1 rounded text-sm">' + user.sub + '</span>.';
192 |                     }
193 | 
194 |                     return;
195 |                 }
196 | 
197 |                 state.classList.remove('bg-green-500');
198 |                 state.classList.add('bg-gray-500');
199 |                 state.innerText = 'Logged Out';
200 | 
201 |                 note.innerText = 'You are not authenticated.';
202 | 
203 |                 logout.classList.add('hidden');
204 |                 login.classList.remove('hidden');
205 |             }
206 | 
207 |             async function callBackendApi(auth0Instance) {
208 |                 var accessToken = auth0Instance ? await auth0Instance.getTokenSilently() : false;
209 |                 var headers = {};
210 | 
211 |                 if (accessToken) {
212 |                     headers.Authorization = `Bearer ${accessToken}`;
213 |                 }
214 | 
215 |                 return await fetch('/api', {
216 |                     method: 'GET',
217 |                     headers: headers
218 |                 })
219 |                 .then(response => response.json())
220 |                 .then(response => {
221 |                     document.getElementById('backendApiResponse').value = JSON.stringify(response, undefined, 4);
222 |                 });
223 |             }
224 |         </script>
225 |     </body>
226 | 
227 | </html>
228 | 


--------------------------------------------------------------------------------
/app/tests/Feature/ExampleTest.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | test('example', function () {
4 |     expect(true)->toBeTrue();
5 | });
6 | 


--------------------------------------------------------------------------------
/app/tests/Pest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 | |--------------------------------------------------------------------------
 5 | | Test Case
 6 | |--------------------------------------------------------------------------
 7 | |
 8 | | The closure you provide to your test functions is always bound to a specific PHPUnit test
 9 | | case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
10 | | need to change it using the "uses()" function to bind a different classes or traits.
11 | |
12 | */
13 | 
14 | // uses(Tests\TestCase::class)->in('Feature');
15 | 
16 | /*
17 | |--------------------------------------------------------------------------
18 | | Expectations
19 | |--------------------------------------------------------------------------
20 | |
21 | | When you're writing tests, you often need to check that values meet certain conditions. The
22 | | "expect()" function gives you access to a set of "expectations" methods that you can use
23 | | to assert different things. Of course, you may extend the Expectation API at any time.
24 | |
25 | */
26 | 
27 | expect()->extend('toBeOne', function () {
28 |     return $this->toBe(1);
29 | });
30 | 
31 | /*
32 | |--------------------------------------------------------------------------
33 | | Functions
34 | |--------------------------------------------------------------------------
35 | |
36 | | While Pest is very powerful out-of-the-box, you may have some testing code specific to your
37 | | project that you don't want to repeat in every file. Here you can also expose helpers as
38 | | global functions to help you to reduce the number of lines of code in your test files.
39 | |
40 | */
41 | 
42 | function something()
43 | {
44 |     // ..
45 | }
46 | 


--------------------------------------------------------------------------------
/app/tests/TestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Tests;
 4 | 
 5 | use PHPUnit\Framework\TestCase as BaseTestCase;
 6 | 
 7 | abstract class TestCase extends BaseTestCase
 8 | {
 9 |     //
10 | }
11 | 


--------------------------------------------------------------------------------
/app/tests/Unit/ExampleTest.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | test('example', function () {
4 |     expect(true)->toBeTrue();
5 | });
6 | 


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