mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0a8e5436d4 | ||
|
|
7c81b6388e | ||
|
|
66d6e3df01 | ||
|
|
1080504a78 | ||
|
|
647b8ff0d1 | ||
|
|
07e35d808c | ||
|
|
a44572676a | ||
|
|
e6f7ca7433 | ||
|
|
042d341b65 | ||
|
|
501ef7045a | ||
|
|
31e6479ee6 | ||
|
|
c0f4a497f9 | ||
|
|
00604a2431 | ||
|
|
ff18d80849 | ||
|
|
52ea63b5de | ||
|
|
7b263ffbce | ||
|
|
8f4ea3c100 | ||
|
|
3c348e7140 | ||
|
|
2f90dbdfce | ||
|
|
74935df8a1 | ||
|
|
b6fdfe0df7 | ||
|
|
99cebb5566 | ||
|
|
692b223e94 | ||
|
|
f321828778 | ||
|
|
6eb797f5ff | ||
|
|
604d327277 | ||
|
|
6ed5367f6b | ||
|
|
8c339bd6b0 | ||
|
|
52b9b52926 | ||
|
|
f909c82fcc | ||
|
|
e88c3669b7 | ||
|
|
5bd7eeda23 | ||
|
|
dae0b55bef | ||
|
|
3f9831c5cf | ||
|
|
2cc277440a | ||
|
|
14eab5ef84 |
@@ -1,15 +0,0 @@
|
|||||||
; This file is for unifying the coding style for different editors and IDEs.
|
|
||||||
; More information at http://editorconfig.org
|
|
||||||
|
|
||||||
root = true
|
|
||||||
|
|
||||||
[*]
|
|
||||||
charset = utf-8
|
|
||||||
indent_size = 4
|
|
||||||
indent_style = space
|
|
||||||
end_of_line = lf
|
|
||||||
insert_final_newline = true
|
|
||||||
trim_trailing_whitespace = true
|
|
||||||
|
|
||||||
[*.md]
|
|
||||||
trim_trailing_whitespace = false
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# Path-based git attributes
|
|
||||||
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
|
|
||||||
|
|
||||||
# Ignore all test and documentation with "export-ignore".
|
|
||||||
/.editorconfig export-ignore
|
|
||||||
/.gitattributes export-ignore
|
|
||||||
/.github export-ignore
|
|
||||||
/.gitignore export-ignore
|
|
||||||
/.php-cs-fixer* export-ignore
|
|
||||||
/phpunit.xml.dist export-ignore
|
|
||||||
/psalm-baseline.xml export-ignore
|
|
||||||
/psalm.xml export-ignore
|
|
||||||
/tests export-ignore
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
# These are supported funding model platforms
|
|
||||||
|
|
||||||
github: barryvdh
|
|
||||||
custom: ['https://fruitcake.nl']
|
|
||||||
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
---
|
|
||||||
name: "🐛 Bug Report"
|
|
||||||
about: 'Report a general bug.'
|
|
||||||
labels: bug
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Versions:
|
|
||||||
- ide-helper Version: #.#.#
|
|
||||||
- Laravel Version: #.#.# <!-- remove if not applicable -->
|
|
||||||
- PHP Version: #.#.#
|
|
||||||
|
|
||||||
### Description:
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Please describe in detail the nature of the bug, code samples, etc.
|
|
||||||
|
|
||||||
The more, the better.
|
|
||||||
-->
|
|
||||||
|
|
||||||
### Steps To Reproduce:
|
|
||||||
|
|
||||||
- …
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
---
|
|
||||||
name: "✨ Feature request"
|
|
||||||
about: 'Suggest a new feature or other improvements.'
|
|
||||||
labels: enhancement
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Summary
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Describe in detail what you propose, show (preferable) code examples and also signal if you're willing to work on it!
|
|
||||||
-->
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
name: "🙋🏼♂️ Support question"
|
|
||||||
about: 'I need assistance or clarification on usage of this library.'
|
|
||||||
labels: question
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Versions:
|
|
||||||
- ide-helper Version: #.#.#
|
|
||||||
- Laravel Version: #.#.# <!-- remove if not applicable -->
|
|
||||||
- PHP Version: #.#.#
|
|
||||||
|
|
||||||
### Question:
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
## Summary
|
|
||||||
<!-- Please provide an exhaustive description. -->
|
|
||||||
|
|
||||||
## Type of change
|
|
||||||
|
|
||||||
<!-- Please delete options that are not relevant. -->
|
|
||||||
|
|
||||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
|
||||||
- [ ] New feature (non-breaking change which adds functionality)
|
|
||||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
|
||||||
- [ ] This change requires a documentation update
|
|
||||||
- [ ] Misc. change (internal, infrastructure, maintenance, etc.)
|
|
||||||
|
|
||||||
### Checklist
|
|
||||||
- [ ] Existing tests have been adapted and/or new tests have been added
|
|
||||||
- [ ] Update the README.md
|
|
||||||
- [ ] Code style has been fixed via `composer fix-style`
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
version: 2
|
|
||||||
updates:
|
|
||||||
- package-ecosystem: github-actions
|
|
||||||
directory: /
|
|
||||||
schedule:
|
|
||||||
interval: monthly
|
|
||||||
groups:
|
|
||||||
deps:
|
|
||||||
patterns:
|
|
||||||
- '*'
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
template: |
|
|
||||||
## What’s Changed
|
|
||||||
|
|
||||||
$CHANGES
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
# Number of days of inactivity before an issue becomes stale
|
|
||||||
daysUntilStale: 90
|
|
||||||
# Number of days of inactivity before a stale issue is closed
|
|
||||||
daysUntilClose: 60
|
|
||||||
# Issues with these labels will never be considered stale
|
|
||||||
exemptLabels:
|
|
||||||
- bug
|
|
||||||
- enhancement
|
|
||||||
- discussion
|
|
||||||
# Label to use when marking an issue as stale
|
|
||||||
staleLabel: stale
|
|
||||||
# Comment to post when marking an issue as stale. Set to `false` to disable
|
|
||||||
markComment: >
|
|
||||||
This issue has been automatically marked as stale because it has not had
|
|
||||||
recent activity. It will be closed if no further activity occurs.
|
|
||||||
|
|
||||||
If this issue is still present on the latest version of this library on supported Laravel versions,
|
|
||||||
please let us know by replying to this issue so we can investigate further.
|
|
||||||
|
|
||||||
Thank you for your contribution! Apologies for any delayed response on our side.
|
|
||||||
# Comment to post when closing a stale issue. Set to `false` to disable
|
|
||||||
closeComment: false
|
|
||||||
# Limit to only `issues` or `pulls`
|
|
||||||
only: issues
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
name: normalize composer.json
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
paths:
|
|
||||||
- .github/workflows/composer-normalize.yml
|
|
||||||
- composer.json
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
normalize:
|
|
||||||
timeout-minutes: 15
|
|
||||||
runs-on: ubuntu-22.04
|
|
||||||
steps:
|
|
||||||
- name: Git checkout
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Validate Composer configuration
|
|
||||||
run: composer validate --strict
|
|
||||||
|
|
||||||
- name: Normalize composer.json
|
|
||||||
run: |
|
|
||||||
composer global config --no-plugins allow-plugins.ergebnis/composer-normalize true
|
|
||||||
composer global require ergebnis/composer-normalize
|
|
||||||
composer normalize
|
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v7
|
|
||||||
with:
|
|
||||||
commit_message: normalize composer.json
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
name: Fix Code Style
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
fix-style:
|
|
||||||
name: Fix Code Style
|
|
||||||
timeout-minutes: 15
|
|
||||||
runs-on: ubuntu-22.04
|
|
||||||
env:
|
|
||||||
COMPOSER_NO_INTERACTION: 1
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Setup PHP
|
|
||||||
uses: shivammathur/setup-php@v2
|
|
||||||
with:
|
|
||||||
php-version: 8.3
|
|
||||||
coverage: none
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: composer update --prefer-dist --no-progress
|
|
||||||
|
|
||||||
- run: composer fix-style
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v7
|
|
||||||
with:
|
|
||||||
commit_message: composer fix-style
|
|
||||||
commit_author: laravel-ide-helper <[email protected]>
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
name: Release Drafter
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
# branches to consider in the event; optional, defaults to all
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
# pull_request event is required only for autolabeler
|
|
||||||
pull_request:
|
|
||||||
# Only following types are handled by the action, but one can default to all as well
|
|
||||||
types: [opened, reopened, synchronize]
|
|
||||||
# pull_request_target event is required for autolabeler to support PRs from forks
|
|
||||||
# pull_request_target:
|
|
||||||
# types: [opened, reopened, synchronize]
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update_release_draft:
|
|
||||||
permissions:
|
|
||||||
# write permission is required to create a github release
|
|
||||||
contents: write
|
|
||||||
# write permission is required for autolabeler
|
|
||||||
# otherwise, read permission is required at least
|
|
||||||
pull-requests: write
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
# (Optional) GitHub Enterprise requires GHE_HOST variable set
|
|
||||||
#- name: Set GHE_HOST
|
|
||||||
# run: |
|
|
||||||
# echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
# Drafts your next Release notes as Pull Requests are merged into "master"
|
|
||||||
- uses: release-drafter/release-drafter@v6
|
|
||||||
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
|
|
||||||
# with:
|
|
||||||
# config-name: my-config.yml
|
|
||||||
# disable-autolabeler: true
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
name: Integration Tests
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- "*"
|
|
||||||
schedule:
|
|
||||||
- cron: '0 0 * * *'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
php-laravel-integration-tests:
|
|
||||||
runs-on: ubuntu-22.04
|
|
||||||
timeout-minutes: 15
|
|
||||||
env:
|
|
||||||
COMPOSER_NO_INTERACTION: 1
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
php: [8.4, 8.3, 8.2]
|
|
||||||
laravel: [11.x, 12.x]
|
|
||||||
|
|
||||||
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
path: src
|
|
||||||
|
|
||||||
- name: Setup PHP
|
|
||||||
uses: shivammathur/setup-php@v2
|
|
||||||
with:
|
|
||||||
php-version: ${{ matrix.php }}
|
|
||||||
coverage: none
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
composer create-project --prefer-dist laravel/laravel:${{ matrix.laravel }} --stability=dev --no-progress sample
|
|
||||||
cd sample
|
|
||||||
composer config minimum-stability dev
|
|
||||||
composer update --prefer-stable --prefer-dist --no-progress
|
|
||||||
|
|
||||||
- name: Add package from source
|
|
||||||
run: |
|
|
||||||
cd sample
|
|
||||||
sed -e 's|"type": "project",|&\n"repositories": [ { "type": "path", "url": "../src" } ],|' -i composer.json
|
|
||||||
composer require --dev "barryvdh/laravel-ide-helper:*" --with-all-dependencies
|
|
||||||
|
|
||||||
- name: Execute generate run
|
|
||||||
run: |
|
|
||||||
cd sample
|
|
||||||
php artisan ide-helper:generate
|
|
||||||
|
|
||||||
- name: Execute meta run
|
|
||||||
run: |
|
|
||||||
cd sample
|
|
||||||
php artisan ide-helper:meta -v
|
|
||||||
|
|
||||||
- name: Check file existence
|
|
||||||
run: |
|
|
||||||
ls sample/_ide_helper.php
|
|
||||||
ls sample/.phpstorm.meta.php
|
|
||||||
|
|
||||||
|
|
||||||
- name: Check logs
|
|
||||||
run: |
|
|
||||||
if [ `ls -1q "sample/storage/logs/" | wc -l` -gt 0 ]; then
|
|
||||||
for logfile in sample/storage/logs/*; do
|
|
||||||
echo "-- $logfile --"
|
|
||||||
cat $logfile
|
|
||||||
done
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
name: Run Static Analysis
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
pull_request:
|
|
||||||
schedule:
|
|
||||||
- cron: '0 0 * * *'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
timeout-minutes: 15
|
|
||||||
runs-on: ubuntu-22.04
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Setup PHP
|
|
||||||
uses: shivammathur/setup-php@v2
|
|
||||||
with:
|
|
||||||
php-version: 8.3
|
|
||||||
coverage: none
|
|
||||||
extensions: pdo_sqlite
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: composer install --prefer-dist --no-progress --no-suggest
|
|
||||||
|
|
||||||
- name: Analyze
|
|
||||||
run: composer analyze
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
name: Tests
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- "*"
|
|
||||||
schedule:
|
|
||||||
- cron: '0 0 * * *'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
php-tests:
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
timeout-minutes: 15
|
|
||||||
env:
|
|
||||||
COMPOSER_NO_INTERACTION: 1
|
|
||||||
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-latest]
|
|
||||||
php: [8.5, 8.4, 8.3, 8.2]
|
|
||||||
laravel: [~11.15, 12.x]
|
|
||||||
stability: [prefer-lowest, prefer-stable]
|
|
||||||
include:
|
|
||||||
- os: windows-latest
|
|
||||||
php: 8.3
|
|
||||||
laravel: 12.x
|
|
||||||
stability: prefer-stable
|
|
||||||
steps:
|
|
||||||
- name: Set git to use LF
|
|
||||||
if: ${{ matrix.os == 'windows-latest' }}
|
|
||||||
run: |
|
|
||||||
git config --global core.autocrlf false
|
|
||||||
git config --global core.eol lf
|
|
||||||
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
|
|
||||||
- name: Setup PHP
|
|
||||||
uses: shivammathur/setup-php@v2
|
|
||||||
with:
|
|
||||||
php-version: ${{ matrix.php }}
|
|
||||||
coverage: none
|
|
||||||
extensions: pdo_sqlite, fileinfo
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
composer remove vimeo/psalm --no-update --dev
|
|
||||||
composer remove friendsofphp/php-cs-fixer --no-update --dev
|
|
||||||
composer require "laravel/framework:${{ matrix.laravel }}" --no-update --no-progress
|
|
||||||
composer update --prefer-dist --no-progress --${{ matrix.stability }}
|
|
||||||
|
|
||||||
- name: Execute Unit Tests
|
|
||||||
run: composer test-ci
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
name: "Update Changelog"
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [released]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
# Give the default GITHUB_TOKEN write permission to commit and push the
|
|
||||||
# updated CHANGELOG back to the repository.
|
|
||||||
# https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v6
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.release.target_commitish }}
|
|
||||||
|
|
||||||
- name: Update Changelog
|
|
||||||
uses: stefanzweifel/changelog-updater-action@v1
|
|
||||||
with:
|
|
||||||
latest-version: ${{ github.event.release.tag_name }}
|
|
||||||
release-notes: ${{ github.event.release.body }}
|
|
||||||
|
|
||||||
- name: Commit updated CHANGELOG
|
|
||||||
uses: stefanzweifel/git-auto-commit-action@v7
|
|
||||||
with:
|
|
||||||
branch: ${{ github.event.release.target_commitish }}
|
|
||||||
commit_message: Update CHANGELOG
|
|
||||||
file_pattern: CHANGELOG.md
|
|
||||||
+2
-7
@@ -1,8 +1,3 @@
|
|||||||
.phpunit.result.cache
|
|
||||||
|
|
||||||
/.idea
|
|
||||||
/.php-cs-fixer.cache
|
|
||||||
/.php-cs-fixer.php
|
|
||||||
/.php-cs-fixer.tests.cache
|
|
||||||
/composer.lock
|
|
||||||
/vendor
|
/vendor
|
||||||
|
composer.lock
|
||||||
|
.idea/
|
||||||
|
|||||||
@@ -1,62 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
// Share common rules between non-test and test files
|
|
||||||
return [
|
|
||||||
'@PSR12' => true,
|
|
||||||
'blank_line_after_opening_tag' => true,
|
|
||||||
'braces' => [
|
|
||||||
'allow_single_line_anonymous_class_with_empty_body' => true,
|
|
||||||
],
|
|
||||||
'compact_nullable_typehint' => true,
|
|
||||||
'declare_equal_normalize' => true,
|
|
||||||
'lowercase_cast' => true,
|
|
||||||
'lowercase_static_reference' => true,
|
|
||||||
'new_with_braces' => true,
|
|
||||||
'no_blank_lines_after_class_opening' => true,
|
|
||||||
'no_leading_import_slash' => true,
|
|
||||||
'no_whitespace_in_blank_line' => true,
|
|
||||||
'ordered_class_elements' => [
|
|
||||||
'order' => [
|
|
||||||
'use_trait',
|
|
||||||
],
|
|
||||||
],
|
|
||||||
'ordered_imports' => [
|
|
||||||
'imports_order' => [
|
|
||||||
'class',
|
|
||||||
'function',
|
|
||||||
'const',
|
|
||||||
],
|
|
||||||
'sort_algorithm' => 'alpha',
|
|
||||||
],
|
|
||||||
'return_type_declaration' => true,
|
|
||||||
'short_scalar_cast' => true,
|
|
||||||
'single_trait_insert_per_statement' => true,
|
|
||||||
'ternary_operator_spaces' => true,
|
|
||||||
'visibility_required' => [
|
|
||||||
'elements' => [
|
|
||||||
'const',
|
|
||||||
'method',
|
|
||||||
'property',
|
|
||||||
],
|
|
||||||
],
|
|
||||||
|
|
||||||
// Further quality-of-life improvements
|
|
||||||
'array_syntax' => [
|
|
||||||
'syntax' => 'short',
|
|
||||||
],
|
|
||||||
'concat_space' => [
|
|
||||||
'spacing' => 'one',
|
|
||||||
],
|
|
||||||
'fully_qualified_strict_types' => true,
|
|
||||||
'native_function_invocation' => [
|
|
||||||
'include' => [],
|
|
||||||
'strict' => true,
|
|
||||||
],
|
|
||||||
'no_unused_imports' => true,
|
|
||||||
'single_quote' => true,
|
|
||||||
'space_after_semicolon' => true,
|
|
||||||
'trailing_comma_in_multiline' => true,
|
|
||||||
'trim_array_spaces' => true,
|
|
||||||
'unary_operator_spaces' => true,
|
|
||||||
'whitespace_after_comma_in_array' => true,
|
|
||||||
];
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
<?php
|
|
||||||
require __DIR__ . '/vendor/autoload.php';
|
|
||||||
|
|
||||||
$finder = PhpCsFixer\Finder::create()
|
|
||||||
->in(__DIR__)
|
|
||||||
->exclude('tests');
|
|
||||||
|
|
||||||
$config = require __DIR__ . '/.php-cs-fixer.common.php';
|
|
||||||
|
|
||||||
return (new PhpCsFixer\Config())
|
|
||||||
->setFinder($finder)
|
|
||||||
->setRules($config)
|
|
||||||
->setRiskyAllowed(true)
|
|
||||||
->setCacheFile(__DIR__ . '/.php-cs-fixer.cache');
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
<?php
|
|
||||||
require __DIR__ . '/vendor/autoload.php';
|
|
||||||
|
|
||||||
$finder = PhpCsFixer\Finder::create()
|
|
||||||
->in(__DIR__ . '/tests')
|
|
||||||
->exclude('__snapshots__');
|
|
||||||
|
|
||||||
$config = require __DIR__ . '/.php-cs-fixer.common.php';
|
|
||||||
|
|
||||||
// Additional rules for tests
|
|
||||||
$config = array_merge(
|
|
||||||
$config,
|
|
||||||
[
|
|
||||||
'declare_strict_types' => true,
|
|
||||||
]
|
|
||||||
);
|
|
||||||
|
|
||||||
return (new PhpCsFixer\Config())
|
|
||||||
->setFinder($finder)
|
|
||||||
->setRules($config)
|
|
||||||
->setRiskyAllowed(true)
|
|
||||||
->setCacheFile(__DIR__ . '/.php-cs-fixer.tests.cache');
|
|
||||||
+26
@@ -0,0 +1,26 @@
|
|||||||
|
language: php
|
||||||
|
php:
|
||||||
|
- 5.4
|
||||||
|
- 5.5
|
||||||
|
- 5.6
|
||||||
|
- hhvm
|
||||||
|
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- php: 5.3
|
||||||
|
dist: precise
|
||||||
|
allow_failures:
|
||||||
|
- php: hhvm
|
||||||
|
fast_finish: true
|
||||||
|
|
||||||
|
cache:
|
||||||
|
directories:
|
||||||
|
- vendor
|
||||||
|
- $HOME/.composer/cache
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- travis_retry composer self-update
|
||||||
|
- travis_retry composer install --no-interaction --no-suggest --no-progress
|
||||||
|
|
||||||
|
script:
|
||||||
|
- vendor/bin/phpunit
|
||||||
-515
@@ -1,515 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## v3.6.0 - 2025-07-18
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* fix: Change AsArrayObject cast to be Laravel's ArrayObject by @wsamoht in https://github.com/barryvdh/laravel-ide-helper/pull/1675
|
|
||||||
* Add extends declaration for Macroable classes to fix missing inherited methods by @KentarouTakeda in https://github.com/barryvdh/laravel-ide-helper/pull/1674
|
|
||||||
* fix(meta): ignore aliases in the autoloader (Fixes #1671) by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1686
|
|
||||||
* feat(ModelsCommand): add support for the new Scope attribute by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1694
|
|
||||||
* fix type change for scope default float parameter by @nivseb in https://github.com/barryvdh/laravel-ide-helper/pull/1697
|
|
||||||
* Revert #1629 - *Allow adding custom Macroable classes* by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1707
|
|
||||||
* Configurable macro return type defaults by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1711
|
|
||||||
* docs(readme): add Laravel 12 support information by @SantosVilanculos in https://github.com/barryvdh/laravel-ide-helper/pull/1717
|
|
||||||
* Add multi-level directory support for translation files by @RosiersRobin in https://github.com/barryvdh/laravel-ide-helper/pull/1718
|
|
||||||
* Support `AsCollection::of($map)`, `AsCollection::using($class, $map)` by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1714
|
|
||||||
* fix: Fixed wrong doc for SoftDeletes `withTrashed` method by @eldair in https://github.com/barryvdh/laravel-ide-helper/pull/1688
|
|
||||||
* Support other OS on tests by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1715
|
|
||||||
* Fix tests on windows by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1720
|
|
||||||
* Bump stefanzweifel/git-auto-commit-action from 5 to 6 in the deps group by @dependabot[bot] in https://github.com/barryvdh/laravel-ide-helper/pull/1719
|
|
||||||
* Update .gitattributes - avoid all `.php-cs-fixer` files on vendor by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1708
|
|
||||||
* fix(ModelsCommand): use 'string' as realType for 'encrypted' casts by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1698
|
|
||||||
* Trim strings and bump reflection docblock by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1721
|
|
||||||
* Add magic *_exists properties by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1712
|
|
||||||
|
|
||||||
### New Contributors
|
|
||||||
|
|
||||||
* @wsamoht made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1675
|
|
||||||
* @nivseb made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1697
|
|
||||||
* @SantosVilanculos made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1717
|
|
||||||
* @RosiersRobin made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1718
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.5...v3.6.0
|
|
||||||
|
|
||||||
## v3.5.5 - 2025-02-21
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* Fix for incorrect config item types in meta file by @eldair in https://github.com/barryvdh/laravel-ide-helper/pull/1662
|
|
||||||
* Prevent generation of incorrect property annotation by @skyler544 in https://github.com/barryvdh/laravel-ide-helper/pull/1665
|
|
||||||
* Fix MorphTo Model Doc Generation by @yparitcher in https://github.com/barryvdh/laravel-ide-helper/pull/1668
|
|
||||||
* Laravel 12 support by @jonnott in https://github.com/barryvdh/laravel-ide-helper/pull/1672
|
|
||||||
|
|
||||||
### New Contributors
|
|
||||||
|
|
||||||
* @eldair made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1662
|
|
||||||
* @skyler544 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1665
|
|
||||||
* @yparitcher made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1668
|
|
||||||
* @jonnott made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1672
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.4...v3.5.5
|
|
||||||
|
|
||||||
## v3.5.4 - 2025-01-14
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* Convert auth() helper to use Auth facade by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1656
|
|
||||||
* Check if returnType from docblock is not null by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1658
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.3...v3.5.4
|
|
||||||
|
|
||||||
## v3.5.3 - 2025-01-08
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* Catch meta, tweak auth by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1654
|
|
||||||
* Check if macro is valid by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1655
|
|
||||||
* feat: use generics of return type to determine resulting models by @Bloemendaal in https://github.com/barryvdh/laravel-ide-helper/pull/1653
|
|
||||||
|
|
||||||
### New Contributors
|
|
||||||
|
|
||||||
* @Bloemendaal made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1653
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.2...v3.5.3
|
|
||||||
|
|
||||||
## v3.5.2 - 2025-01-06
|
|
||||||
|
|
||||||
### Fixes
|
|
||||||
|
|
||||||
Fix empty/anonymous closure in meta command.
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.1...v3.5.2
|
|
||||||
|
|
||||||
## v3.5.1 - 2025-01-06
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* Remove duplicate config, fix ->can() by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1650
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.0...v3.5.1
|
|
||||||
|
|
||||||
## v3.5.0 - 2025-01-06
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* Add phpstorm meta argument hints by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1640
|
|
||||||
* Add meta override for user return types by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1642
|
|
||||||
* Use forked ContextFactory by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1643
|
|
||||||
* Remove php parser by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1644
|
|
||||||
* Also add eloquent template tags from base class by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1645
|
|
||||||
* Add more metadata by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1646
|
|
||||||
* Fixed generating PHPDoc for methods with class templates by @chack1172 in https://github.com/barryvdh/laravel-ide-helper/pull/1647
|
|
||||||
* Feat guess macro types by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1648
|
|
||||||
* Allow adding custom Macroable classes. by @mathieutu in https://github.com/barryvdh/laravel-ide-helper/pull/1629
|
|
||||||
* Add special `dev` to composer keywords by @jnoordsij in https://github.com/barryvdh/laravel-ide-helper/pull/1649
|
|
||||||
|
|
||||||
### New Contributors
|
|
||||||
|
|
||||||
* @chack1172 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1647
|
|
||||||
* @mathieutu made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1629
|
|
||||||
* @jnoordsij made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1649
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.4.0...v3.5.0
|
|
||||||
|
|
||||||
## v3.4.0 - 2024-12-29
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* fix: add @template TModel of static for Eloquent by @imzyf in https://github.com/barryvdh/laravel-ide-helper/pull/1631
|
|
||||||
* Add templates to Eloquent by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1634
|
|
||||||
* Update testsuite for Generator, simplify service provider and mock by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1635
|
|
||||||
* Add option for only eloquent by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1636
|
|
||||||
* Add weak generics for array type objects by @LauJosefsen in https://github.com/barryvdh/laravel-ide-helper/pull/1621
|
|
||||||
* Make all "note" in README apply quote style by @hms5232 in https://github.com/barryvdh/laravel-ide-helper/pull/1590
|
|
||||||
* Update README.md by @Mtillmann in https://github.com/barryvdh/laravel-ide-helper/pull/1587
|
|
||||||
* Rename view var by @barryvdh and @pb30 in https://github.com/barryvdh/laravel-ide-helper/pull/1637 and https://github.com/barryvdh/laravel-ide-helper/pull/1563
|
|
||||||
* Format IDE helper by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1638
|
|
||||||
* Add TLDR section, update options by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1639
|
|
||||||
|
|
||||||
### New Contributors
|
|
||||||
|
|
||||||
* @imzyf made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1631
|
|
||||||
* @LauJosefsen made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1621
|
|
||||||
* @hms5232 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1590
|
|
||||||
* @Mtillmann made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1587
|
|
||||||
* @pb30 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1563
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.3.0...v3.4.0
|
|
||||||
|
|
||||||
## v3.3.0 - 2024-12-18
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* Feature: Add Config Option to Enforce Nullable Relationships by @jeramyhing in https://github.com/barryvdh/laravel-ide-helper/pull/1580
|
|
||||||
* Improve replacement of return type for methods from Query\Builder by @pjio in https://github.com/barryvdh/laravel-ide-helper/pull/1575
|
|
||||||
* Update CHANGELOG.md, fix typo(s) by @NicholasWilsonDEV in https://github.com/barryvdh/laravel-ide-helper/pull/1613
|
|
||||||
* Fixed PHP 8.4 deprecation warning by @eusonlito in https://github.com/barryvdh/laravel-ide-helper/pull/1622
|
|
||||||
* Fix PHP 8.4 deprecations by @JeppeKnockaert in https://github.com/barryvdh/laravel-ide-helper/pull/1618
|
|
||||||
* Assign $output method parameter to $this->output on Generator by @eusonlito in https://github.com/barryvdh/laravel-ide-helper/pull/1623
|
|
||||||
|
|
||||||
### New Contributors
|
|
||||||
|
|
||||||
* @jeramyhing made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1580
|
|
||||||
* @pjio made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1575
|
|
||||||
* @NicholasWilsonDEV made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1613
|
|
||||||
* @eusonlito made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1622
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.2...v3.3.0
|
|
||||||
|
|
||||||
## v3.2.2 - 2024-10-29
|
|
||||||
|
|
||||||
### What’s Changed
|
|
||||||
|
|
||||||
* fix(pivot): only use unique classes in the pivot union (Fixes #1606) (#1607) @pataar
|
|
||||||
* docs(pr): remove the changelog checklist item (#1608) @pataar
|
|
||||||
* Create update-changelog.yaml (#1605) @barryvdh
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.1...v3.2.2
|
|
||||||
|
|
||||||
## 3.2.1 - 2024-10-28
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
|
|
||||||
* chore: Fix the description of unused option by @KentarouTakeda in https://github.com/barryvdh/laravel-ide-helper/pull/1600
|
|
||||||
* feat(pivot): add support for multiple pivot types when using the same accessor by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1597
|
|
||||||
* Add support for `AsCollection::using` and `AsEnumCollection::of` casts by @uno-sw in https://github.com/barryvdh/laravel-ide-helper/pull/1577
|
|
||||||
* Smarter reset by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1603
|
|
||||||
* feat: use `numeric` type on fields with `decimal` casts by @ekisu in https://github.com/barryvdh/laravel-ide-helper/pull/1583
|
|
||||||
|
|
||||||
### New Contributors
|
|
||||||
|
|
||||||
* @uno-sw made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1577
|
|
||||||
* @ekisu made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1583
|
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.0...v3.2.1
|
|
||||||
|
|
||||||
## 3.2.0 - 2024-10-18
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fix type of hashed model property to `string`
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Update view "version" variable name to avoid potential conflicts
|
|
||||||
|
|
||||||
- Add support for EloquentBuilder generics introduced in Laravel 11.15.
|
|
||||||
|
|
||||||
- Drop support for Laravel versions earlier than 11.15.
|
|
||||||
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Introduce `enforce_nullable_relationships` configuration option to control how nullable Eloquent relationships are enforced during static analysis. This provides flexibility for scenarios where application logic ensures data integrity without relying on database constraints. [#1580 / jeramyhing](https://github.com/barryvdh/laravel-ide-helper/pull/1580)
|
|
||||||
|
|
||||||
- Add support for AsCollection::using and AsEnumCollection::of casts [#1577 / uno-sw](https://github.com/barryvdh/laravel-ide-helper/pull/1577)
|
|
||||||
|
|
||||||
|
|
||||||
## 3.1.0 - 2024-07-12
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fix return value of query scopes from parent class [#1366 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1366)
|
|
||||||
- Add static to isBuiltin() check in ide-helper:models [#1541 / bram-pkg](https://github.com/barryvdh/laravel-ide-helper/pull/1541)
|
|
||||||
- Fix for getSomethingAttribute functions which return a collection with type templating in the phpDoc. [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add type to pivot when using a custom pivot class [#1518 / d3v2a](https://github.com/barryvdh/laravel-ide-helper/pull/1518)
|
|
||||||
- Add support in morphTo relationship for null values [#1547 / matysekmichal](https://github.com/barryvdh/laravel-ide-helper/pull/1547)
|
|
||||||
- Add support for AsEnumCollection casts [#1557 / Braunson](https://github.com/barryvdh/laravel-ide-helper/pull/1557)
|
|
||||||
- Support for Attribute class in attributes [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
|
|
||||||
|
|
||||||
## 3.0.0 - 2024-03-01
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Support for Laravel 11 [#1520 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1520)
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Make `--reset` always keep the text and remove `--smart-reset`. Always skip the classname [#1523 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1523) & [#1525 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1525)
|
|
||||||
- Use short types (`int` and `bool` instead of `integer` and `boolean`) [#1524 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1524)
|
|
||||||
|
|
||||||
### Removed
|
|
||||||
|
|
||||||
- Support for Laravel 9 and use of doctrine/dbal [#1512 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1512)
|
|
||||||
With this functionality gone, a few changes have been made:
|
|
||||||
- support for custom datatypes has been dropped (config `custom_db_types`) unknown data types default to `string` now and to fix the type, add a proper cast in Eloquent
|
|
||||||
- You *might* have top-level dependency on doctrine/dbal. This may have been in the past due to ide-helper, we suggest to check if you still need it and remove it otherwise
|
|
||||||
- Minimum PHP version, due to Laravel 10, is now PHP 8.1
|
|
||||||
|
|
||||||
|
|
||||||
## 2024-02-15, 2.15.1
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fix final class keyword in wrong position [#1517 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1517)
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
## 2024-02-14, 2.15.0
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fix case issue in `ModelsCommand::unsetMethod()` [#1453 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/1453)
|
|
||||||
- Fix non-facade classes will result in no autocomplete [#841 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/841)
|
|
||||||
- Skip swoole, otherwise fatal error [#1477 / TimoFrenzel](https://github.com/barryvdh/laravel-ide-helper/pull/1477)
|
|
||||||
- Fix vulnerability CVE-2021-43608 [#1392 / allanlaal](https://github.com/barryvdh/laravel-ide-helper/pull/1392)
|
|
||||||
- Reset foreignKeyConstraintsColumns on model loop start [#1461 / snmatsui](https://github.com/barryvdh/laravel-ide-helper/pull/1461)
|
|
||||||
- Accept scope & scopes as relation [#1452 / Muetze42](https://github.com/barryvdh/laravel-ide-helper/pull/1452)
|
|
||||||
- Fix #1300 relation_return_type must take precedence if it is defined [#1394 / menthol](https://github.com/barryvdh/laravel-ide-helper/pull/1394)
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Disable inspections of helper files [#1486 / eidng8](https://github.com/barryvdh/laravel-ide-helper/pull/1486)
|
|
||||||
- Removed support for Laravel 8 and therefore for PHP < 8.0 [#1504 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1504)
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add support for enum default arguments using enum cases. [#1464 / d8vjork](https://github.com/barryvdh/laravel-ide-helper/pull/1464)
|
|
||||||
- Add support for real-time facades in the helper file. [#1455 / filipac](https://github.com/barryvdh/laravel-ide-helper/pull/1455)
|
|
||||||
- Add support for relations with composite keys. [#1479 / calebdw](https://github.com/barryvdh/laravel-ide-helper/pull/1479)
|
|
||||||
- Add support for attribute accessors with no backing field or type hinting [#1411 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1411).
|
|
||||||
- Add support for AsCollection and AsArrayObject casts [#1393 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/1393)
|
|
||||||
- Reintroduce support for multi-db setups [#1426 / benpoulson](https://github.com/barryvdh/laravel-ide-helper/pull/1426)
|
|
||||||
- Support the BINARY(...) database field type [#1434 / Sfonxs](https://github.com/barryvdh/laravel-ide-helper/pull/1434)
|
|
||||||
- Add AllowDynamicProperties Attribute to cooperate with php8.2 deprecation [#1428 / GeoSot](https://github.com/barryvdh/laravel-ide-helper/pull/1428)
|
|
||||||
|
|
||||||
## 2024-02-05, 2.14.0
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Official support for Lumen has been dropped [#1425 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1425)
|
|
||||||
- Refactor resolving of null information for custom casted attribute types [#1330 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1330)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Catch exceptions when loading aliases [#1465 / dongm2ez](https://github.com/barryvdh/laravel-ide-helper/pull/1465)
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add support for nikic/php-parser 5 (next to 4) [#1502 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1502)
|
|
||||||
- Add support for `immutable_date:*` and `immutable_datetime:*` casts. [#1380 / thekonz](https://github.com/barryvdh/laravel-ide-helper/pull/1380)
|
|
||||||
- Add support for attribute accessors marked as protected. [#1339 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1339)
|
|
||||||
|
|
||||||
## 2023-02-04, 2.13.0
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fix return type of methods provided by `SoftDeletes` [#1345 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1345)
|
|
||||||
- Handle PHP 8.1 deprecation warnings when passing `null` to `new \ReflectionClass` [#1351 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1351)
|
|
||||||
- Fix issue where \Eloquent is not included when using write_mixin [#1352 / Jefemy](https://github.com/barryvdh/laravel-ide-helper/pull/1352)
|
|
||||||
- Fix model factory method arguments for Laravel >= 9 [#1361 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1361)
|
|
||||||
- Improve return type of mock helper methods in tests [#1405 / bentleyo](https://github.com/barryvdh/laravel-ide-helper/pull/1405)
|
|
||||||
- Fix Castable class if failed to detect it from return types [#1388 / kwarcu](https://github.com/barryvdh/laravel-ide-helper/pull/1388)
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Added Laravel 10 support [#1407 / lptn](https://github.com/barryvdh/laravel-ide-helper/pull/1407)
|
|
||||||
- Add support for custom casts that implement `CastsInboundAttributes` [#1329 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1329)
|
|
||||||
- Add option `use_generics_annotations` for collection type hints [#1298 / tanerkay](https://github.com/barryvdh/laravel-ide-helper/pull/1298)
|
|
||||||
|
|
||||||
## 2022-03-06, 2.12.3
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fix date and datetime handling for attributes that set a serialization format option for the Carbon instance [#1324 / FLeudts](https://github.com/barryvdh/laravel-ide-helper/pull/1324)
|
|
||||||
- Fix composer conflict with composer/pcre version 2/3. [#1327 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1327)
|
|
||||||
|
|
||||||
## 2022-02-08, 2.12.2
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Remove composer dependency, use copy of ClassMapGenerator [#1313 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1313)
|
|
||||||
|
|
||||||
## 2022-01-24, 2.12.1
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Properly handle `Castable`s without return type. [#1306 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1306)
|
|
||||||
|
|
||||||
## 2022-01-23, 2.12.0
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add support for custom casts that using `Castable` [#1287 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1287)
|
|
||||||
- Added Laravel 9 support [#1297 / rcerljenko](https://github.com/barryvdh/laravel-ide-helper/pull/1297)
|
|
||||||
- Added option `additional_relation_return_types` for custom relations that don't fit the typical naming scheme
|
|
||||||
|
|
||||||
## 2022-01-03, 2.11.0
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add support for Laravel 8.77 Attributes [#1289 / SimonJnsson](https://github.com/barryvdh/laravel-ide-helper/pull/1289)
|
|
||||||
- Add support for cast types `decimal:*`, `encrypted:*`, `immutable_date`, `immutable_datetime`, `custom_datetime`, and `immutable_custom_datetime` [#1262 / miken32](https://github.com/barryvdh/laravel-ide-helper/pull/1262)
|
|
||||||
- Add support of variadic parameters in `ide-helper:models` [#1234 / shaffe-fr](https://github.com/barryvdh/laravel-ide-helper/pull/1234)
|
|
||||||
- Add support of custom casts without properties [#1267 / sparclex](https://github.com/barryvdh/laravel-ide-helper/pull/1267)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fix recursively searching for `HasFactory` and `Macroable` traits [#1216 / daniel-de-wit](https://github.com/barryvdh/laravel-ide-helper/pull/1216)
|
|
||||||
- Use platformName to determine db type when casting boolean types [#1212 / stockalexander](https://github.com/barryvdh/laravel-ide-helper/pull/1212)
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Move default models helper filename to config [#1241 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
|
|
||||||
|
|
||||||
## 2021-06-18, 2.10.1
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Added Type registration according to [Custom Mapping Types documentation](https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#custom-mapping-types) [#1228 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fixing issue where configured custom_db_types could cause a DBAL exception to be thrown while running `ide-helper:models` [#1228 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
|
|
||||||
|
|
||||||
## 2021-04-09, 2.10.0
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Allowing Methods to be set or unset in ModelHooks [#1198 / jenga201](https://github.com/barryvdh/laravel-ide-helper/pull/1198)
|
|
||||||
Note: the visibility of `\Barryvdh\LaravelIdeHelper\Console\ModelsCommand::setMethod` has been changed to **public**!
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fixing issue where incorrect autoloader unregistered [#1210 / tezhm](https://github.com/barryvdh/laravel-ide-helper/pull/1210)
|
|
||||||
|
|
||||||
## 2021-04-02, 2.9.3
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Support both customized namespace factories as well as default resolvable ones [#1201 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1201)
|
|
||||||
|
|
||||||
## 2021-04-01, 2.9.2
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Model hooks for adding custom information from external sources to model classes through the ModelsCommand [#945 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/945)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Fix ide-helper:models exception if model doesn't have factory [#1196 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1196)
|
|
||||||
- Running tests triggering post_migrate hooks [#1193 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1193)
|
|
||||||
- Array_merge error when config is cached prior to package install [#1184 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1184)
|
|
||||||
|
|
||||||
## 2021-03-15, 2.9.1
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Generate PHPDoc for Laravel 8.x factories [#1074 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1074)
|
|
||||||
- Add a comment to a property like table columns [#1168 / biiiiiigmonster](https://github.com/barryvdh/laravel-ide-helper/pull/1168)
|
|
||||||
- Added `post_migrate` hook to run commands after a migration [#1163 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1163)
|
|
||||||
- Allow for PhpDoc for macros with union types [#1148 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1148)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Error when generating helper for invokable classes [#1124 / standaniels](https://github.com/barryvdh/laravel-ide-helper/pull/1124)
|
|
||||||
- Fix broken ReflectionUnionTypes [#1132 / def-studio](https://github.com/barryvdh/laravel-ide-helper/pull/1132)
|
|
||||||
- Relative class names are not converted to fully-qualified class names [#1005 / SavKS](https://github.com/barryvdh/laravel-ide-helper/pull/1005)
|
|
||||||
|
|
||||||
## 2020-12-30, 2.9.0
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Dropped support for Laravel 6 and Laravel 7, as well as support for PHP 7.2 and added support for doctrine/dbal:^3 [#1114 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1114)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- `Macro::initPhpDoc()` will save original docblock if present [#1116 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1116)
|
|
||||||
- `Alias` will grab macros from `\Illuminate\Database\Eloquent\Builder` too [#1118 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1118)
|
|
||||||
|
|
||||||
## 2020-12-08, 2.8.2
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Fix phpdoc generate for custom cast with parameter [#986 / artelkr](https://github.com/barryvdh/laravel-ide-helper/pull/986)
|
|
||||||
- Created a possibility to add custom relation type [#987 / efinder2](https://github.com/barryvdh/laravel-ide-helper/pull/987)
|
|
||||||
- Added `@see` with macro/mixin definition location to PhpDoc [#1054 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1054)
|
|
||||||
- Initial compatibility for PHP8 [#1106 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1106)
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Implement DeferrableProvider [#914 / kon-shou](https://github.com/barryvdh/laravel-ide-helper/pull/914)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Compatibility with Lumen [#1043 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1043)
|
|
||||||
- Allow model_locations to have glob patterns [#1059 / saackearl](https://github.com/barryvdh/laravel-ide-helper/pull/1059)
|
|
||||||
- Error when generating helper for macroable classes which are not facades and contain a "fake" method [#1066 / domkrm] (https://github.com/barryvdh/laravel-ide-helper/pull/1066)
|
|
||||||
- Casts with a return type of `static` or `$this` now resolve to an instance of the cast [#1103 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1103)
|
|
||||||
|
|
||||||
### Removed
|
|
||||||
|
|
||||||
- Removed format and broken generateJsonHelper [#1053 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1053)
|
|
||||||
|
|
||||||
## 2020-09-07, 2.8.1
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Support Laravel 8 [#1022 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1022)
|
|
||||||
- Add option to force usage of FQN [#1031 / edvordo](https://github.com/barryvdh/laravel-ide-helper/pull/1031)
|
|
||||||
- Add support for macros of all macroable classes [#1006 / domkrm](https://github.com/barryvdh/laravel-ide-helper/pull/1006)
|
|
||||||
|
|
||||||
## 2020-08-11, 2.8.0
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add static return type to builder methods [#924 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/924)
|
|
||||||
- Add `optional` to meta generator for PhpStorm [#932 / halaei](https://github.com/barryvdh/laravel-ide-helper/pull/932)
|
|
||||||
- Decimal columns as string in Models [#948 / fgibaux](https://github.com/barryvdh/laravel-ide-helper/pull/948)
|
|
||||||
- Simplify full namespaces for already included resources [#954 / LANGERGabriel](https://github.com/barryvdh/laravel-ide-helper/pull/954)
|
|
||||||
- Make writing relation count properties optional [#969 / AegirLeet](https://github.com/barryvdh/laravel-ide-helper/pull/969)
|
|
||||||
- Add more methods able to resolve container instances [#996 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/996)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Test `auth` is bound before detect Auth driver [#946 / zhwei](https://github.com/barryvdh/laravel-ide-helper/pull/946)
|
|
||||||
- Fix inline doc-block for final models [#944 / Gummibeer](https://github.com/barryvdh/laravel-ide-helper/pull/955)
|
|
||||||
|
|
||||||
## 2020-04-22, 2.7.0
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add `ignored_models` as config option [#890 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/890)
|
|
||||||
- Infer return type from reflection if no phpdoc given [#906 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/906)
|
|
||||||
- Add custom collection support for get and all methods [#903 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/903)
|
|
||||||
- if a model implements interfaces, include them in the stub [#920 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/920)
|
|
||||||
- Generate noinspections PHPStorm tags [#905 / mzglinski](https://github.com/barryvdh/laravel-ide-helper/pull/905)
|
|
||||||
- Added support for Laravel 7 custom casts [#913 / belamov](https://github.com/barryvdh/laravel-ide-helper/pull/913)
|
|
||||||
- Ability to use patterns for model_locations [#921 / 4n70w4](https://github.com/barryvdh/laravel-ide-helper/pull/921)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- MorphToMany relations with query not working [#894 / UksusoFF](https://github.com/barryvdh/laravel-ide-helper/pull/894)
|
|
||||||
- Fix camelCase duplicated properties generator [#881 / bop10](https://github.com/barryvdh/laravel-ide-helper/pull/881)
|
|
||||||
- Prevent generation of invalid code for certain parameter default values [#901 / loilo](https://github.com/barryvdh/laravel-ide-helper/pull/901)
|
|
||||||
- Make hasOne and morphOne nullable [#864 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/864)
|
|
||||||
- Remove unnecessary and wrong definition of SoftDelete methods [#918 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/918)
|
|
||||||
- Unregister meta command custom autoloader when it is no longer needed [#919 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/919)
|
|
||||||
|
|
||||||
## 2020-02-25, 2.6.7
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Support for Laravel 7 [commit by barryvdh](https://github.com/barryvdh/laravel-ide-helper/commit/edd69c5e0508972c81f1f7173236de2459c45814)
|
|
||||||
|
|
||||||
## 2019-12-02, 2.6.6
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- Add splat operator (...) support [#860 / ngmy](https://github.com/barryvdh/laravel-ide-helper/pull/860)
|
|
||||||
- Add support for custom date class via Date::use() [#859 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/859)
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- Prevent undefined property errors [#877 / matt-allan](https://github.com/barryvdh/laravel-ide-helper/pull/877)
|
|
||||||
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Missing an older changelog? Feel free to submit a PR!
|
|
||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
# The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) Barry vd. Heuvel <barryvdh@gmail.com>
|
|
||||||
|
|
||||||
> Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
> of this software and associated documentation files (the "Software"), to deal
|
|
||||||
> in the Software without restriction, including without limitation the rights
|
|
||||||
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
> copies of the Software, and to permit persons to whom the Software is
|
|
||||||
> furnished to do so, subject to the following conditions:
|
|
||||||
>
|
|
||||||
> The above copyright notice and this permission notice shall be included in
|
|
||||||
> all copies or substantial portions of the Software.
|
|
||||||
>
|
|
||||||
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
> THE SOFTWARE.
|
|
||||||
@@ -1,379 +0,0 @@
|
|||||||
# IDE Helper Generator for Laravel
|
|
||||||
|
|
||||||
[](https://github.com/barryvdh/laravel-ide-helper/actions)
|
|
||||||
[](http://choosealicense.com/licenses/mit/)
|
|
||||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
|
||||||
[](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
|
||||||
[](https://fruitcake.nl/)
|
|
||||||
|
|
||||||
**Complete PHPDocs, directly from the source**
|
|
||||||
|
|
||||||
This package generates helper files that enable your IDE to provide accurate autocompletion.
|
|
||||||
Generation is done based on the files in your project, so they are always up-to-date.
|
|
||||||
|
|
||||||
The 3.x branch supports Laravel 10 and later. For older version, use the 2.x releases.
|
|
||||||
|
|
||||||
- [Installation](#installation)
|
|
||||||
- [Usage](#usage)
|
|
||||||
- [Automatic PHPDoc generation for Laravel Facades](#automatic-phpdoc-generation-for-laravel-facades)
|
|
||||||
- [Automatic PHPDocs for models](#automatic-phpdocs-for-models)
|
|
||||||
- [Model Directories](#model-directories)
|
|
||||||
- [Ignore Models](#ignore-models)
|
|
||||||
- [Model Hooks](#model-hooks)
|
|
||||||
- [Automatic PHPDocs generation for Laravel Fluent methods](#automatic-phpdocs-generation-for-laravel-fluent-methods)
|
|
||||||
- [Auto-completion for factory builders](#auto-completion-for-factory-builders)
|
|
||||||
- [PhpStorm Meta for Container instances](#phpstorm-meta-for-container-instances)
|
|
||||||
- [License](#license)
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Require this package with composer using the following command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
composer require --dev barryvdh/laravel-ide-helper
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
### TL;DR
|
|
||||||
|
|
||||||
Run this to generate autocompletion for Facades. This creates _ide_helper.php
|
|
||||||
|
|
||||||
```
|
|
||||||
php artisan ide-helper:generate
|
|
||||||
```
|
|
||||||
|
|
||||||
Run this to add phpdocs for your models. Add -RW to Reset existing phpdocs and Write to the models directly.
|
|
||||||
```
|
|
||||||
php artisan ide-helper:models -RW
|
|
||||||
```
|
|
||||||
|
|
||||||
If you don't want the full _ide_helper.php file, you can run add `--write-eloquent-helper` to the model command to generate small version, which is required for the `@mixin \Eloquent` to be able to add the QueryBuilder methods.
|
|
||||||
|
|
||||||
If you don't want to add all the phpdocs to your Models directly, you can use `--nowrite` to create a separate file. The `--write-mixin` option can be used to only add a `@mixin` to your models, but add the generated phpdocs in a separate file. This avoids having the results marked as duplicate.
|
|
||||||
|
|
||||||
|
|
||||||
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
|
||||||
|
|
||||||
- `php artisan ide-helper:generate` - [PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
|
|
||||||
- `php artisan ide-helper:models` - [PHPDocs for models](#automatic-phpdocs-for-models)
|
|
||||||
- `php artisan ide-helper:meta` - [PhpStorm Meta file](#phpstorm-meta-for-container-instances)
|
|
||||||
|
|
||||||
|
|
||||||
> Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
|
|
||||||
|
|
||||||
### Automatic PHPDoc generation for Laravel Facades
|
|
||||||
|
|
||||||
You can now re-generate the docs yourself (for future updates)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan ide-helper:generate
|
|
||||||
```
|
|
||||||
|
|
||||||
This will generate the file `_ide_helper.php` which is expected to be additionally parsed by your IDE for autocomplete. You can use the config `filename` to change its name.
|
|
||||||
|
|
||||||
You can configure your `composer.json` to do this each time you update your dependencies:
|
|
||||||
|
|
||||||
```js
|
|
||||||
"scripts": {
|
|
||||||
"post-update-cmd": [
|
|
||||||
"Illuminate\\Foundation\\ComposerScripts::postUpdate",
|
|
||||||
"@php artisan ide-helper:generate",
|
|
||||||
"@php artisan ide-helper:meta"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers`.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
|
|
||||||
```
|
|
||||||
|
|
||||||
The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
|
|
||||||
|
|
||||||
Some classes need a working database connection. If you do not have a default working connection, some facades will not be included.
|
|
||||||
You can use an in-memory SQLite driver by adding the `-M` option.
|
|
||||||
|
|
||||||
If you use [real-time facades](https://laravel.com/docs/master/facades#real-time-facades) in your app, those will also be included in the generated file using a `@mixin` annotation and extending the original class underneath the facade.
|
|
||||||
|
|
||||||
> **Note**: this feature uses the generated real-time facades files in the `storage/framework/cache` folder. Those files are generated on-demand as you use the real-time facade, so if the framework has not generated that first, it will not be included in the helper file. Run the route/command/code first and then regenerate the helper file and this time the real-time facade will be included in it.
|
|
||||||
|
|
||||||
You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option.
|
|
||||||
The `Illuminate/Support/helpers.php` is already set up, but you can add/remove your own files in the config file.
|
|
||||||
|
|
||||||
### Automatic PHPDoc generation for macros and mixins
|
|
||||||
|
|
||||||
This package can generate PHPDocs for macros and mixins which will be added to the `_ide_helper.php` file.
|
|
||||||
|
|
||||||
But this only works if you use type hinting when declaring a macro.
|
|
||||||
|
|
||||||
```php
|
|
||||||
Str::macro('concat', function(string $str1, string $str2) : string {
|
|
||||||
return $str1 . $str2;
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Automatic PHPDocs for models
|
|
||||||
|
|
||||||
If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate
|
|
||||||
PHPDocs, based on table columns, relations and getters/setters.
|
|
||||||
|
|
||||||
> Note: this command requires a working database connection to introspect the table of each model
|
|
||||||
|
|
||||||
By default, you are asked to overwrite or write to a separate file (`_ide_helper_models.php`).
|
|
||||||
You can write the comments directly to your Model file, using the `--write (-W)` option, or
|
|
||||||
force to not write with `--nowrite (-N)`.
|
|
||||||
|
|
||||||
Alternatively using the `--write-mixin (-M)` option will only add a mixin tag to your Model file,
|
|
||||||
writing the rest in (`_ide_helper_models.php`).
|
|
||||||
The class name will be different from the model, avoiding the IDE duplicate annoyance.
|
|
||||||
|
|
||||||
> Please make sure to back up your models, before writing the info.
|
|
||||||
|
|
||||||
> You need the _ide_helper.php file to add the QueryBuilder methods. You can add --write-eloquent-helper/-E to generate a minimal version. If this file does not exist, you will be prompted for it.
|
|
||||||
|
|
||||||
Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods.
|
|
||||||
|
|
||||||
With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan ide-helper:models "App\Models\Post"
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
|
||||||
/**
|
|
||||||
* App\Models\Post
|
|
||||||
*
|
|
||||||
* @property integer $id
|
|
||||||
* @property integer $author_id
|
|
||||||
* @property string $title
|
|
||||||
* @property string $text
|
|
||||||
* @property \Illuminate\Support\Carbon $created_at
|
|
||||||
* @property \Illuminate\Support\Carbon $updated_at
|
|
||||||
* @property-read \User $author
|
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post whereTitle($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post forAuthors(\User ...$authors)
|
|
||||||
* …
|
|
||||||
*/
|
|
||||||
```
|
|
||||||
|
|
||||||
With the `--write-mixin (-M)` option
|
|
||||||
```php
|
|
||||||
/**
|
|
||||||
* …
|
|
||||||
* @mixin IdeHelperPost
|
|
||||||
*/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Model Directories
|
|
||||||
|
|
||||||
By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan ide-helper:models "App\Models\Post" "App\Models\User"
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also scan a different directory, using the `--dir` option (relative from the base path):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
|
|
||||||
```
|
|
||||||
|
|
||||||
You can publish the config file (`php artisan vendor:publish`) and set the default directories.
|
|
||||||
|
|
||||||
#### Ignore Models
|
|
||||||
|
|
||||||
Models can be ignored using the `--ignore (-I)` option
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan ide-helper:models --ignore="App\Models\Post,App\Models\User"
|
|
||||||
```
|
|
||||||
|
|
||||||
Or can be ignored by setting the `ignored_models` config
|
|
||||||
|
|
||||||
```php
|
|
||||||
'ignored_models' => [
|
|
||||||
App\Post::class,
|
|
||||||
Api\User::class
|
|
||||||
],
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Magic `where*` methods
|
|
||||||
|
|
||||||
Eloquent allows calling `where<Attribute>` on your models, e.g. `Post::whereTitle(…)` and automatically translates this to e.g. `Post::where('title', '=', '…')`.
|
|
||||||
|
|
||||||
If for some reason it's undesired to have them generated (one for each column), you can disable this via config `write_model_magic_where` and setting it to `false`.
|
|
||||||
|
|
||||||
#### Magic `*_count` and `*_exists` properties
|
|
||||||
|
|
||||||
You may use the [`::withCount`](https://laravel.com/docs/master/eloquent-relationships#counting-related-models) and [`::withExists`](https://laravel.com/docs/master/eloquent-relationships#other-aggregate-functions) methods to count the number results from a relationship without actually loading them. Those results are then placed in attributes following the `<columnname>_count` and `<columnname>_exists` convention.
|
|
||||||
|
|
||||||
By default, these attributes are generated in the phpdoc. You can turn them off by setting the config `write_model_relation_count_properties` and `write_model_relation_exists_properties` to `false`.
|
|
||||||
|
|
||||||
#### Generics annotations
|
|
||||||
|
|
||||||
Laravel 9 introduced generics annotations in DocBlocks for collections. PhpStorm 2022.3 and above support the use of generics annotations within `@property` and `@property-read` declarations in DocBlocks, e.g. `Collection<User>` instead of `Collection|User[]`.
|
|
||||||
|
|
||||||
These can be disabled by setting the config `use_generics_annotations` to `false`.
|
|
||||||
|
|
||||||
#### Support `@comment` based on DocBlock
|
|
||||||
|
|
||||||
In order to better support IDEs, relations and getters/setters can also add a comment to a property like table columns. Therefore a custom docblock `@comment` is used:
|
|
||||||
```php
|
|
||||||
class Users extends Model
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* @comment Get User's full name
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getFullNameAttribute(): string
|
|
||||||
{
|
|
||||||
return $this->first_name . ' ' .$this->last_name ;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// => after generate models
|
|
||||||
|
|
||||||
/**
|
|
||||||
* App\Models\Users
|
|
||||||
*
|
|
||||||
* @property-read string $full_name Get User's full name
|
|
||||||
* …
|
|
||||||
*/
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Dedicated Eloquent Builder methods
|
|
||||||
|
|
||||||
A new method to the eloquent models was added called `newEloquentBuilder` [Reference](https://timacdonald.me/dedicated-eloquent-model-query-builders/) where we can
|
|
||||||
add support for creating a new dedicated class instead of using local scopes in the model itself.
|
|
||||||
|
|
||||||
If for some reason it's undesired to have them generated (one for each column), you can disable this via config `write_model_external_builder_methods` and setting it to `false`.
|
|
||||||
|
|
||||||
#### Custom Relationship Types
|
|
||||||
|
|
||||||
If you are using relationships not built into Laravel you will need to specify the name and returning class in the config to get proper generation.
|
|
||||||
|
|
||||||
```php
|
|
||||||
'additional_relation_types' => [
|
|
||||||
'externalHasMany' => \My\Package\externalHasMany::class
|
|
||||||
],
|
|
||||||
```
|
|
||||||
|
|
||||||
Found relationships will typically generate a return value based on the name of the relationship.
|
|
||||||
|
|
||||||
If your custom relationships don't follow this traditional naming scheme you can define its return type manually. The available options are `many` and `morphTo`.
|
|
||||||
|
|
||||||
```php
|
|
||||||
'additional_relation_return_types' => [
|
|
||||||
'externalHasMultiple' => 'many'
|
|
||||||
],
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Model Hooks
|
|
||||||
|
|
||||||
If you need additional information on your model from sources that are not handled by default, you can hook in to the
|
|
||||||
generation process with model hooks to add extra information on the fly.
|
|
||||||
Simply create a class that implements `ModelHookInterface` and add it to the `model_hooks` array in the config:
|
|
||||||
|
|
||||||
```php
|
|
||||||
'model_hooks' => [
|
|
||||||
MyCustomHook::class,
|
|
||||||
],
|
|
||||||
```
|
|
||||||
|
|
||||||
The `run` method will be called during generation for every model and receives the current running `ModelsCommand` and the current `Model`, e.g.:
|
|
||||||
|
|
||||||
```php
|
|
||||||
class MyCustomHook implements ModelHookInterface
|
|
||||||
{
|
|
||||||
public function run(ModelsCommand $command, Model $model): void
|
|
||||||
{
|
|
||||||
if (! $model instanceof MyModel) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$command->setProperty('custom', 'string', true, false, 'My custom property');
|
|
||||||
$command->unsetMethod('method');
|
|
||||||
$command->setMethod('method', $command->getMethodType($model, '\Some\Class'), ['$param']);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
|
||||||
/**
|
|
||||||
* MyModel
|
|
||||||
*
|
|
||||||
* @property integer $id
|
|
||||||
* @property-read string $custom
|
|
||||||
```
|
|
||||||
|
|
||||||
### Automatic PHPDocs generation for Laravel Fluent methods
|
|
||||||
|
|
||||||
If you need PHPDocs support for Fluent methods in migration, for example
|
|
||||||
|
|
||||||
```php
|
|
||||||
$table->string("somestring")->nullable()->index();
|
|
||||||
```
|
|
||||||
|
|
||||||
After publishing vendor, simply change the `include_fluent` line in your `config/ide-helper.php` file into:
|
|
||||||
|
|
||||||
```php
|
|
||||||
'include_fluent' => true,
|
|
||||||
```
|
|
||||||
|
|
||||||
Then run `php artisan ide-helper:generate`, you will now see all Fluent methods recognized by your IDE.
|
|
||||||
|
|
||||||
### Auto-completion for factory builders
|
|
||||||
|
|
||||||
If you would like the `factory()->create()` and `factory()->make()` methods to return the correct model class,
|
|
||||||
you can enable custom factory builders with the `include_factory_builders` line in your `config/ide-helper.php` file.
|
|
||||||
Deprecated for Laravel 8 or latest.
|
|
||||||
|
|
||||||
```php
|
|
||||||
'include_factory_builders' => true,
|
|
||||||
```
|
|
||||||
|
|
||||||
For this to work, you must also publish the PhpStorm Meta file (see below).
|
|
||||||
|
|
||||||
## PhpStorm Meta for Container instances
|
|
||||||
|
|
||||||
It's possible to generate a PhpStorm meta file to [add support for factory design pattern](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html).
|
|
||||||
For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container.
|
|
||||||
For example, `events` will return an `Illuminate\Events\Dispatcher` object,
|
|
||||||
so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan ide-helper:meta
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
|
||||||
app('events')->fire();
|
|
||||||
\App::make('events')->fire();
|
|
||||||
|
|
||||||
/** @var \Illuminate\Foundation\Application $app */
|
|
||||||
$app->make('events')->fire();
|
|
||||||
|
|
||||||
// When the key is not found, it uses the argument as class name
|
|
||||||
app('App\SomeClass');
|
|
||||||
// Also works with
|
|
||||||
app(App\SomeClass::class);
|
|
||||||
```
|
|
||||||
|
|
||||||
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
|
||||||
|
|
||||||
> Note: When you receive a FatalException: class not found, check your config
|
|
||||||
> (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
|
|
||||||
|
|
||||||
You can change the generated filename via the config `meta_filename`. This can be useful for cases where you want to take advantage of PhpStorm's support of the _directory_ `.phpstorm.meta.php/`: all files placed there are parsed, should you want to provide additional files to PhpStorm.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
|
||||||
|
|
||||||
+14
-65
@@ -1,19 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "barryvdh/laravel-ide-helper",
|
"name": "barryvdh/laravel-ide-helper",
|
||||||
"description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.",
|
"description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.",
|
||||||
|
"keywords": ["laravel", "autocomplete", "ide", "helper", "phpstorm", "netbeans", "sublime", "codeintel", "phpdoc"],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"keywords": [
|
|
||||||
"laravel",
|
|
||||||
"autocomplete",
|
|
||||||
"ide",
|
|
||||||
"helper",
|
|
||||||
"phpstorm",
|
|
||||||
"netbeans",
|
|
||||||
"sublime",
|
|
||||||
"codeintel",
|
|
||||||
"phpdoc",
|
|
||||||
"dev"
|
|
||||||
],
|
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
"name": "Barry vd. Heuvel",
|
"name": "Barry vd. Heuvel",
|
||||||
@@ -21,71 +10,31 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": "^8.2",
|
"php": ">=5.3.0",
|
||||||
"ext-json": "*",
|
"illuminate/config": "4.x",
|
||||||
"barryvdh/reflection-docblock": "^2.4",
|
"illuminate/support": "4.x",
|
||||||
"composer/class-map-generator": "^1.0",
|
"illuminate/console": "4.x",
|
||||||
"illuminate/console": "^11.15 || ^12",
|
"illuminate/filesystem": "4.x",
|
||||||
"illuminate/database": "^11.15 || ^12",
|
"illuminate/database": "4.x",
|
||||||
"illuminate/filesystem": "^11.15 || ^12",
|
"illuminate/view": "4.x",
|
||||||
"illuminate/support": "^11.15 || ^12"
|
"phpdocumentor/reflection-docblock": "^2.0.4",
|
||||||
|
"symfony/class-loader": "~2.3"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"ext-pdo_sqlite": "*",
|
"doctrine/dbal": "~2.3",
|
||||||
"friendsofphp/php-cs-fixer": "^3",
|
"phpunit/phpunit": "~4.0"
|
||||||
"illuminate/config": "^11.15 || ^12",
|
|
||||||
"illuminate/view": "^11.15 || ^12",
|
|
||||||
"mockery/mockery": "^1.4",
|
|
||||||
"orchestra/testbench": "^9.2 || ^10",
|
|
||||||
"phpunit/phpunit": "^10.5 || ^11.5.3",
|
|
||||||
"spatie/phpunit-snapshot-assertions": "^4 || ^5",
|
|
||||||
"vimeo/psalm": "^5.4",
|
|
||||||
"vlucas/phpdotenv": "^5"
|
|
||||||
},
|
},
|
||||||
"suggest": {
|
"suggest": {
|
||||||
"illuminate/events": "Required for automatic helper generation (^6|^7|^8|^9|^10|^11)."
|
"doctrine/dbal": "Load information from the database about models for phpdocs (~2.3)"
|
||||||
},
|
},
|
||||||
"minimum-stability": "dev",
|
|
||||||
"prefer-stable": true,
|
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"Barryvdh\\LaravelIdeHelper\\": "src"
|
"Barryvdh\\LaravelIdeHelper\\": "src"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"autoload-dev": {
|
|
||||||
"psr-4": {
|
|
||||||
"Barryvdh\\LaravelIdeHelper\\Tests\\": "tests"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"config": {
|
|
||||||
"allow-plugins": {
|
|
||||||
"composer/package-versions-deprecated": true
|
|
||||||
},
|
|
||||||
"sort-packages": true
|
|
||||||
},
|
|
||||||
"extra": {
|
"extra": {
|
||||||
"branch-alias": {
|
"branch-alias": {
|
||||||
"dev-master": "3.5-dev"
|
"dev-master": "1.11-dev"
|
||||||
},
|
|
||||||
"laravel": {
|
|
||||||
"providers": [
|
|
||||||
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"analyze": "psalm",
|
|
||||||
"check-style": [
|
|
||||||
"php-cs-fixer fix --diff --diff-format=udiff --dry-run",
|
|
||||||
"php-cs-fixer fix --diff --diff-format=udiff --dry-run --config=.php_cs.tests.php"
|
|
||||||
],
|
|
||||||
"fix-style": [
|
|
||||||
"php-cs-fixer fix",
|
|
||||||
"php-cs-fixer fix --config=.php-cs-fixer.tests.php"
|
|
||||||
],
|
|
||||||
"psalm-set-baseline": "psalm --set-baseline=psalm-baseline.xml",
|
|
||||||
"test": "phpunit",
|
|
||||||
"test-ci": "phpunit -d --without-creating-snapshots",
|
|
||||||
"test-regenerate": "phpunit -d --update-snapshots"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,354 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
return [
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Filename
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| The default filename.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'filename' => '_ide_helper.php',
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Models filename
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| The default filename for the models helper file.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'models_filename' => '_ide_helper_models.php',
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| PhpStorm meta filename
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| PhpStorm also supports the directory `.phpstorm.meta.php/` with arbitrary
|
|
||||||
| files in it, should you need additional files for your project; e.g.
|
|
||||||
| `.phpstorm.meta.php/laravel_ide_Helper.php'.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'meta_filename' => '.phpstorm.meta.php',
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Fluent helpers
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Set to true to generate commonly used Fluent methods.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'include_fluent' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Factory builders
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Set to true to generate factory generators for better factory()
|
|
||||||
| method auto-completion.
|
|
||||||
|
|
|
||||||
| Deprecated for Laravel 8 or latest.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'include_factory_builders' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Write model magic methods
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Set to false to disable write magic methods of model.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'write_model_magic_where' => true,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Write model external Eloquent builder methods
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Set to false to disable write external Eloquent builder methods.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'write_model_external_builder_methods' => true,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Write model relation count and exists properties
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Set to false to disable writing of relation count and exists properties
|
|
||||||
| to model DocBlocks.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'write_model_relation_count_properties' => true,
|
|
||||||
'write_model_relation_exists_properties' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Write Eloquent model mixins
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| This will add the necessary DocBlock mixins to the model class
|
|
||||||
| contained in the Laravel framework. This helps the IDE with
|
|
||||||
| auto-completion.
|
|
||||||
|
|
|
||||||
| Please be aware that this setting changes a file within the /vendor directory.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'write_eloquent_model_mixins' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Helper files to include
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Include helper files. By default not included, but can be toggled with the
|
|
||||||
| -- helpers (-H) option. Extra helper files can be included.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'include_helpers' => false,
|
|
||||||
|
|
||||||
'helper_files' => [
|
|
||||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
|
||||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Foundation/helpers.php',
|
|
||||||
],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Model locations to include
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Define in which directories the ide-helper:models command should look
|
|
||||||
| for models.
|
|
||||||
|
|
|
||||||
| glob patterns are supported to easier reach models in sub-directories,
|
|
||||||
| e.g. `app/Services/* /Models` (without the space).
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'model_locations' => [
|
|
||||||
'app',
|
|
||||||
],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Models to ignore
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Define which models should be ignored.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'ignored_models' => [
|
|
||||||
// App\MyModel::class,
|
|
||||||
],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Models hooks
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Define which hook classes you want to run for models to add custom information.
|
|
||||||
|
|
|
||||||
| Hooks should implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'model_hooks' => [
|
|
||||||
// App\Support\IdeHelper\MyModelHook::class
|
|
||||||
],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Extra classes
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| These implementations are not really extended, but called with magic functions.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'extra' => [
|
|
||||||
'Eloquent' => ['Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'],
|
|
||||||
'Session' => ['Illuminate\Session\Store'],
|
|
||||||
],
|
|
||||||
|
|
||||||
'magic' => [],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Interface implementations
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| These interfaces will be replaced with the implementing class. Some interfaces
|
|
||||||
| are detected by the helpers, others can be listed below.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'interfaces' => [
|
|
||||||
// App\MyInterface::class => App\MyImplementation::class,
|
|
||||||
],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Support for camel cased models
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| There are some Laravel packages (such as Eloquence) that allow for accessing
|
|
||||||
| Eloquent model properties via camel case, instead of snake case.
|
|
||||||
|
|
|
||||||
| Enabling this option will support these packages by saving all model
|
|
||||||
| properties as camel case, instead of snake case.
|
|
||||||
|
|
|
||||||
| For example, normally you would see this:
|
|
||||||
|
|
|
||||||
| * @property \Illuminate\Support\Carbon $created_at
|
|
||||||
| * @property \Illuminate\Support\Carbon $updated_at
|
|
||||||
|
|
|
||||||
| With this enabled, the properties will be this:
|
|
||||||
|
|
|
||||||
| * @property \Illuminate\Support\Carbon $createdAt
|
|
||||||
| * @property \Illuminate\Support\Carbon $updatedAt
|
|
||||||
|
|
|
||||||
| Note, it is currently an all-or-nothing option.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'model_camel_case_properties' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Property casts
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Cast the given "real type" to the given "type".
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'type_overrides' => [
|
|
||||||
'integer' => 'int',
|
|
||||||
'boolean' => 'bool',
|
|
||||||
],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Include DocBlocks from classes
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Include DocBlocks from classes to allow additional code inspection for
|
|
||||||
| magic methods and properties.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'include_class_docblocks' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Force FQN usage
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Use the fully qualified (class) name in DocBlocks,
|
|
||||||
| even if the class exists in the same namespace
|
|
||||||
| or there is an import (use className) of the class.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'force_fqn' => false,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Use generics syntax
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Use generics syntax within DocBlocks,
|
|
||||||
| e.g. `Collection<User>` instead of `Collection|User[]`.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'use_generics_annotations' => true,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Default return types for macros
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Define default return types for macros without explicit return types.
|
|
||||||
| e.g. `\Illuminate\Database\Query\Builder::class => 'static'`,
|
|
||||||
| `\Illuminate\Support\Str::class => 'string'`
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'macro_default_return_types' => [
|
|
||||||
Illuminate\Http\Client\Factory::class => Illuminate\Http\Client\PendingRequest::class,
|
|
||||||
],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Additional relation types
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| Sometimes it's needed to create custom relation types. The key of the array
|
|
||||||
| is the relationship method name. The value of the array is the fully-qualified
|
|
||||||
| class name of the relationship, e.g. `'relationName' => RelationShipClass::class`.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'additional_relation_types' => [],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Additional relation return types
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| When using custom relation types its possible for the class name to not contain
|
|
||||||
| the proper return type of the relation. The key of the array is the relationship
|
|
||||||
| method name. The value of the array is the return type of the relation ('many'
|
|
||||||
| or 'morphTo').
|
|
||||||
| e.g. `'relationName' => 'many'`.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'additional_relation_return_types' => [],
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Enforce nullable Eloquent relationships on not null columns
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| When set to true (default), this option enforces nullable Eloquent relationships.
|
|
||||||
| However, in cases where the application logic ensures the presence of related
|
|
||||||
| records it may be desirable to set this option to false to avoid unwanted null warnings.
|
|
||||||
|
|
|
||||||
| Default: true
|
|
||||||
| A not null column with no foreign key constraint will have a "nullable" relationship.
|
|
||||||
| * @property int $not_null_column_with_no_foreign_key_constraint
|
|
||||||
| * @property-read BelongsToVariation|null $notNullColumnWithNoForeignKeyConstraint
|
|
||||||
|
|
|
||||||
| Option: false
|
|
||||||
| A not null column with no foreign key constraint will have a "not nullable" relationship.
|
|
||||||
| * @property int $not_null_column_with_no_foreign_key_constraint
|
|
||||||
| * @property-read BelongsToVariation $notNullColumnWithNoForeignKeyConstraint
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
|
|
||||||
'enforce_nullable_relationships' => true,
|
|
||||||
|
|
||||||
/*
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
| Run artisan commands after migrations to generate model helpers
|
|
||||||
|--------------------------------------------------------------------------
|
|
||||||
|
|
|
||||||
| The specified commands should run after migrations are finished running.
|
|
||||||
|
|
|
||||||
*/
|
|
||||||
'post_migrate' => [
|
|
||||||
// 'ide-helper:models --nowrite',
|
|
||||||
],
|
|
||||||
|
|
||||||
];
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) Taylor Otwell
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
The templates here are based on the official VS Code extension by Laravel https://github.com/laravel/vs-code-extension
|
|
||||||
|
|
||||||
Modifications:
|
|
||||||
- return instead of echo
|
|
||||||
- do not serialize to JSON
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
return collect(Illuminate\Support\Facades\Gate::abilities())
|
|
||||||
->map(function ($policy, $key) {
|
|
||||||
$reflection = new ReflectionFunction($policy);
|
|
||||||
|
|
||||||
$policyClass = null;
|
|
||||||
|
|
||||||
$closureThis = $reflection->getClosureThis();
|
|
||||||
if ($closureThis && get_class($closureThis) === Illuminate\Auth\Access\Gate::class) {
|
|
||||||
$vars = $reflection->getClosureUsedVariables();
|
|
||||||
|
|
||||||
if (isset($vars['callback'])) {
|
|
||||||
[$policyClass, $method] = explode('@', $vars['callback']);
|
|
||||||
|
|
||||||
$reflection = new ReflectionMethod($policyClass, $method);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return [
|
|
||||||
'key' => $key,
|
|
||||||
'uri' => $reflection->getFileName(),
|
|
||||||
'policy_class' => $policyClass,
|
|
||||||
'lineNumber' => $reflection->getStartLine(),
|
|
||||||
];
|
|
||||||
})
|
|
||||||
->merge(
|
|
||||||
collect(Illuminate\Support\Facades\Gate::policies())->flatMap(function ($policy, $model) {
|
|
||||||
$methods = (new ReflectionClass($policy))->getMethods();
|
|
||||||
|
|
||||||
return collect($methods)->map(function (ReflectionMethod $method) use ($policy) {
|
|
||||||
return [
|
|
||||||
'key' => $method->getName(),
|
|
||||||
'uri' => $method->getFileName(),
|
|
||||||
'policy_class' => $policy,
|
|
||||||
'lineNumber' => $method->getStartLine(),
|
|
||||||
];
|
|
||||||
})->filter(function ($ability) {
|
|
||||||
return !in_array($ability['key'], ['allow', 'deny']);
|
|
||||||
});
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
->values()
|
|
||||||
->groupBy('key');
|
|
||||||
@@ -1,131 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
$local = collect(glob(config_path('/*.php')))
|
|
||||||
->merge(glob(config_path('**/*.php')))
|
|
||||||
->map(fn ($path) => [
|
|
||||||
(string) Illuminate\Support\Str::of($path)
|
|
||||||
->replace([config_path('/'), '.php'], '')
|
|
||||||
->replace('/', '.'),
|
|
||||||
$path,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$vendor = collect(glob(base_path('vendor/**/**/config/*.php')))->map(fn (
|
|
||||||
$path
|
|
||||||
) => [
|
|
||||||
(string) Illuminate\Support\Str::of($path)
|
|
||||||
->afterLast('/config/')
|
|
||||||
->replace('.php', '')
|
|
||||||
->replace('/', '.'),
|
|
||||||
$path,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$configPaths = $local
|
|
||||||
->merge($vendor)
|
|
||||||
->groupBy(0)
|
|
||||||
->map(fn ($items) => $items->pluck(1));
|
|
||||||
|
|
||||||
$cachedContents = [];
|
|
||||||
$cachedParsed = [];
|
|
||||||
|
|
||||||
function vsCodeGetConfigValue($value, $key, $configPaths)
|
|
||||||
{
|
|
||||||
$parts = explode('.', $key);
|
|
||||||
$toFind = $key;
|
|
||||||
$found = null;
|
|
||||||
|
|
||||||
while (count($parts) > 0) {
|
|
||||||
array_pop($parts);
|
|
||||||
$toFind = implode('.', $parts);
|
|
||||||
|
|
||||||
if ($configPaths->has($toFind)) {
|
|
||||||
$found = $toFind;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($found === null) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
$file = null;
|
|
||||||
$line = null;
|
|
||||||
|
|
||||||
if ($found === $key) {
|
|
||||||
$file = $configPaths->get($found)[0];
|
|
||||||
} else {
|
|
||||||
foreach ($configPaths->get($found) as $path) {
|
|
||||||
$cachedContents[$path] ??= file_get_contents($path);
|
|
||||||
$cachedParsed[$path] ??= token_get_all($cachedContents[$path]);
|
|
||||||
|
|
||||||
$keysToFind = Illuminate\Support\Str::of($key)
|
|
||||||
->replaceFirst($found, '')
|
|
||||||
->ltrim('.')
|
|
||||||
->explode('.');
|
|
||||||
|
|
||||||
if (is_numeric($keysToFind->last())) {
|
|
||||||
$index = $keysToFind->pop();
|
|
||||||
|
|
||||||
if ($index !== '0') {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
$key = collect(explode('.', $key));
|
|
||||||
$key->pop();
|
|
||||||
$key = $key->implode('.');
|
|
||||||
$value = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
$nextKey = $keysToFind->shift();
|
|
||||||
$expectedDepth = 1;
|
|
||||||
|
|
||||||
$depth = 0;
|
|
||||||
|
|
||||||
foreach ($cachedParsed[$path] as $token) {
|
|
||||||
if ($token === '[') {
|
|
||||||
$depth++;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($token === ']') {
|
|
||||||
$depth--;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!is_array($token)) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
$str = trim($token[1], '"\'');
|
|
||||||
|
|
||||||
if (
|
|
||||||
$str === $nextKey &&
|
|
||||||
$depth === $expectedDepth &&
|
|
||||||
$token[0] === T_CONSTANT_ENCAPSED_STRING
|
|
||||||
) {
|
|
||||||
$nextKey = $keysToFind->shift();
|
|
||||||
$expectedDepth++;
|
|
||||||
|
|
||||||
if ($nextKey === null) {
|
|
||||||
$file = $path;
|
|
||||||
$line = $token[2];
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($file) {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return [
|
|
||||||
'name' => $key,
|
|
||||||
'value' => $value,
|
|
||||||
'file' => $file === null ? null : str_replace(base_path('/'), '', $file),
|
|
||||||
'line' => $line,
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
return collect(Illuminate\Support\Arr::dot(config()->all()))
|
|
||||||
->map(fn ($value, $key) => vsCodeGetConfigValue($value, $key, $configPaths))
|
|
||||||
->filter()
|
|
||||||
->values();
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
return collect(app("Illuminate\Contracts\Http\Kernel")->getMiddlewareGroups())
|
|
||||||
->merge(app("Illuminate\Contracts\Http\Kernel")->getRouteMiddleware())
|
|
||||||
->map(function ($middleware, $key) {
|
|
||||||
$result = [
|
|
||||||
'class' => null,
|
|
||||||
'uri' => null,
|
|
||||||
'startLine' => null,
|
|
||||||
'parameters' => null,
|
|
||||||
'groups' => [],
|
|
||||||
];
|
|
||||||
|
|
||||||
if (is_array($middleware)) {
|
|
||||||
$result['groups'] = collect($middleware)->map(function ($m) {
|
|
||||||
if (!class_exists($m)) {
|
|
||||||
return [
|
|
||||||
'class' => $m,
|
|
||||||
'uri' => null,
|
|
||||||
'startLine' => null,
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
$reflected = new ReflectionClass($m);
|
|
||||||
$reflectedMethod = $reflected->getMethod('handle');
|
|
||||||
|
|
||||||
return [
|
|
||||||
'class' => $m,
|
|
||||||
'uri' => $reflected->getFileName(),
|
|
||||||
'startLine' =>
|
|
||||||
$reflectedMethod->getFileName() === $reflected->getFileName()
|
|
||||||
? $reflectedMethod->getStartLine()
|
|
||||||
: null,
|
|
||||||
];
|
|
||||||
})->all();
|
|
||||||
|
|
||||||
return $result;
|
|
||||||
}
|
|
||||||
|
|
||||||
$reflected = new ReflectionClass($middleware);
|
|
||||||
$reflectedMethod = $reflected->getMethod('handle');
|
|
||||||
|
|
||||||
$result = array_merge($result, [
|
|
||||||
'class' => $middleware,
|
|
||||||
'uri' => $reflected->getFileName(),
|
|
||||||
'startLine' => $reflectedMethod->getStartLine(),
|
|
||||||
]);
|
|
||||||
|
|
||||||
$parameters = collect($reflectedMethod->getParameters())
|
|
||||||
->filter(function ($rc) {
|
|
||||||
return $rc->getName() !== 'request' && $rc->getName() !== 'next';
|
|
||||||
})
|
|
||||||
->map(function ($rc) {
|
|
||||||
return $rc->getName() . ($rc->isVariadic() ? '...' : '');
|
|
||||||
});
|
|
||||||
|
|
||||||
if ($parameters->isEmpty()) {
|
|
||||||
return $result;
|
|
||||||
}
|
|
||||||
|
|
||||||
return array_merge($result, [
|
|
||||||
'parameters' => $parameters->implode(','),
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
function vsCodeGetRouterReflection(Illuminate\Routing\Route $route)
|
|
||||||
{
|
|
||||||
if ($route->getActionName() === 'Closure') {
|
|
||||||
return new ReflectionFunction($route->getAction()['uses']);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!str_contains($route->getActionName(), '@')) {
|
|
||||||
return new ReflectionClass($route->getActionName());
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
return new ReflectionMethod($route->getControllerClass(), $route->getActionMethod());
|
|
||||||
} catch (Throwable $e) {
|
|
||||||
$namespace = app(Illuminate\Routing\UrlGenerator::class)->getRootControllerNamespace()
|
|
||||||
?? (app()->getNamespace() . 'Http\Controllers');
|
|
||||||
|
|
||||||
return new ReflectionMethod(
|
|
||||||
$namespace . '\\' . ltrim($route->getControllerClass(), '\\'),
|
|
||||||
$route->getActionMethod(),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return collect(app('router')->getRoutes()->getRoutes())
|
|
||||||
->map(function (Illuminate\Routing\Route $route) {
|
|
||||||
try {
|
|
||||||
$reflection = vsCodeGetRouterReflection($route);
|
|
||||||
} catch (Throwable $e) {
|
|
||||||
$reflection = null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return [
|
|
||||||
'method' => collect($route->methods())->filter(function ($method) {
|
|
||||||
return $method !== 'HEAD';
|
|
||||||
})->implode('|'),
|
|
||||||
'uri' => $route->uri(),
|
|
||||||
'name' => $route->getName(),
|
|
||||||
'action' => $route->getActionName(),
|
|
||||||
'parameters' => $route->parameterNames(),
|
|
||||||
'filename' => $reflection ? $reflection->getFileName() : null,
|
|
||||||
'line' => $reflection ? $reflection->getStartLine() : null,
|
|
||||||
];
|
|
||||||
})
|
|
||||||
;
|
|
||||||
@@ -1,160 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
function vsCodeGetTranslationsFromFile(Symfony\Component\Finder\SplFileInfo $file, $path, $namespace)
|
|
||||||
{
|
|
||||||
if ($file->getExtension() !== 'php') {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
$filePath = $file->getRealPath();
|
|
||||||
|
|
||||||
$relativePath = trim(str_replace($path, '', $file->getPath()), DIRECTORY_SEPARATOR);
|
|
||||||
$lang = explode(DIRECTORY_SEPARATOR, $relativePath)[0] ?? null;
|
|
||||||
|
|
||||||
if (!$lang) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
$keyPath = str_replace($path . DIRECTORY_SEPARATOR . $lang . DIRECTORY_SEPARATOR, '', $filePath);
|
|
||||||
$keyWithSlashes = str_replace('.php', '', $keyPath);
|
|
||||||
$baseKey = str_replace(DIRECTORY_SEPARATOR, '.', $keyWithSlashes);
|
|
||||||
|
|
||||||
if ($namespace) {
|
|
||||||
$baseKey = "{$namespace}::{$baseKey}";
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
$translations = require $filePath;
|
|
||||||
} catch (Throwable $e) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!is_array($translations)) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
$fileLines = Illuminate\Support\Facades\File::lines($filePath);
|
|
||||||
$lines = [];
|
|
||||||
$inComment = false;
|
|
||||||
|
|
||||||
foreach ($fileLines as $index => $line) {
|
|
||||||
$trimmed = trim($line);
|
|
||||||
if (str_starts_with($trimmed, '/*')) {
|
|
||||||
$inComment = true;
|
|
||||||
}
|
|
||||||
if ($inComment) {
|
|
||||||
if (str_ends_with($trimmed, '*/')) {
|
|
||||||
$inComment = false;
|
|
||||||
}
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if (str_starts_with($trimmed, '//')) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
$lines[] = [$index + 1, $trimmed];
|
|
||||||
}
|
|
||||||
|
|
||||||
return [
|
|
||||||
'k' => $baseKey,
|
|
||||||
'la' => $lang,
|
|
||||||
'vs' => collect(Illuminate\Support\Arr::dot($translations))
|
|
||||||
->map(
|
|
||||||
fn ($value, $dotKey) => vsCodeTranslationValue(
|
|
||||||
$dotKey,
|
|
||||||
$value,
|
|
||||||
str_replace(base_path(DIRECTORY_SEPARATOR), '', $filePath),
|
|
||||||
$lines
|
|
||||||
)
|
|
||||||
)
|
|
||||||
->filter(),
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
function vsCodeTranslationValue($key, $value, $file, $lines): ?array
|
|
||||||
{
|
|
||||||
if (is_array($value)) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
$lineNumber = 1;
|
|
||||||
$keys = explode('.', $key);
|
|
||||||
$currentKey = array_shift($keys);
|
|
||||||
|
|
||||||
foreach ($lines as $line) {
|
|
||||||
if (
|
|
||||||
strpos($line[1], '"' . $currentKey . '"') !== false ||
|
|
||||||
strpos($line[1], "'" . $currentKey . "'") !== false
|
|
||||||
) {
|
|
||||||
$lineNumber = $line[0];
|
|
||||||
$currentKey = array_shift($keys);
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($currentKey === null) {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return [
|
|
||||||
'v' => $value,
|
|
||||||
'p' => $file,
|
|
||||||
'li' => $lineNumber,
|
|
||||||
'pa' => preg_match_all("/\:([A-Za-z0-9_]+)/", $value, $matches)
|
|
||||||
? $matches[1]
|
|
||||||
: [],
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
function vscodeCollectTranslations(string $path, ?string $namespace = null)
|
|
||||||
{
|
|
||||||
$realPath = realpath($path);
|
|
||||||
|
|
||||||
if (!is_dir($realPath)) {
|
|
||||||
return collect();
|
|
||||||
}
|
|
||||||
|
|
||||||
return collect(Illuminate\Support\Facades\File::allFiles($realPath))
|
|
||||||
->map(fn ($file) => vsCodeGetTranslationsFromFile($file, $path, $namespace))
|
|
||||||
->filter();
|
|
||||||
}
|
|
||||||
|
|
||||||
$loader = app('translator')->getLoader();
|
|
||||||
$namespaces = $loader->namespaces();
|
|
||||||
|
|
||||||
$reflection = new ReflectionClass($loader);
|
|
||||||
$property = $reflection->hasProperty('paths')
|
|
||||||
? $reflection->getProperty('paths')
|
|
||||||
: $reflection->getProperty('path');
|
|
||||||
|
|
||||||
$paths = Illuminate\Support\Arr::wrap($property->getValue($loader));
|
|
||||||
|
|
||||||
$default = collect($paths)->flatMap(
|
|
||||||
fn ($path) => vscodeCollectTranslations($path)
|
|
||||||
);
|
|
||||||
|
|
||||||
$namespaced = collect($namespaces)->flatMap(
|
|
||||||
fn ($path, $namespace) => vscodeCollectTranslations($path, $namespace)
|
|
||||||
);
|
|
||||||
|
|
||||||
$final = [];
|
|
||||||
|
|
||||||
foreach ($default->merge($namespaced) as $value) {
|
|
||||||
if (!isset($value['vs']) || !is_iterable($value['vs'])) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
foreach ($value['vs'] as $key => $v) {
|
|
||||||
$dotKey = "{$value['k']}.{$key}";
|
|
||||||
|
|
||||||
if (!isset($final[$dotKey])) {
|
|
||||||
$final[$dotKey] = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
$final[$dotKey][$value['la']] = $v;
|
|
||||||
|
|
||||||
if ($value['la'] === Illuminate\Support\Facades\App::currentLocale()) {
|
|
||||||
$final[$dotKey]['default'] = $v;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return collect($final);
|
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
function vsCodeFindBladeFiles($path)
|
|
||||||
{
|
|
||||||
$paths = [];
|
|
||||||
|
|
||||||
if (!is_dir($path)) {
|
|
||||||
return $paths;
|
|
||||||
}
|
|
||||||
|
|
||||||
foreach (
|
|
||||||
Symfony\Component\Finder\Finder::create()
|
|
||||||
->files()
|
|
||||||
->name('*.blade.php')
|
|
||||||
->in($path) as $file
|
|
||||||
) {
|
|
||||||
$paths[] = [
|
|
||||||
'path' => str_replace(base_path(DIRECTORY_SEPARATOR), '', $file->getRealPath()),
|
|
||||||
'isVendor' => str_contains($file->getRealPath(), base_path('vendor')),
|
|
||||||
'key' => Illuminate\Support\Str::of($file->getRealPath())
|
|
||||||
->replace(realpath($path), '')
|
|
||||||
->replace('.blade.php', '')
|
|
||||||
->ltrim(DIRECTORY_SEPARATOR)
|
|
||||||
->replace(DIRECTORY_SEPARATOR, '.'),
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
return $paths;
|
|
||||||
}
|
|
||||||
$paths = collect(
|
|
||||||
app('view')
|
|
||||||
->getFinder()
|
|
||||||
->getPaths()
|
|
||||||
)->flatMap(function ($path) {
|
|
||||||
return vsCodeFindBladeFiles($path);
|
|
||||||
});
|
|
||||||
|
|
||||||
$hints = collect(
|
|
||||||
app('view')
|
|
||||||
->getFinder()
|
|
||||||
->getHints()
|
|
||||||
)->flatMap(function ($paths, $key) {
|
|
||||||
return collect($paths)->flatMap(function ($path) use ($key) {
|
|
||||||
return collect(vsCodeFindBladeFiles($path))->map(function ($value) use (
|
|
||||||
$key
|
|
||||||
) {
|
|
||||||
return array_merge($value, ['key' => "{$key}::{$value['key']}"]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
[$local, $vendor] = $paths
|
|
||||||
->merge($hints)
|
|
||||||
->values()
|
|
||||||
->partition(function ($v) {
|
|
||||||
return !$v['isVendor'];
|
|
||||||
});
|
|
||||||
|
|
||||||
return $local
|
|
||||||
->sortBy('key', SORT_NATURAL)
|
|
||||||
->merge($vendor->sortBy('key', SORT_NATURAL));
|
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.0/phpunit.xsd"
|
||||||
|
backupGlobals="false"
|
||||||
|
backupStaticAttributes="false"
|
||||||
|
bootstrap="vendor/autoload.php"
|
||||||
|
colors="true"
|
||||||
|
convertErrorsToExceptions="true"
|
||||||
|
convertNoticesToExceptions="true"
|
||||||
|
convertWarningsToExceptions="true"
|
||||||
|
processIsolation="false"
|
||||||
|
stopOnFailure="false">
|
||||||
|
<testsuites>
|
||||||
|
<testsuite name="Package Test Suite">
|
||||||
|
<directory suffix=".php">./tests/</directory>
|
||||||
|
</testsuite>
|
||||||
|
</testsuites>
|
||||||
|
</phpunit>
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<phpunit
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
||||||
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
|
|
||||||
cacheDirectory=".phpunit.result.cache"
|
|
||||||
>
|
|
||||||
<testsuites>
|
|
||||||
<testsuite name="Unit Tests">
|
|
||||||
<directory>tests</directory>
|
|
||||||
</testsuite>
|
|
||||||
</testsuites>
|
|
||||||
<source>
|
|
||||||
<include>
|
|
||||||
<directory suffix=".php">src/</directory>
|
|
||||||
</include>
|
|
||||||
</source>
|
|
||||||
</phpunit>
|
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"providers": [
|
||||||
|
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<files psalm-version="5.4.0@62db5d4f6a7ae0a20f7cc5a4952d730272fc0863">
|
|
||||||
<file src="src/Factories.php">
|
|
||||||
<UndefinedClass occurrences="2">
|
|
||||||
<code>Factory</code>
|
|
||||||
<code>Factory</code>
|
|
||||||
</UndefinedClass>
|
|
||||||
</file>
|
|
||||||
<file src="src/Generator.php">
|
|
||||||
<UndefinedClass occurrences="6">
|
|
||||||
<code>\Auth</code>
|
|
||||||
<code>\Cache</code>
|
|
||||||
<code>\Cache</code>
|
|
||||||
<code>\DB</code>
|
|
||||||
<code>\Queue</code>
|
|
||||||
<code>\Storage</code>
|
|
||||||
</UndefinedClass>
|
|
||||||
</file>
|
|
||||||
<file src="src/Console/ModelsCommand.php">
|
|
||||||
<UndefinedClass occurrences="1">
|
|
||||||
<code>\UnitEnum</code>
|
|
||||||
</UndefinedClass>
|
|
||||||
</file>
|
|
||||||
</files>
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<psalm
|
|
||||||
errorLevel="7"
|
|
||||||
resolveFromConfigFile="true"
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
||||||
xmlns="https://getpsalm.org/schema/config"
|
|
||||||
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
|
|
||||||
errorBaseline="psalm-baseline.xml"
|
|
||||||
>
|
|
||||||
<projectFiles>
|
|
||||||
<directory name="src" />
|
|
||||||
<ignoreFiles>
|
|
||||||
<directory name="vendor" />
|
|
||||||
</ignoreFiles>
|
|
||||||
</projectFiles>
|
|
||||||
</psalm>
|
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
## Laravel IDE Helper Generator
|
||||||
|
[](https://packagist.org/packages/barryvdh/laravel-ide-helper) [](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||||
|
|
||||||
|
### For Laravel 5, check the [2.0 branch](https://github.com/barryvdh/laravel-ide-helper)
|
||||||
|
|
||||||
|
### Complete phpDocs, directly from the source
|
||||||
|
|
||||||
|
_Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||||
|
|
||||||
|
This packages generates a file that your IDE can understand, so it can provide accurate autocompletion. Generation is done, based on the files in your project, so they are always up-to-date.
|
||||||
|
If you don't want to generate it, you can add a pre-generated file to the root folder of your laravel project. (But this isn't as up-to-date as self generated files)
|
||||||
|
|
||||||
|
* Generated version: https://gist.github.com/barryvdh/5227822
|
||||||
|
|
||||||
|
Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
|
||||||
|
|
||||||
|
### New: PhpStorm Meta for Container instances
|
||||||
|
|
||||||
|
It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return ann `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan ide-helper:meta
|
||||||
|
```
|
||||||
|
```php
|
||||||
|
app('events')->fire();
|
||||||
|
\App::make('events')->fire();
|
||||||
|
|
||||||
|
/** @var \Illuminate\Foundation\Application $app */
|
||||||
|
$app->make('events')->fire();
|
||||||
|
```
|
||||||
|
|
||||||
|
Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
|
||||||
|
|
||||||
|
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
||||||
|
|
||||||
|
### Automatic phpDoc generation for Laravel Facades
|
||||||
|
|
||||||
|
Require this package with composer using the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer require barryvdh/laravel-ide-helper ~1.11
|
||||||
|
```
|
||||||
|
|
||||||
|
After updating composer, add the ServiceProvider to the providers array in `app/config/app.php`
|
||||||
|
|
||||||
|
```php
|
||||||
|
'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider',
|
||||||
|
```
|
||||||
|
|
||||||
|
You can now re-generate the docs yourself (for future updates) in artisan
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan ide-helper:generate
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: bootstrap/compiled.php has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after..)
|
||||||
|
|
||||||
|
You can configure your composer.json to do this after each commit:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"scripts":{
|
||||||
|
"post-update-cmd":[
|
||||||
|
"php artisan clear-compiled",
|
||||||
|
"php artisan ide-helper:generate",
|
||||||
|
"php artisan optimize"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also publish the config-file to change implementations (ie. interface to specific class) or set defaults for --helpers or --sublime.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan config:publish barryvdh/laravel-ide-helper
|
||||||
|
```
|
||||||
|
|
||||||
|
The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
|
||||||
|
|
||||||
|
Some classes need a working database connection. If you do not have a working default connection, some facades will not be included.
|
||||||
|
You can use a in-memory sqlite driver, using the -M option.
|
||||||
|
|
||||||
|
You can choose to include helper files. This is not enabled by default, but you can override this with the --helpers (-H) option.
|
||||||
|
The Illuminate/Support/helpers.php is already set-up, but you can add/remove your own files in the config file.
|
||||||
|
|
||||||
|
### Automatic phpDocs for Models
|
||||||
|
|
||||||
|
> **Note:** Since v1.10 you need to require `doctrine/dbal: ~2.3` in your own composer.json.
|
||||||
|
|
||||||
|
If you don't want to write your properties yourself, you can use the command `ide-helper:models` to generate
|
||||||
|
phpDocs, based on table columns, relations and getters/setters. You can write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or write to a separate file (\_ide\_helper\_models.php) (You can force No with `--nowrite (-N)`).
|
||||||
|
Please make sure to backup your models, before writing the info.
|
||||||
|
It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found.
|
||||||
|
With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan ide-helper:models Post
|
||||||
|
```
|
||||||
|
```php
|
||||||
|
/**
|
||||||
|
* An Eloquent Model: 'Post'
|
||||||
|
*
|
||||||
|
* @property integer $id
|
||||||
|
* @property integer $author_id
|
||||||
|
* @property string $title
|
||||||
|
* @property string $text
|
||||||
|
* @property \Carbon\Carbon $created_at
|
||||||
|
* @property \Carbon\Carbon $updated_at
|
||||||
|
* @property-read \User $author
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
|
||||||
|
*/
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan ide-helper:models Post User
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also scan a different directory, using the --dir option (relative from the base path):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan ide-helper:models --dir="app/workbench/name/package/models" --dir="app/src/Model"
|
||||||
|
```
|
||||||
|
|
||||||
|
You can publish the config file (`php artisan config:publish barryvdh/laravel-ide-helper`) and set the default directories.
|
||||||
|
|
||||||
|
Models can be ignored using the --ignore (-I) option
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan ide-helper:models --ignore="Post,User"
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
|
||||||
|
|
||||||
|
### License
|
||||||
|
|
||||||
|
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
||||||
@@ -1,130 +0,0 @@
|
|||||||
<?= '<?php' ?>
|
|
||||||
<?php
|
|
||||||
/**
|
|
||||||
* @var Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_alias_ns
|
|
||||||
* @var Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_extends_ns
|
|
||||||
* @var bool $include_fluent
|
|
||||||
* @var string $helpers
|
|
||||||
*/
|
|
||||||
?>
|
|
||||||
|
|
||||||
/* @noinspection ALL */
|
|
||||||
// @formatter:off
|
|
||||||
// phpcs:ignoreFile
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A helper file for Laravel, to provide autocomplete information to your IDE
|
|
||||||
* Generated for Laravel <?= app()->version() ?>.
|
|
||||||
*
|
|
||||||
* This file should not be included in your code, only analyzed by your IDE!
|
|
||||||
*
|
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
|
||||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
|
||||||
*/
|
|
||||||
<?php
|
|
||||||
$s1 = ' ';
|
|
||||||
$s2 = $s1 . $s1;
|
|
||||||
$s3 = $s1 . $s2;
|
|
||||||
?>
|
|
||||||
<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
|
|
||||||
namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
|
|
||||||
<?php foreach ($aliases as $alias) : ?>
|
|
||||||
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?><?php if ($alias->shouldExtendParentClass()): ?> extends <?= $alias->getParentClass() ?><?php endif; ?> {
|
|
||||||
<?php foreach ($alias->getMethods() as $method) : ?>
|
|
||||||
<?= trim($method->getDocComment($s2)) . "\n{$s2}" ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
|
||||||
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
|
||||||
<?= "\n" . $s3?>//Method inherited from <?= $method->getDeclaringClass() ?>
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
<?php if ($method->isInstanceCall()) : ?>
|
|
||||||
<?= $s3 ?>/** @var <?=$method->getRoot()?> $instance */
|
|
||||||
<?php endif?>
|
|
||||||
<?= $s3 . ($method->shouldReturn() ? 'return ' : '') ?><?= $method->getRootMethodCall() ?>;
|
|
||||||
}
|
|
||||||
|
|
||||||
<?php endforeach; ?>
|
|
||||||
}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
}
|
|
||||||
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
<?php foreach ($namespaces_by_alias_ns as $namespace => $aliases) : ?>
|
|
||||||
namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
|
|
||||||
<?php foreach ($aliases as $alias) : ?>
|
|
||||||
<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
|
|
||||||
<?= "\n" . $alias->getPhpDocTemplates($s1) . "\n" ?>
|
|
||||||
<?php endif?>
|
|
||||||
<?= $s1 . $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
|
|
||||||
<?php foreach ($alias->getMethods() as $method) : ?>
|
|
||||||
<?= $s2 . trim($method->getDocComment($s2)) . "\n" ?>
|
|
||||||
<?= $s2 ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
|
||||||
<?= $s2?>{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
|
||||||
<?= $s2 ?>//Method inherited from <?= $method->getDeclaringClass() ?>
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
<?php if ($method->isInstanceCall()) : ?>
|
|
||||||
<?= $s3 ?>/** @var <?=$method->getRoot()?> $instance */
|
|
||||||
<?php endif?>
|
|
||||||
<?= $s3 . ($method->shouldReturn() ? 'return ' : '') ?><?= $method->getRootMethodCall() ?>;
|
|
||||||
<?= $s2 ?>}
|
|
||||||
|
|
||||||
<?php endforeach; ?>
|
|
||||||
<?php endif; ?>}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
}
|
|
||||||
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
<?php foreach ($real_time_facades as $name): ?>
|
|
||||||
<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
|
|
||||||
namespace <?php echo implode('\\', $nested); ?> {
|
|
||||||
/**
|
|
||||||
* @mixin <?= str_replace('Facades', '', $name) ?>
|
|
||||||
*/
|
|
||||||
class <?= class_basename($name) ?> extends <?= str_replace('Facades', '', $name) ?> {}
|
|
||||||
}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
<?php if ($helpers) : ?>
|
|
||||||
namespace {
|
|
||||||
<?= $helpers ?>
|
|
||||||
}
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
<?php if ($include_fluent) : ?>
|
|
||||||
namespace Illuminate\Support {
|
|
||||||
/**
|
|
||||||
* Methods commonly used in migrations
|
|
||||||
*
|
|
||||||
* @method Fluent after(string $column) Add the after modifier
|
|
||||||
* @method Fluent charset(string $charset) Add the character set modifier
|
|
||||||
* @method Fluent collation(string $collation) Add the collation modifier
|
|
||||||
* @method Fluent comment(string $comment) Add comment
|
|
||||||
* @method Fluent default($value) Add the default modifier
|
|
||||||
* @method Fluent first() Select first row
|
|
||||||
* @method Fluent index(string $name = null) Add the in dex clause
|
|
||||||
* @method Fluent on(string $table) `on` of a foreign key
|
|
||||||
* @method Fluent onDelete(string $action) `on delete` of a foreign key
|
|
||||||
* @method Fluent onUpdate(string $action) `on update` of a foreign key
|
|
||||||
* @method Fluent primary() Add the primary key modifier
|
|
||||||
* @method Fluent references(string $column) `references` of a foreign key
|
|
||||||
* @method Fluent nullable(bool $value = true) Add the nullable modifier
|
|
||||||
* @method Fluent unique(string $name = null) Add unique index clause
|
|
||||||
* @method Fluent unsigned() Add the unsigned modifier
|
|
||||||
* @method Fluent useCurrent() Add the default timestamp value
|
|
||||||
* @method Fluent change() Add the change modifier
|
|
||||||
*/
|
|
||||||
class Fluent {}
|
|
||||||
}
|
|
||||||
<?php endif ?>
|
|
||||||
|
|
||||||
<?php foreach ($factories as $factory) : ?>
|
|
||||||
namespace <?=$factory->getNamespaceName()?> {
|
|
||||||
/**
|
|
||||||
* @method \Illuminate\Database\Eloquent\Collection|<?=$factory->getShortName()?>[]|<?=$factory->getShortName()?> create($attributes = [])
|
|
||||||
* @method \Illuminate\Database\Eloquent\Collection|<?=$factory->getShortName()?>[]|<?=$factory->getShortName()?> make($attributes = [])
|
|
||||||
*/
|
|
||||||
class <?=$factory->getShortName()?>FactoryBuilder extends \Illuminate\Database\Eloquent\FactoryBuilder {}
|
|
||||||
}
|
|
||||||
<?php endforeach; ?>
|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
<?= '<?php' ?>
|
|
||||||
|
|
||||||
/* @noinspection ALL */
|
|
||||||
// @formatter:off
|
|
||||||
// phpcs:ignoreFile
|
|
||||||
|
|
||||||
namespace PHPSTORM_META {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* PhpStorm Meta file, to provide autocomplete information for PhpStorm
|
|
||||||
*
|
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
|
||||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
|
||||||
*/
|
|
||||||
<?php foreach ($methods as $method) : ?>
|
|
||||||
override(<?= $method ?>, map([
|
|
||||||
'' => '@',
|
|
||||||
<?php foreach ($bindings as $abstract => $class) : ?>
|
|
||||||
'<?= $abstract ?>' => \<?= $class ?>::class,
|
|
||||||
<?php endforeach; ?>
|
|
||||||
]));
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
<?php foreach ($userMethods as $method) : ?>
|
|
||||||
override(<?= $method ?>, map([
|
|
||||||
'' => \<?= $userModel ?>::class,
|
|
||||||
]));
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
<?php foreach ($configMethods as $method) : ?>
|
|
||||||
override(<?= $method ?>, map([
|
|
||||||
<?php foreach ($configValues as $name => $value) : ?>
|
|
||||||
'<?= $name ?>' => '<?= $value ?>',
|
|
||||||
<?php endforeach; ?>
|
|
||||||
]));
|
|
||||||
<?php endforeach; ?>
|
|
||||||
|
|
||||||
<?php if (count($factories)) : ?>
|
|
||||||
override(\factory(0), map([
|
|
||||||
'' => '@FactoryBuilder',
|
|
||||||
<?php foreach ($factories as $factory) : ?>
|
|
||||||
'<?= $factory->getName() ?>' => \<?= $factory->getName() ?>FactoryBuilder::class,
|
|
||||||
<?php endforeach; ?>
|
|
||||||
]));
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::mock(0), map(["" => "@&\Mockery\MockInterface"]));
|
|
||||||
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::partialMock(0), map(["" => "@&\Mockery\MockInterface"]));
|
|
||||||
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::instance(0), type(1));
|
|
||||||
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::spy(0), map(["" => "@&\Mockery\MockInterface"]));
|
|
||||||
override(\Illuminate\Support\Arr::add(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::except(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::first(0), elementType(0));
|
|
||||||
override(\Illuminate\Support\Arr::last(0), elementType(0));
|
|
||||||
override(\Illuminate\Support\Arr::get(0), elementType(0));
|
|
||||||
override(\Illuminate\Support\Arr::only(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::prepend(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::pull(0), elementType(0));
|
|
||||||
override(\Illuminate\Support\Arr::set(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::shuffle(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::sort(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::sortRecursive(0), type(0));
|
|
||||||
override(\Illuminate\Support\Arr::where(0), type(0));
|
|
||||||
override(\array_add(0), type(0));
|
|
||||||
override(\array_except(0), type(0));
|
|
||||||
override(\array_first(0), elementType(0));
|
|
||||||
override(\array_last(0), elementType(0));
|
|
||||||
override(\array_get(0), elementType(0));
|
|
||||||
override(\array_only(0), type(0));
|
|
||||||
override(\array_prepend(0), type(0));
|
|
||||||
override(\array_pull(0), elementType(0));
|
|
||||||
override(\array_set(0), type(0));
|
|
||||||
override(\array_sort(0), type(0));
|
|
||||||
override(\array_sort_recursive(0), type(0));
|
|
||||||
override(\array_where(0), type(0));
|
|
||||||
override(\head(0), elementType(0));
|
|
||||||
override(\last(0), elementType(0));
|
|
||||||
override(\with(0), type(0));
|
|
||||||
override(\tap(0), type(0));
|
|
||||||
override(\optional(0), type(0));
|
|
||||||
|
|
||||||
<?php if (isset($expectedArgumentSets)): ?>
|
|
||||||
<?php foreach ($expectedArgumentSets as $name => $argumentsList) : ?>
|
|
||||||
registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if ($i % 5 == 0) {
|
|
||||||
echo "\n";
|
|
||||||
} ?><?= var_export($arg, true); ?>,<?php endforeach; ?>);
|
|
||||||
<?php endforeach; ?>
|
|
||||||
<?php endif ?>
|
|
||||||
|
|
||||||
<?php if (isset($expectedArguments)) : ?>
|
|
||||||
<?php foreach ($expectedArguments as $arguments) : ?>
|
|
||||||
<?php
|
|
||||||
$classes = isset($arguments['class']) ? (array) $arguments['class'] : [null];
|
|
||||||
$index = $arguments['index'] ?? 0;
|
|
||||||
$argumentSet = $arguments['argumentSet'];
|
|
||||||
$functions = [];
|
|
||||||
foreach ($classes as $class) {
|
|
||||||
foreach ((array) $arguments['method'] as $method) {
|
|
||||||
$functions[] = '\\' . ($class ? ltrim($class, '\\') . '::' : '') . $method . '()';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
?>
|
|
||||||
<?php foreach ($functions as $function) : ?>
|
|
||||||
expectedArguments(<?= $function ?>, <?= $index ?>, argumentsSet('<?= $argumentSet ?>'));
|
|
||||||
<?php endforeach; ?>
|
|
||||||
<?php endforeach; ?>
|
|
||||||
<?php endif; ?>
|
|
||||||
|
|
||||||
}
|
|
||||||
+34
-361
@@ -1,5 +1,4 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
@@ -11,63 +10,33 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
|
||||||
use Barryvdh\Reflection\DocBlock\ContextFactory;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\TemplateTag;
|
|
||||||
use Closure;
|
|
||||||
use Illuminate\Config\Repository as ConfigRepository;
|
|
||||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
|
||||||
use Illuminate\Database\Query\Builder as QueryBuilder;
|
|
||||||
use Illuminate\Support\Facades\Facade;
|
|
||||||
use Illuminate\Support\Traits\Macroable;
|
|
||||||
use ReflectionClass;
|
|
||||||
use Throwable;
|
|
||||||
|
|
||||||
class Alias
|
class Alias
|
||||||
{
|
{
|
||||||
protected $alias;
|
protected $alias;
|
||||||
/** @psalm-var class-string $facade */
|
|
||||||
protected $facade;
|
protected $facade;
|
||||||
protected $extends = null;
|
protected $extends = null;
|
||||||
protected $extendsClass = null;
|
|
||||||
protected $extendsNamespace = null;
|
|
||||||
protected $classType = 'class';
|
protected $classType = 'class';
|
||||||
protected $short;
|
protected $short;
|
||||||
protected $namespace = '__root';
|
protected $namespace = '__root';
|
||||||
protected $parentClass;
|
|
||||||
protected $root = null;
|
protected $root = null;
|
||||||
protected $classes = [];
|
protected $classes = array();
|
||||||
protected $methods = [];
|
protected $methods = array();
|
||||||
protected $usedMethods = [];
|
protected $usedMethods = array();
|
||||||
protected $valid = false;
|
protected $valid = false;
|
||||||
protected $magicMethods = [];
|
protected $magicMethods = array();
|
||||||
protected $interfaces = [];
|
protected $interfaces = array();
|
||||||
protected $phpdoc = null;
|
|
||||||
protected $classAliases = [];
|
|
||||||
|
|
||||||
/** @var ConfigRepository */
|
|
||||||
protected $config;
|
|
||||||
|
|
||||||
/** @var string[] */
|
|
||||||
protected $templateNames;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param ConfigRepository $config
|
* @param string $alias
|
||||||
* @param string $alias
|
* @param string $facade
|
||||||
* @psalm-param class-string $facade
|
* @param array $magicMethods
|
||||||
* @param string $facade
|
* @param array $interfaces
|
||||||
* @param array $magicMethods
|
|
||||||
* @param array $interfaces
|
|
||||||
*/
|
*/
|
||||||
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [])
|
public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array())
|
||||||
{
|
{
|
||||||
$this->alias = $alias;
|
$this->alias = $alias;
|
||||||
$this->magicMethods = $magicMethods;
|
$this->magicMethods = $magicMethods;
|
||||||
$this->interfaces = $interfaces;
|
$this->interfaces = $interfaces;
|
||||||
$this->config = $config;
|
|
||||||
|
|
||||||
// Make the class absolute
|
// Make the class absolute
|
||||||
$facade = '\\' . ltrim($facade, '\\');
|
$facade = '\\' . ltrim($facade, '\\');
|
||||||
@@ -75,33 +44,18 @@ class Alias
|
|||||||
|
|
||||||
$this->detectRoot();
|
$this->detectRoot();
|
||||||
|
|
||||||
if (!$this->root || $this->isTrait()) {
|
if ((!$this->isTrait() && $this->root)) {
|
||||||
|
$this->valid = true;
|
||||||
|
} else {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->valid = true;
|
|
||||||
|
|
||||||
$this->addClass($this->root);
|
$this->addClass($this->root);
|
||||||
$this->detectFake();
|
|
||||||
$this->detectNamespace();
|
$this->detectNamespace();
|
||||||
$this->detectClassType();
|
$this->detectClassType();
|
||||||
$this->detectExtendsNamespace();
|
|
||||||
$this->detectParentClass();
|
|
||||||
|
|
||||||
if (!empty($this->namespace)) {
|
|
||||||
try {
|
|
||||||
$this->classAliases = (new ContextFactory())->createFromReflector(new ReflectionClass($this->root))->getNamespaceAliases();
|
|
||||||
} catch (Throwable $e) {
|
|
||||||
$this->classAliases = [];
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
//Create a DocBlock and serializer instance
|
|
||||||
$this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace, $this->classAliases));
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
||||||
$this->usedMethods = ['decrement', 'increment'];
|
$this->usedMethods = array('decrement', 'increment');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -117,7 +71,7 @@ class Alias
|
|||||||
if (class_exists($class) || interface_exists($class)) {
|
if (class_exists($class) || interface_exists($class)) {
|
||||||
$this->classes[] = $class;
|
$this->classes[] = $class;
|
||||||
} else {
|
} else {
|
||||||
echo "Class not exists: $class\r\n";
|
$this->error('Class not exists: ' . $class);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -132,11 +86,11 @@ class Alias
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the classtype, 'interface' or 'class'
|
* Get the classType, 'interface' or 'class'
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getClasstype()
|
public function getClassType()
|
||||||
{
|
{
|
||||||
return $this->classType;
|
return $this->classType;
|
||||||
}
|
}
|
||||||
@@ -151,45 +105,6 @@ class Alias
|
|||||||
return $this->extends;
|
return $this->extends;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the class short name which this alias extends
|
|
||||||
*
|
|
||||||
* @return null|string
|
|
||||||
*/
|
|
||||||
public function getExtendsClass()
|
|
||||||
{
|
|
||||||
return $this->extendsClass;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the namespace of the class which this alias extends
|
|
||||||
*
|
|
||||||
* @return null|string
|
|
||||||
*/
|
|
||||||
public function getExtendsNamespace()
|
|
||||||
{
|
|
||||||
return $this->extendsNamespace;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the parent class of the class which this alias extends
|
|
||||||
*
|
|
||||||
* @return null|string
|
|
||||||
*/
|
|
||||||
public function getParentClass()
|
|
||||||
{
|
|
||||||
return $this->parentClass;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if this class should extend the parent class
|
|
||||||
*/
|
|
||||||
public function shouldExtendParentClass()
|
|
||||||
{
|
|
||||||
return $this->parentClass
|
|
||||||
&& $this->getExtendsNamespace() !== '\\Illuminate\\Support\\Facades';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the Alias by which this class is called
|
* Get the Alias by which this class is called
|
||||||
*
|
*
|
||||||
@@ -202,11 +117,14 @@ class Alias
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the short name (without namespace)
|
* Return the short name (without namespace)
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getShortName()
|
public function getShortName()
|
||||||
{
|
{
|
||||||
return $this->short;
|
return $this->short;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the namespace from the alias
|
* Get the namespace from the alias
|
||||||
*
|
*
|
||||||
@@ -224,45 +142,11 @@ class Alias
|
|||||||
*/
|
*/
|
||||||
public function getMethods()
|
public function getMethods()
|
||||||
{
|
{
|
||||||
if (count($this->methods) > 0) {
|
|
||||||
return $this->methods;
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->addMagicMethods();
|
$this->addMagicMethods();
|
||||||
$this->detectMethods();
|
$this->detectMethods();
|
||||||
return $this->methods;
|
return $this->methods;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Detect class returned by ::fake()
|
|
||||||
*/
|
|
||||||
protected function detectFake()
|
|
||||||
{
|
|
||||||
$facade = $this->facade;
|
|
||||||
|
|
||||||
if (!is_subclass_of($facade, Facade::class)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!method_exists($facade, 'fake')) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$real = $facade::getFacadeRoot();
|
|
||||||
|
|
||||||
try {
|
|
||||||
$facade::fake();
|
|
||||||
$fake = $facade::getFacadeRoot();
|
|
||||||
if ($fake !== $real) {
|
|
||||||
$this->addClass(get_class($fake));
|
|
||||||
}
|
|
||||||
} catch (Throwable $throwable) {
|
|
||||||
// Ignore error
|
|
||||||
} finally {
|
|
||||||
$facade::swap($real);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Detect the namespace
|
* Detect the namespace
|
||||||
*/
|
*/
|
||||||
@@ -277,30 +161,6 @@ class Alias
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Detect the extends namespace
|
|
||||||
*/
|
|
||||||
protected function detectExtendsNamespace()
|
|
||||||
{
|
|
||||||
if (strpos($this->extends, '\\') !== false) {
|
|
||||||
$nsParts = explode('\\', $this->extends);
|
|
||||||
$this->extendsClass = array_pop($nsParts);
|
|
||||||
$this->extendsNamespace = implode('\\', $nsParts);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Detect the parent class
|
|
||||||
*/
|
|
||||||
protected function detectParentClass()
|
|
||||||
{
|
|
||||||
$reflection = new ReflectionClass($this->root);
|
|
||||||
|
|
||||||
$parentClass = $reflection->getParentClass();
|
|
||||||
|
|
||||||
$this->parentClass = $parentClass ? '\\' . $parentClass->getName() : null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Detect the class type
|
* Detect the class type
|
||||||
*/
|
*/
|
||||||
@@ -345,11 +205,9 @@ class Alias
|
|||||||
//When the database connection is not set, some classes will be skipped
|
//When the database connection is not set, some classes will be skipped
|
||||||
} catch (\PDOException $e) {
|
} catch (\PDOException $e) {
|
||||||
$this->error(
|
$this->error(
|
||||||
'PDOException: ' . $e->getMessage() .
|
'PDOException: ' . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M). Skipping $facade."
|
||||||
"\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
|
|
||||||
" Skipping $facade."
|
|
||||||
);
|
);
|
||||||
} catch (Throwable $e) {
|
} catch (\Exception $e) {
|
||||||
$this->error('Exception: ' . $e->getMessage() . "\nSkipping $facade.");
|
$this->error('Exception: ' . $e->getMessage() . "\nSkipping $facade.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -362,7 +220,10 @@ class Alias
|
|||||||
protected function isTrait()
|
protected function isTrait()
|
||||||
{
|
{
|
||||||
// Check if the facade is not a Trait
|
// Check if the facade is not a Trait
|
||||||
return trait_exists($this->facade);
|
if (function_exists('trait_exists') && trait_exists($this->facade)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -371,25 +232,16 @@ class Alias
|
|||||||
protected function addMagicMethods()
|
protected function addMagicMethods()
|
||||||
{
|
{
|
||||||
foreach ($this->magicMethods as $magic => $real) {
|
foreach ($this->magicMethods as $magic => $real) {
|
||||||
[$className, $name] = explode('::', $real);
|
list($className, $name) = explode('::', $real);
|
||||||
if ((!class_exists($className) && !interface_exists($className)) || !method_exists($className, $name)) {
|
if (!class_exists($className) && !interface_exists($className)) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
$method = new \ReflectionMethod($className, $name);
|
$method = new \ReflectionMethod($className, $name);
|
||||||
$class = new ReflectionClass($className);
|
$class = new \ReflectionClass($className);
|
||||||
|
|
||||||
if (!in_array($magic, $this->usedMethods)) {
|
if (!in_array($method->name, $this->usedMethods)) {
|
||||||
if ($class !== $this->root) {
|
if ($class !== $this->root) {
|
||||||
$this->methods[] = new Method(
|
$this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
|
||||||
$method,
|
|
||||||
$this->alias,
|
|
||||||
$class,
|
|
||||||
$magic,
|
|
||||||
$this->interfaces,
|
|
||||||
$this->classAliases,
|
|
||||||
$this->getReturnTypeNormalizers($class),
|
|
||||||
$this->getTemplateNames()
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $magic;
|
$this->usedMethods[] = $magic;
|
||||||
}
|
}
|
||||||
@@ -404,7 +256,7 @@ class Alias
|
|||||||
protected function detectMethods()
|
protected function detectMethods()
|
||||||
{
|
{
|
||||||
foreach ($this->classes as $class) {
|
foreach ($this->classes as $class) {
|
||||||
$reflection = new ReflectionClass($class);
|
$reflection = new \ReflectionClass($class);
|
||||||
|
|
||||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||||
if ($methods) {
|
if ($methods) {
|
||||||
@@ -413,198 +265,19 @@ class Alias
|
|||||||
// Only add the methods to the output when the root is not the same as the class.
|
// Only add the methods to the output when the root is not the same as the class.
|
||||||
// And don't add the __*() methods
|
// And don't add the __*() methods
|
||||||
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
|
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
|
||||||
$this->methods[] = new Method(
|
$this->methods[] = new Method($method, $this->alias, $reflection, $method->name, $this->interfaces);
|
||||||
$method,
|
|
||||||
$this->alias,
|
|
||||||
$reflection,
|
|
||||||
$method->name,
|
|
||||||
$this->interfaces,
|
|
||||||
$this->classAliases,
|
|
||||||
$this->getReturnTypeNormalizers($reflection),
|
|
||||||
$this->getTemplateNames(),
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $method->name;
|
$this->usedMethods[] = $method->name;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check if the class is macroable
|
|
||||||
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
|
|
||||||
if ($class === EloquentBuilder::class || in_array(Macroable::class, $reflection->getTraitNames())) {
|
|
||||||
$properties = $reflection->getStaticProperties();
|
|
||||||
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
|
||||||
foreach ($macros as $macro_name => $macro_func) {
|
|
||||||
if (!in_array($macro_name, $this->usedMethods)) {
|
|
||||||
try {
|
|
||||||
$method = $this->getMacroFunction($macro_func);
|
|
||||||
} catch (Throwable $e) {
|
|
||||||
// Invalid method, skip
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
// Add macros
|
|
||||||
$this->methods[] = new Macro(
|
|
||||||
$method,
|
|
||||||
$this->alias,
|
|
||||||
$reflection,
|
|
||||||
$macro_name,
|
|
||||||
$this->interfaces,
|
|
||||||
$this->classAliases,
|
|
||||||
$this->getReturnTypeNormalizers($reflection)
|
|
||||||
);
|
|
||||||
$this->usedMethods[] = $macro_name;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param ReflectionClass $class
|
|
||||||
* @return array<string, string>
|
|
||||||
*/
|
|
||||||
protected function getReturnTypeNormalizers($class)
|
|
||||||
{
|
|
||||||
if ($this->alias === 'Eloquent' && in_array($class->getName(), [EloquentBuilder::class, QueryBuilder::class])) {
|
|
||||||
return [
|
|
||||||
'$this' => '\\' . EloquentBuilder::class . ($this->config->get('ide-helper.use_generics_annotations') ? '<static>' : '|static'),
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param $macro_func
|
|
||||||
*
|
|
||||||
* @return \ReflectionFunctionAbstract
|
|
||||||
* @throws \ReflectionException
|
|
||||||
*/
|
|
||||||
protected function getMacroFunction($macro_func)
|
|
||||||
{
|
|
||||||
if (is_array($macro_func) && is_callable($macro_func)) {
|
|
||||||
return new \ReflectionMethod($macro_func[0], $macro_func[1]);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (is_object($macro_func) && is_callable($macro_func) && !$macro_func instanceof Closure) {
|
|
||||||
return new \ReflectionMethod($macro_func, '__invoke');
|
|
||||||
}
|
|
||||||
|
|
||||||
return new \ReflectionFunction($macro_func);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Get the docblock for this alias
|
|
||||||
*
|
|
||||||
* @param string $prefix
|
|
||||||
* @return mixed
|
|
||||||
*/
|
|
||||||
public function getDocComment($prefix = "\t\t")
|
|
||||||
{
|
|
||||||
$serializer = new DocBlockSerializer(1, $prefix);
|
|
||||||
|
|
||||||
if (!$this->phpdoc) {
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($this->config->get('ide-helper.include_class_docblocks')) {
|
|
||||||
// if a class doesn't expose any DocBlock tags
|
|
||||||
// we can perform reflection on the class and
|
|
||||||
// add in the original class DocBlock
|
|
||||||
if (count($this->phpdoc->getTags()) === 0) {
|
|
||||||
$class = new ReflectionClass($this->root);
|
|
||||||
$this->phpdoc = new DocBlock($class->getDocComment());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->removeDuplicateMethodsFromPhpDoc();
|
|
||||||
return $serializer->getDocComment($this->phpdoc);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param $prefix
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getPhpDocTemplates($prefix = "\t\t")
|
|
||||||
{
|
|
||||||
$templateDoc = new DocBlock('');
|
|
||||||
$serializer = new DocBlockSerializer(1, $prefix);
|
|
||||||
|
|
||||||
foreach ($this->getTemplateNames() as $templateName) {
|
|
||||||
$template = new TemplateTag('template', $templateName);
|
|
||||||
$template->setBound('static');
|
|
||||||
$template->setDocBlock($templateDoc);
|
|
||||||
$templateDoc->appendTag($template);
|
|
||||||
}
|
|
||||||
|
|
||||||
return $serializer->getDocComment($templateDoc);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return string[]
|
|
||||||
*/
|
|
||||||
public function getTemplateNames()
|
|
||||||
{
|
|
||||||
if (!isset($this->templateNames)) {
|
|
||||||
$this->detectTemplateNames();
|
|
||||||
}
|
|
||||||
return $this->templateNames;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return void
|
|
||||||
* @throws \ReflectionException
|
|
||||||
*/
|
|
||||||
protected function detectTemplateNames()
|
|
||||||
{
|
|
||||||
$templateNames = [];
|
|
||||||
foreach ($this->classes as $class) {
|
|
||||||
$reflection = new ReflectionClass($class);
|
|
||||||
$traits = collect($reflection->getTraitNames());
|
|
||||||
|
|
||||||
$phpdoc = new DocBlock($reflection);
|
|
||||||
$templates = $phpdoc->getTagsByName('template');
|
|
||||||
/** @var TemplateTag $template */
|
|
||||||
foreach ($templates as $template) {
|
|
||||||
$templateNames[] = $template->getTemplateName();
|
|
||||||
}
|
|
||||||
|
|
||||||
foreach ($traits as $trait) {
|
|
||||||
$phpdoc = new DocBlock(new ReflectionClass($trait));
|
|
||||||
$templates = $phpdoc->getTagsByName('template');
|
|
||||||
|
|
||||||
/** @var TemplateTag $template */
|
|
||||||
foreach ($templates as $template) {
|
|
||||||
$templateNames[] = $template->getTemplateName();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
$this->templateNames = $templateNames;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Removes method tags from the doc comment that already appear as functions inside the class.
|
|
||||||
* This prevents duplicate function errors in the IDE.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
protected function removeDuplicateMethodsFromPhpDoc()
|
|
||||||
{
|
|
||||||
$methodNames = array_map(function (Method $method) {
|
|
||||||
return $method->getName();
|
|
||||||
}, $this->getMethods());
|
|
||||||
|
|
||||||
foreach ($this->phpdoc->getTags() as $tag) {
|
|
||||||
if ($tag instanceof MethodTag && in_array($tag->getMethodName(), $methodNames)) {
|
|
||||||
$this->phpdoc->deleteTag($tag);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Output an error.
|
* Output an error.
|
||||||
*
|
*
|
||||||
* @param string $string
|
* @param string $string
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
protected function error($string)
|
protected function error($string)
|
||||||
|
|||||||
@@ -1,62 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Laravel IDE Helper Generator - Eloquent Model Mixin
|
|
||||||
*
|
|
||||||
* @author Charles A. Peterson <[email protected]>
|
|
||||||
* @copyright 2017 Charles A. Peterson / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
|
||||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper
|
|
||||||
*/
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Eloquent;
|
|
||||||
use Illuminate\Console\Command;
|
|
||||||
use Illuminate\Filesystem\Filesystem;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A command to add \Eloquent mixin to Eloquent\Model
|
|
||||||
*
|
|
||||||
* @author Charles A. Peterson <[email protected]>
|
|
||||||
*/
|
|
||||||
class EloquentCommand extends Command
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* The console command name.
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
protected $name = 'ide-helper:eloquent';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @var Filesystem $files
|
|
||||||
*/
|
|
||||||
protected $files;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The console command description.
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
protected $description = 'Add \Eloquent helper to \Eloquent\Model';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param Filesystem $files
|
|
||||||
*/
|
|
||||||
public function __construct(Filesystem $files)
|
|
||||||
{
|
|
||||||
parent::__construct();
|
|
||||||
$this->files = $files;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Execute the console command.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function handle()
|
|
||||||
{
|
|
||||||
Eloquent::writeEloquentModelHelper($this, $this->files);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
@@ -11,14 +10,12 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Eloquent;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Generator;
|
use Barryvdh\LaravelIdeHelper\Generator;
|
||||||
|
use Illuminate\Config\Repository as ConfigRepository;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
use Illuminate\Contracts\Config\Repository;
|
|
||||||
use Illuminate\Filesystem\Filesystem;
|
use Illuminate\Filesystem\Filesystem;
|
||||||
use Illuminate\View\Factory;
|
|
||||||
use Symfony\Component\Console\Input\InputArgument;
|
|
||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
|
use Symfony\Component\Console\Input\InputArgument;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A command to generate autocomplete information for your IDE
|
* A command to generate autocomplete information for your IDE
|
||||||
@@ -27,43 +24,36 @@ use Symfony\Component\Console\Input\InputOption;
|
|||||||
*/
|
*/
|
||||||
class GeneratorCommand extends Command
|
class GeneratorCommand extends Command
|
||||||
{
|
{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command name.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
*/
|
||||||
protected $name = 'ide-helper:generate';
|
protected $name = 'ide-helper:generate';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
*/
|
||||||
protected $description = 'Generate a new IDE Helper file.';
|
protected $description = 'Generate a new IDE Helper file.';
|
||||||
|
|
||||||
/** @var \Illuminate\Config\Repository */
|
/** @var \Illuminate\Config\Repository */
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
/** @var Filesystem */
|
/** @var \Illuminate\Filesystem\Filesystem */
|
||||||
protected $files;
|
protected $files;
|
||||||
|
|
||||||
/** @var Factory */
|
/** @var \Illuminate\View\Factory */
|
||||||
protected $view;
|
protected $view;
|
||||||
|
|
||||||
protected $onlyExtend;
|
protected $onlyExtend;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Illuminate\Config\Repository $config
|
||||||
* @param Filesystem $files
|
* @param \Illuminate\Filesystem\Filesystem $files
|
||||||
* @param Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(ConfigRepository $config, Filesystem $files, $view) {
|
||||||
Repository $config,
|
|
||||||
Filesystem $files,
|
|
||||||
Factory $view
|
|
||||||
) {
|
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
$this->files = $files;
|
$this->files = $files;
|
||||||
$this->view = $view;
|
$this->view = $view;
|
||||||
@@ -75,60 +65,47 @@ class GeneratorCommand extends Command
|
|||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function fire()
|
||||||
{
|
{
|
||||||
if (
|
if (file_exists($compiled = base_path() . '/bootstrap/compiled.php')) {
|
||||||
file_exists(base_path() . '/vendor/compiled.php') ||
|
|
||||||
file_exists(base_path() . '/bootstrap/cache/compiled.php') ||
|
|
||||||
file_exists(base_path() . '/storage/framework/compiled.php')
|
|
||||||
) {
|
|
||||||
$this->error(
|
$this->error(
|
||||||
'Error generating IDE Helper: first delete your compiled file (php artisan clear-compiled)'
|
'Error generating IDE Helper: first delete bootstrap/compiled.php (php artisan clear-compiled)'
|
||||||
);
|
);
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$filename = $this->argument('filename');
|
|
||||||
|
|
||||||
// Add the php extension if missing
|
|
||||||
// This is a backwards-compatible shim and can be removed in the future
|
|
||||||
if (substr($filename, -4, 4) !== '.php') {
|
|
||||||
$filename .= '.php';
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($this->option('memory')) {
|
|
||||||
$this->useMemoryDriver();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
$helpers = '';
|
|
||||||
if ($this->option('helpers') || ($this->config->get('ide-helper.include_helpers'))) {
|
|
||||||
foreach ($this->config->get('ide-helper.helper_files', []) as $helper) {
|
|
||||||
if (file_exists($helper)) {
|
|
||||||
$helpers .= str_replace(['<?php', '?>'], '', $this->files->get($helper));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
|
$filename = $this->argument('filename');
|
||||||
|
$format = $this->option('format');
|
||||||
|
|
||||||
|
// Strip the php extension
|
||||||
|
if (substr($filename, -4, 4) == '.php') {
|
||||||
|
$filename = substr($filename, 0, -4);
|
||||||
|
}
|
||||||
|
|
||||||
|
$filename .= '.' . $format;
|
||||||
|
|
||||||
|
if ($this->option('memory')) {
|
||||||
|
$this->useMemoryDriver();
|
||||||
|
}
|
||||||
|
|
||||||
$helpers = '';
|
$helpers = '';
|
||||||
}
|
if ($this->option('helpers') || ($this->config->get('laravel-ide-helper::include_helpers'))) {
|
||||||
|
foreach ($this->config->get('laravel-ide-helper::helper_files', array()) as $helper) {
|
||||||
|
if (file_exists($helper)) {
|
||||||
|
$helpers .= str_replace(array('<?php', '?>'), '', $this->files->get($helper));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$helpers = '';
|
||||||
|
}
|
||||||
|
|
||||||
$generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
|
$generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
|
||||||
if ($this->option('eloquent')) {
|
$content = $generator->generate($format);
|
||||||
$content = $generator->generateEloquent();
|
$written = $this->files->put($filename, $content);
|
||||||
} else {
|
|
||||||
$content = $generator->generate();
|
|
||||||
}
|
|
||||||
|
|
||||||
$written = $this->files->put($filename, $content);
|
if ($written !== false) {
|
||||||
|
$this->info("A new helper file was written to $filename");
|
||||||
if ($written !== false) {
|
} else {
|
||||||
$this->info("A new helper file was written to $filename");
|
$this->error("The helper file could not be created at $filename");
|
||||||
|
|
||||||
if ($this->option('write_mixins')) {
|
|
||||||
Eloquent::writeEloquentModelHelper($this, $this->files);
|
|
||||||
}
|
}
|
||||||
} else {
|
|
||||||
$this->error("The helper file could not be created at $filename");
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -137,44 +114,41 @@ class GeneratorCommand extends Command
|
|||||||
//Use a sqlite database in memory, to avoid connection errors on Database facades
|
//Use a sqlite database in memory, to avoid connection errors on Database facades
|
||||||
$this->config->set(
|
$this->config->set(
|
||||||
'database.connections.sqlite',
|
'database.connections.sqlite',
|
||||||
[
|
array(
|
||||||
'driver' => 'sqlite',
|
'driver' => 'sqlite',
|
||||||
'database' => ':memory:',
|
'database' => ':memory:',
|
||||||
]
|
)
|
||||||
);
|
);
|
||||||
$this->config->set('database.default', 'sqlite');
|
$this->config->set('database.default', 'sqlite');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the console command arguments.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
protected function getArguments()
|
protected function getArguments()
|
||||||
{
|
{
|
||||||
$filename = $this->config->get('ide-helper.filename');
|
$filename = $this->config->get('laravel-ide-helper::filename');
|
||||||
|
|
||||||
return [
|
return array(
|
||||||
[
|
array(
|
||||||
'filename', InputArgument::OPTIONAL, 'The path to the helper file', $filename,
|
'filename', InputArgument::OPTIONAL, 'The path to the helper file', $filename
|
||||||
],
|
),
|
||||||
];
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the console command options.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
$writeMixins = $this->config->get('ide-helper.write_eloquent_model_mixins');
|
$format = $this->config->get('laravel-ide-helper::format');
|
||||||
|
|
||||||
return [
|
return array(
|
||||||
['write_mixins', 'W', InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins],
|
array('format', 'F', InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),
|
||||||
['helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'],
|
array('helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'),
|
||||||
['memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'],
|
array('memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'),
|
||||||
['eloquent', 'E', InputOption::VALUE_NONE, 'Only write Eloquent methods'],
|
array('sublime', 'S', InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
|
||||||
];
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
+52
-291
@@ -1,5 +1,4 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
@@ -11,93 +10,52 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Factories;
|
|
||||||
use Dotenv\Parser\Entry;
|
|
||||||
use Dotenv\Parser\Parser;
|
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
use Illuminate\Contracts\Config\Repository;
|
|
||||||
use Illuminate\Contracts\View\Factory;
|
|
||||||
use Illuminate\Filesystem\Filesystem;
|
|
||||||
use Illuminate\Support\Collection;
|
|
||||||
use RuntimeException;
|
|
||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A command to generate phpstorm meta data
|
* A command to generate phpstorm meta data
|
||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @property \Illuminate\Container\Container $laravel
|
||||||
*/
|
*/
|
||||||
class MetaCommand extends Command
|
class MetaCommand extends Command {
|
||||||
{
|
|
||||||
/**
|
|
||||||
* The console command name.
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
protected $name = 'ide-helper:meta';
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* {@inheritdoc}
|
||||||
*
|
*/
|
||||||
* @var string
|
protected $name = 'ide-helper:meta';
|
||||||
|
protected $filename = '.phpstorm.meta.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
*/
|
*/
|
||||||
protected $description = 'Generate metadata for PhpStorm';
|
protected $description = 'Generate metadata for PhpStorm';
|
||||||
|
|
||||||
/** @var \Illuminate\Contracts\Filesystem\Filesystem */
|
/** @var \Illuminate\Filesystem\Filesystem */
|
||||||
protected $files;
|
protected $files;
|
||||||
|
|
||||||
/** @var Factory */
|
/** @var \Illuminate\View\Factory */
|
||||||
protected $view;
|
protected $view;
|
||||||
|
|
||||||
/** @var Repository */
|
protected $methods = array(
|
||||||
protected $config;
|
//'\Illuminate\Foundation\Application::make',
|
||||||
|
'new \Illuminate\Container\Container',
|
||||||
protected $methods = [
|
'\Illuminate\Container\Container::make',
|
||||||
'new \Illuminate\Contracts\Container\Container',
|
'\App::make',
|
||||||
'\Illuminate\Container\Container::makeWith(0)',
|
'app',
|
||||||
'\Illuminate\Contracts\Container\Container::get(0)',
|
);
|
||||||
'\Illuminate\Contracts\Container\Container::make(0)',
|
|
||||||
'\Illuminate\Contracts\Container\Container::makeWith(0)',
|
|
||||||
'\App::get(0)',
|
|
||||||
'\App::make(0)',
|
|
||||||
'\App::makeWith(0)',
|
|
||||||
'\app(0)',
|
|
||||||
'\resolve(0)',
|
|
||||||
'\Psr\Container\ContainerInterface::get(0)',
|
|
||||||
];
|
|
||||||
|
|
||||||
protected $configMethods = [
|
|
||||||
'\config()',
|
|
||||||
'\Illuminate\Config\Repository::get()',
|
|
||||||
'\Illuminate\Support\Facades\Config::get()',
|
|
||||||
];
|
|
||||||
|
|
||||||
protected $userMethods = [
|
|
||||||
'\auth()->user()',
|
|
||||||
'\Illuminate\Contracts\Auth\Guard::user()',
|
|
||||||
'\Illuminate\Support\Facades\Auth::user()',
|
|
||||||
'\request()->user()',
|
|
||||||
'\Illuminate\Http\Request::user()',
|
|
||||||
'\Illuminate\Support\Facades\Request::user()',
|
|
||||||
];
|
|
||||||
|
|
||||||
protected $templateCache = [];
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
*
|
*
|
||||||
* @param Filesystem $files
|
* @param \Illuminate\Container\Container $app
|
||||||
* @param Factory $view
|
|
||||||
* @param Repository $config
|
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct($app)
|
||||||
Filesystem $files,
|
{
|
||||||
Factory $view,
|
$this->laravel = $app;
|
||||||
Repository $config
|
$this->files = $app['files'];
|
||||||
) {
|
$this->view = $app['view'];
|
||||||
$this->files = $files;
|
|
||||||
$this->view = $view;
|
|
||||||
$this->config = $config;
|
|
||||||
parent::__construct();
|
parent::__construct();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -106,57 +64,33 @@ class MetaCommand extends Command
|
|||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function fire()
|
||||||
{
|
{
|
||||||
// Needs to run before exception handler is registered
|
$bindings = array_flip($this->getAppAliases());
|
||||||
$factories = $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [];
|
$exclude = $this->option('exclude');
|
||||||
|
if (!empty($exclude)) {
|
||||||
|
$exclude = '/' . str_replace('\|', '|', preg_quote($exclude, '/')) . '/';
|
||||||
|
}
|
||||||
|
|
||||||
$ourAutoloader = $this->registerClassAutoloadExceptions();
|
|
||||||
|
|
||||||
$bindings = [];
|
|
||||||
foreach ($this->getAbstracts() as $abstract) {
|
foreach ($this->getAbstracts() as $abstract) {
|
||||||
// Validator and seeder cause problems
|
if (!empty($exclude) && preg_match($exclude, $abstract))
|
||||||
if (in_array($abstract, ['validator', 'seeder'])) {
|
|
||||||
continue;
|
continue;
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$concrete = $this->laravel->make($abstract);
|
$concrete = $this->laravel->make($abstract);
|
||||||
|
if (is_object($concrete)) {
|
||||||
if ($concrete === null) {
|
|
||||||
throw new RuntimeException("Cannot create instance for '$abstract', received 'null'");
|
|
||||||
}
|
|
||||||
|
|
||||||
$reflectionClass = new \ReflectionClass($concrete);
|
|
||||||
if (is_object($concrete) && !$reflectionClass->isAnonymous() && $abstract !== get_class($concrete)) {
|
|
||||||
$bindings[$abstract] = get_class($concrete);
|
$bindings[$abstract] = get_class($concrete);
|
||||||
}
|
}
|
||||||
} catch (\Throwable $e) {
|
} catch (\Exception $e) {
|
||||||
if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
|
$this->error("Cannot make $abstract: " . $e->getMessage());
|
||||||
$this->comment("Cannot make '$abstract': " . $e->getMessage());
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
asort($bindings);
|
||||||
|
|
||||||
$this->unregisterClassAutoloadExceptions($ourAutoloader);
|
$content = $this->view->make('laravel-ide-helper::meta', array(
|
||||||
|
|
||||||
$configValues = $this->loadTemplate('configs')->pluck('value', 'name')->map(function ($value, $key) {
|
|
||||||
return gettype($value);
|
|
||||||
});
|
|
||||||
|
|
||||||
$defaultUserModel = $this->config->get('auth.providers.users.model', $this->config->get('auth.model', 'App\User'));
|
|
||||||
|
|
||||||
$content = $this->view->make('ide-helper::meta', [
|
|
||||||
'bindings' => $bindings,
|
'bindings' => $bindings,
|
||||||
'methods' => $this->methods,
|
'methods' => $this->methods,
|
||||||
'factories' => $factories,
|
))->render();
|
||||||
'configMethods' => $this->configMethods,
|
|
||||||
'configValues' => $configValues,
|
|
||||||
'expectedArgumentSets' => $this->getExpectedArgumentSets(),
|
|
||||||
'expectedArguments' => $this->getExpectedArguments(),
|
|
||||||
'userModel' => $defaultUserModel,
|
|
||||||
'userMethods' => $this->userMethods,
|
|
||||||
])->render();
|
|
||||||
|
|
||||||
$filename = $this->option('filename');
|
$filename = $this->option('filename');
|
||||||
$written = $this->files->put($filename, $content);
|
$written = $this->files->put($filename, $content);
|
||||||
@@ -175,205 +109,32 @@ class MetaCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function getAbstracts()
|
protected function getAbstracts()
|
||||||
{
|
{
|
||||||
$abstracts = $this->laravel->getBindings();
|
return array_keys($this->laravel->getBindings());
|
||||||
|
|
||||||
// Return the abstract names only
|
|
||||||
$keys = array_keys($abstracts);
|
|
||||||
|
|
||||||
sort($keys);
|
|
||||||
|
|
||||||
return $keys;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register an autoloader the throws exceptions when a class is not found.
|
* Get a list of aliases from the Laravel Application.
|
||||||
*
|
|
||||||
* @return callable
|
|
||||||
*/
|
|
||||||
protected function registerClassAutoloadExceptions(): callable
|
|
||||||
{
|
|
||||||
$aliases = array_filter([...$this->getAbstracts(), 'config'], fn ($abstract) => !str_contains($abstract, '\\'));
|
|
||||||
|
|
||||||
$autoloader = function ($class) use ($aliases) {
|
|
||||||
// ignore aliases as they're meant to be resolved elsewhere
|
|
||||||
if (in_array($class, $aliases, true)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new \ReflectionException("Class '$class' not found.");
|
|
||||||
};
|
|
||||||
|
|
||||||
spl_autoload_register($autoloader);
|
|
||||||
|
|
||||||
return $autoloader;
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function getExpectedArgumentSets()
|
|
||||||
{
|
|
||||||
return [
|
|
||||||
'auth' => $this->loadTemplate('auth')->keys()->filter()->toArray(),
|
|
||||||
'configs' => $this->loadTemplate('configs')->pluck('name')->filter()->toArray(),
|
|
||||||
'middleware' => $this->loadTemplate('middleware')->keys()->filter()->toArray(),
|
|
||||||
'routes' => $this->loadTemplate('routes')->pluck('name')->filter()->toArray(),
|
|
||||||
'views' => $this->loadTemplate('views')->pluck('key')->filter()->map(function ($value) {
|
|
||||||
return (string) $value;
|
|
||||||
})->toArray(),
|
|
||||||
'translations' => $this->loadTemplate('translations')->filter()->keys()->toArray(),
|
|
||||||
'env' => $this->getEnv(),
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function getExpectedArguments()
|
|
||||||
{
|
|
||||||
return [
|
|
||||||
[
|
|
||||||
'class' => '\Illuminate\Support\Facades\Gate',
|
|
||||||
'method' => [
|
|
||||||
'has',
|
|
||||||
'allows',
|
|
||||||
'denies',
|
|
||||||
'check',
|
|
||||||
'any',
|
|
||||||
'none',
|
|
||||||
'authorize',
|
|
||||||
'inspect',
|
|
||||||
],
|
|
||||||
'argumentSet' => 'auth',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'class' => ['\Illuminate\Support\Facades\Route', '\Illuminate\Support\Facades\Auth', 'Illuminate\Foundation\Auth\Access\Authorizable'],
|
|
||||||
'method' => ['can', 'cannot', 'cant'],
|
|
||||||
'argumentSet' => 'auth',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'class' => ['Illuminate\Contracts\Auth\Access\Authorizable'],
|
|
||||||
'method' => ['can'],
|
|
||||||
'argumentSet' => 'auth',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'class' => ['\Illuminate\Config\Repository', '\Illuminate\Support\Facades\Config'],
|
|
||||||
'method' => [
|
|
||||||
// 'get', // config() and Config::Get() are added with return type hints already
|
|
||||||
'getMany',
|
|
||||||
'set',
|
|
||||||
'string',
|
|
||||||
'integer',
|
|
||||||
'boolean',
|
|
||||||
'float',
|
|
||||||
'array',
|
|
||||||
'prepend',
|
|
||||||
'push',
|
|
||||||
],
|
|
||||||
'argumentSet' => 'configs',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'class' => ['\Illuminate\Support\Facades\Route', '\Illuminate\Routing\Router'],
|
|
||||||
'method' => ['middleware', 'withoutMiddleware'],
|
|
||||||
'argumentSet' => 'middleware',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'method' => ['route', 'to_route', 'signedRoute'],
|
|
||||||
'argumentSet' => 'routes',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'class' => [
|
|
||||||
'\Illuminate\Support\Facades\Redirect',
|
|
||||||
'\Illuminate\Support\Facades\URL',
|
|
||||||
'\Illuminate\Routing\Redirector',
|
|
||||||
'\Illuminate\Routing\UrlGenerator',
|
|
||||||
],
|
|
||||||
'method' => ['route', 'signedRoute', 'temporarySignedRoute'],
|
|
||||||
'argumentSet' => 'routes',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'method' => 'view',
|
|
||||||
'argumentSet' => 'views',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'class' => ['\Illuminate\Support\Facades\View', '\Illuminate\View\Factory'],
|
|
||||||
'method' => 'make',
|
|
||||||
'argumentSet' => 'views',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'method' => ['__', 'trans'],
|
|
||||||
'argumentSet' => 'translations',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'class' => ['\Illuminate\Contracts\Translation\Translator'],
|
|
||||||
'method' => ['get'],
|
|
||||||
'argumentSet' => 'translations',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'method' => 'env',
|
|
||||||
'argumentSet' => 'env',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'class' => '\Illuminate\Support\Env',
|
|
||||||
'method' => 'get',
|
|
||||||
'argumentSet' => 'env',
|
|
||||||
],
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return Collection
|
|
||||||
*/
|
|
||||||
protected function loadTemplate($name)
|
|
||||||
{
|
|
||||||
if (!isset($this->templateCache[$name])) {
|
|
||||||
$file = __DIR__ . '/../../php-templates/' . basename($name) . '.php';
|
|
||||||
try {
|
|
||||||
$value = $this->files->requireOnce($file) ?: [];
|
|
||||||
} catch (\Throwable $e) {
|
|
||||||
$value = [];
|
|
||||||
$this->warn('Cannot load template for ' . $name . ': ' . $e->getMessage());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!$value instanceof Collection) {
|
|
||||||
$value = collect($value);
|
|
||||||
}
|
|
||||||
$this->templateCache[$name] = $value;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $this->templateCache[$name];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the console command options.
|
|
||||||
*
|
*
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
protected function getOptions()
|
protected function getAppAliases()
|
||||||
{
|
{
|
||||||
$filename = $this->config->get('ide-helper.meta_filename');
|
static $aliasProp;
|
||||||
|
if (!isset($aliasProp)) {
|
||||||
return [
|
$aliasProp = new \ReflectionProperty('Illuminate\Container\Container', 'aliases');
|
||||||
['filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $filename],
|
$aliasProp->setAccessible(true);
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function getEnv()
|
|
||||||
{
|
|
||||||
$envPath = base_path('.env');
|
|
||||||
if (!file_exists($envPath)) {
|
|
||||||
return [];
|
|
||||||
}
|
}
|
||||||
|
return $aliasProp->getValue($this->laravel);
|
||||||
$parser = new Parser();
|
|
||||||
$entries = $parser->parse(file_get_contents($envPath));
|
|
||||||
|
|
||||||
return collect($entries)->map(function (Entry $entry) {
|
|
||||||
return $entry->getName();
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove our custom autoloader that we pushed onto the autoload stack
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param callable $ourAutoloader
|
|
||||||
*/
|
*/
|
||||||
private function unregisterClassAutoloadExceptions(callable $ourAutoloader): void
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
spl_autoload_unregister($ourAutoloader);
|
return array(
|
||||||
|
array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
|
||||||
|
array('exclude', 'E', InputOption::VALUE_OPTIONAL, 'Laravel bindings to exclude (e.g. "bar.|.foo")'),
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+195
-1456
File diff suppressed because it is too large
Load Diff
@@ -1,11 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Contracts;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
interface ModelHookInterface
|
|
||||||
{
|
|
||||||
public function run(ModelsCommand $command, Model $model): void;
|
|
||||||
}
|
|
||||||
@@ -1,113 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Laravel IDE Helper to add \Eloquent mixin to Eloquent\Model
|
|
||||||
*
|
|
||||||
* @author Charles A. Peterson <artistan@gmail.com>
|
|
||||||
*/
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
|
||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
|
||||||
use Illuminate\Console\Command;
|
|
||||||
use Illuminate\Filesystem\Filesystem;
|
|
||||||
|
|
||||||
class Eloquent
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Write mixin helper to the Eloquent\Model
|
|
||||||
* This is needed since laravel/framework v5.4.29
|
|
||||||
*
|
|
||||||
* @param Command $command
|
|
||||||
* @param Filesystem $files
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public static function writeEloquentModelHelper(Command $command, Filesystem $files)
|
|
||||||
{
|
|
||||||
$class = 'Illuminate\Database\Eloquent\Model';
|
|
||||||
|
|
||||||
$reflection = new \ReflectionClass($class);
|
|
||||||
$namespace = $reflection->getNamespaceName();
|
|
||||||
$originalDoc = $reflection->getDocComment();
|
|
||||||
|
|
||||||
if (!$originalDoc) {
|
|
||||||
$command->info('Unexpected no document on ' . $class);
|
|
||||||
}
|
|
||||||
$phpdoc = new DocBlock($reflection, new Context($namespace));
|
|
||||||
|
|
||||||
$mixins = $phpdoc->getTagsByName('mixin');
|
|
||||||
$expectedMixins = [
|
|
||||||
'\Eloquent' => false,
|
|
||||||
'\Illuminate\Database\Eloquent\Builder' => false,
|
|
||||||
'\Illuminate\Database\Query\Builder' => false,
|
|
||||||
];
|
|
||||||
|
|
||||||
foreach ($mixins as $m) {
|
|
||||||
$mixin = $m->getContent();
|
|
||||||
|
|
||||||
if (isset($expectedMixins[$mixin])) {
|
|
||||||
$command->info('Tag Exists: @mixin ' . $mixin . ' in ' . $class);
|
|
||||||
|
|
||||||
$expectedMixins[$mixin] = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$changed = false;
|
|
||||||
foreach ($expectedMixins as $expectedMixin => $present) {
|
|
||||||
if ($present === false) {
|
|
||||||
$phpdoc->appendTag(Tag::createInstance('@mixin ' . $expectedMixin, $phpdoc));
|
|
||||||
|
|
||||||
$changed = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If nothing's changed, stop here.
|
|
||||||
if (!$changed) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$serializer = new DocBlockSerializer();
|
|
||||||
$serializer->getDocComment($phpdoc);
|
|
||||||
$docComment = $serializer->getDocComment($phpdoc);
|
|
||||||
|
|
||||||
/*
|
|
||||||
The new DocBlock is appended to the beginning of the class declaration.
|
|
||||||
Since there is no DocBlock, the declaration is used as a guide.
|
|
||||||
*/
|
|
||||||
if (!$originalDoc) {
|
|
||||||
$originalDoc = 'abstract class Model implements';
|
|
||||||
|
|
||||||
$docComment .= "\nabstract class Model implements";
|
|
||||||
}
|
|
||||||
|
|
||||||
$filename = $reflection->getFileName();
|
|
||||||
if (!$filename) {
|
|
||||||
$command->error('Filename not found ' . $class);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$contents = $files->get($filename);
|
|
||||||
if (!$contents) {
|
|
||||||
$command->error('No file contents found ' . $filename);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$count = 0;
|
|
||||||
$contents = str_replace($originalDoc, $docComment, $contents, $count);
|
|
||||||
if ($count <= 0) {
|
|
||||||
$command->error('Content did not change ' . $contents);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!$files->put($filename, $contents)) {
|
|
||||||
$command->error('File write failed to ' . $filename);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$command->info('Wrote expected docblock to ' . $filename);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
|
||||||
|
|
||||||
use Exception;
|
|
||||||
use Illuminate\Database\Eloquent\Factory;
|
|
||||||
use ReflectionClass;
|
|
||||||
|
|
||||||
class Factories
|
|
||||||
{
|
|
||||||
public static function all()
|
|
||||||
{
|
|
||||||
$factories = [];
|
|
||||||
|
|
||||||
if (static::isLaravelSevenOrLower()) {
|
|
||||||
$factory = app(Factory::class);
|
|
||||||
|
|
||||||
$definitions = (new ReflectionClass(Factory::class))->getProperty('definitions');
|
|
||||||
|
|
||||||
foreach ($definitions->getValue($factory) as $factory_target => $config) {
|
|
||||||
try {
|
|
||||||
$factories[] = new ReflectionClass($factory_target);
|
|
||||||
} catch (Exception $exception) {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return $factories;
|
|
||||||
}
|
|
||||||
|
|
||||||
protected static function isLaravelSevenOrLower()
|
|
||||||
{
|
|
||||||
return class_exists('Illuminate\Database\Eloquent\Factory');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+114
-269
@@ -1,5 +1,4 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
@@ -11,13 +10,8 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
use /** @noinspection PhpUndefinedNamespaceInspection,PhpUndefinedClassInspection */Illuminate\Foundation\AliasLoader;
|
||||||
use Illuminate\Foundation\AliasLoader;
|
use Illuminate\Config\Repository as ConfigRepository;
|
||||||
use Illuminate\Support\Collection;
|
|
||||||
use Illuminate\Support\Facades\Facade;
|
|
||||||
use Illuminate\Support\Str;
|
|
||||||
use Illuminate\Support\Traits\Macroable;
|
|
||||||
use ReflectionClass;
|
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
||||||
class Generator
|
class Generator
|
||||||
@@ -28,41 +22,31 @@ class Generator
|
|||||||
/** @var \Illuminate\View\Factory */
|
/** @var \Illuminate\View\Factory */
|
||||||
protected $view;
|
protected $view;
|
||||||
|
|
||||||
/** @var OutputInterface */
|
/** @var \Symfony\Component\Console\Output\OutputInterface */
|
||||||
protected $output;
|
protected $output;
|
||||||
|
|
||||||
protected $extra = [];
|
protected $extra = array();
|
||||||
protected $magic = [];
|
protected $magic = array();
|
||||||
protected $interfaces = [];
|
protected $interfaces = array();
|
||||||
protected $helpers;
|
protected $helpers;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Illuminate\Config\Repository $config
|
||||||
* @param \Illuminate\View\Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
* @param ?OutputInterface $output
|
* @param \Symfony\Component\Console\Output\OutputInterface $output
|
||||||
* @param string $helpers
|
* @param string $helpers
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(ConfigRepository $config, $view, OutputInterface $output = null, $helpers = '')
|
||||||
/*ConfigRepository */
|
{
|
||||||
$config,
|
|
||||||
/* Illuminate\View\Factory */
|
|
||||||
$view,
|
|
||||||
?OutputInterface $output = null,
|
|
||||||
$helpers = ''
|
|
||||||
) {
|
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
$this->view = $view;
|
$this->view = $view;
|
||||||
$this->output = $output;
|
|
||||||
|
|
||||||
// Find the drivers to add to the extra/interfaces
|
// Find the drivers to add to the extra/interfaces
|
||||||
$this->detectDrivers();
|
$this->detectDrivers();
|
||||||
|
|
||||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra', []));
|
$this->extra = array_merge($this->extra, $this->config->get('laravel-ide-helper::extra'));
|
||||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic', []));
|
$this->magic = array_merge($this->magic, $this->config->get('laravel-ide-helper::magic'));
|
||||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces', []));
|
$this->interfaces = array_merge($this->interfaces, $this->config->get('laravel-ide-helper::interfaces'));
|
||||||
Macro::setDefaultReturnTypes($this->config->get('ide-helper.macro_default_return_types', [
|
|
||||||
\Illuminate\Http\Client\Factory::class => \Illuminate\Http\Client\PendingRequest::class,
|
|
||||||
]));
|
|
||||||
|
|
||||||
// Make all interface classes absolute
|
// Make all interface classes absolute
|
||||||
foreach ($this->interfaces as &$interface) {
|
foreach ($this->interfaces as &$interface) {
|
||||||
@@ -74,268 +58,180 @@ class Generator
|
|||||||
/**
|
/**
|
||||||
* Generate the helper file contents;
|
* Generate the helper file contents;
|
||||||
*
|
*
|
||||||
|
* @param string $format The format to generate the helper in (php/json)
|
||||||
* @return string;
|
* @return string;
|
||||||
*/
|
*/
|
||||||
public function generate()
|
public function generate($format = 'php')
|
||||||
|
{
|
||||||
|
// Check if the generator for this format exists
|
||||||
|
$method = 'generate' . ucfirst($format) . 'Helper';
|
||||||
|
if (method_exists($this, $method)) {
|
||||||
|
return $this->$method();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->generatePhpHelper();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function generatePhpHelper()
|
||||||
{
|
{
|
||||||
$app = app();
|
$app = app();
|
||||||
return $this->view->make('ide-helper::helper')
|
return $this->view->make('laravel-ide-helper::ide-helper')
|
||||||
->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
|
->with('namespaces', $this->getNamespaces())
|
||||||
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
->with('helpers', $this->helpers)
|
||||||
->with('real_time_facades', $this->getRealTimeFacades())
|
->with('version', $app::VERSION)
|
||||||
->with('helpers', $this->detectHelpers())
|
|
||||||
->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
|
|
||||||
->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
|
|
||||||
->render();
|
->render();
|
||||||
}
|
}
|
||||||
|
|
||||||
public function generateEloquent()
|
public function generateJsonHelper()
|
||||||
{
|
{
|
||||||
$name = 'Eloquent';
|
$classes = array();
|
||||||
$facade = Model::class;
|
foreach ($this->getNamespaces() as $aliases) {
|
||||||
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : [];
|
foreach ($aliases as $alias) {
|
||||||
$alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces);
|
$functions = array();
|
||||||
if (!$alias->isValid()) {
|
foreach ($alias->getMethods() as $method) {
|
||||||
throw new \RuntimeException('Cannot generate Eloquent helper');
|
$functions[$method->getName()] = '(' . $method->getParamsWithDefault() . ')';
|
||||||
|
}
|
||||||
|
$classes[$alias->getAlias()] = array(
|
||||||
|
'functions' => $functions,
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
//Add extra methods, from other classes (magic static calls)
|
$flags = JSON_FORCE_OBJECT;
|
||||||
if (array_key_exists($name, $this->extra)) {
|
if (defined('JSON_PRETTY_PRINT')) {
|
||||||
$alias->addClass($this->extra[$name]);
|
$flags |= JSON_PRETTY_PRINT;
|
||||||
}
|
}
|
||||||
|
|
||||||
$app = app();
|
return json_encode(array(
|
||||||
return $this->view->make('ide-helper::helper')
|
'php' => array(
|
||||||
->with('namespaces_by_extends_ns', [])
|
'classes' => $classes,
|
||||||
->with('namespaces_by_alias_ns', ['__root' => [$alias]])
|
),
|
||||||
->with('real_time_facades', [])
|
), $flags);
|
||||||
->with('helpers', '')
|
|
||||||
->with('include_fluent', false)
|
|
||||||
->with('factories', [])
|
|
||||||
->render();
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function detectHelpers()
|
|
||||||
{
|
|
||||||
$helpers = $this->helpers;
|
|
||||||
|
|
||||||
$replacements = [
|
|
||||||
'($guard is null ? \Illuminate\Contracts\Auth\Factory : \Illuminate\Contracts\Auth\StatefulGuard)' => '\\Auth',
|
|
||||||
];
|
|
||||||
foreach ($replacements as $search => $replace) {
|
|
||||||
$helpers = Str::replace(
|
|
||||||
"@return {$search}",
|
|
||||||
"@return $replace|$search",
|
|
||||||
$helpers
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return $helpers;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function detectDrivers()
|
protected function detectDrivers()
|
||||||
{
|
{
|
||||||
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
|
|
||||||
$this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel;
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (
|
if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
|
||||||
class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
&& app()->bound('auth')
|
$class = get_class(\Auth::driver());
|
||||||
) {
|
$this->extra['Auth'] = array($class);
|
||||||
$class = get_class(\Auth::guard());
|
|
||||||
$this->extra['Auth'] = [$class];
|
|
||||||
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
|
$this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
|
||||||
}
|
}
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {}
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
|
if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$class = get_class(\DB::connection());
|
$class = get_class(\DB::connection());
|
||||||
$this->extra['DB'] = [$class];
|
$this->extra['DB'] = array($class);
|
||||||
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
|
$this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
|
||||||
}
|
}
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {}
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$driver = get_class(\Cache::driver());
|
$driver = get_class(\Cache::driver());
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$store = get_class(\Cache::getStore());
|
$store = get_class(\Cache::getStore());
|
||||||
$this->extra['Cache'] = [$driver, $store];
|
$this->extra['Cache'] = array($driver, $store);
|
||||||
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
|
$this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
|
||||||
}
|
}
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {}
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$class = get_class(\Queue::connection());
|
$class = get_class(\Queue::connection());
|
||||||
$this->extra['Queue'] = [$class];
|
$this->extra['Queue'] = array($class);
|
||||||
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
|
$this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
|
||||||
}
|
}
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {}
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
|
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
|
||||||
$class = get_class(\Storage::disk());
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
$this->extra['Storage'] = [$class];
|
$class = get_class(\SSH::connection());
|
||||||
$this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
|
$this->extra['SSH'] = array($class);
|
||||||
|
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
|
||||||
}
|
}
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {}
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Find all aliases that are valid for us to render
|
* Find all namespaces/aliases that are valid for us to render
|
||||||
*
|
*
|
||||||
* @return Collection
|
* @return array|Alias[][]
|
||||||
*/
|
*/
|
||||||
protected function getValidAliases()
|
protected function getNamespaces()
|
||||||
{
|
{
|
||||||
$aliases = new Collection();
|
$namespaces = array();
|
||||||
|
|
||||||
// Get all aliases
|
// Get all aliases
|
||||||
foreach ($this->getAliases() as $name => $facade) {
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
// Skip the Redis facade, if not available (otherwise Fatal PHP Error)
|
foreach (AliasLoader::getInstance()->getAliases() as $name => $facade) {
|
||||||
if ($facade == 'Illuminate\Support\Facades\Redis' && $name == 'Redis' && !class_exists('Predis\Client')) {
|
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
|
||||||
continue;
|
$alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
|
||||||
}
|
|
||||||
|
|
||||||
// Skip the swoole
|
|
||||||
if ($facade == 'SwooleTW\Http\Server\Facades\Server' && $name == 'Server' && !class_exists('Swoole\Http\Server')) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : [];
|
|
||||||
$alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces);
|
|
||||||
if ($alias->isValid()) {
|
if ($alias->isValid()) {
|
||||||
|
|
||||||
//Add extra methods, from other classes (magic static calls)
|
//Add extra methods, from other classes (magic static calls)
|
||||||
if (array_key_exists($name, $this->extra)) {
|
if (array_key_exists($name, $this->extra)) {
|
||||||
$alias->addClass($this->extra[$name]);
|
$alias->addClass($this->extra[$name]);
|
||||||
}
|
}
|
||||||
|
|
||||||
$aliases[] = $alias;
|
$namespace = $alias->getNamespace();
|
||||||
}
|
if (!isset($namespaces[$namespace])) {
|
||||||
}
|
$namespaces[$namespace] = array();
|
||||||
|
|
||||||
return $aliases;
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function getRealTimeFacades()
|
|
||||||
{
|
|
||||||
$facades = [];
|
|
||||||
$realTimeFacadeFiles = glob(storage_path('framework/cache/facade-*.php'));
|
|
||||||
foreach ($realTimeFacadeFiles as $file) {
|
|
||||||
try {
|
|
||||||
$name = $this->getFullyQualifiedClassNameInFile($file);
|
|
||||||
if ($name) {
|
|
||||||
$facades[$name] = $name;
|
|
||||||
}
|
}
|
||||||
} catch (\Throwable $e) {
|
$namespaces[$namespace][] = $alias;
|
||||||
continue;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return $facades;
|
return $namespaces;
|
||||||
}
|
|
||||||
|
|
||||||
protected function getFullyQualifiedClassNameInFile(string $path)
|
|
||||||
{
|
|
||||||
$contents = file_get_contents($path);
|
|
||||||
|
|
||||||
// Match namespace
|
|
||||||
preg_match('/namespace\s+([^;]+);/', $contents, $namespaceMatch);
|
|
||||||
$namespace = isset($namespaceMatch[1]) ? $namespaceMatch[1] : '';
|
|
||||||
|
|
||||||
// Match class name
|
|
||||||
preg_match('/class\s+([a-zA-Z0-9_]+)/', $contents, $classMatch);
|
|
||||||
$className = isset($classMatch[1]) ? $classMatch[1] : '';
|
|
||||||
|
|
||||||
// Combine namespace and class name
|
|
||||||
if ($namespace && $className) {
|
|
||||||
return $namespace . '\\' . $className;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Regroup aliases by namespace of extended classes
|
|
||||||
*
|
|
||||||
* @return Collection
|
|
||||||
*/
|
|
||||||
protected function getAliasesByExtendsNamespace()
|
|
||||||
{
|
|
||||||
$aliases = $this->getValidAliases()->filter(static function (Alias $alias) {
|
|
||||||
return is_subclass_of($alias->getExtends(), Facade::class);
|
|
||||||
});
|
|
||||||
|
|
||||||
$this->addMacroableClasses($aliases);
|
|
||||||
|
|
||||||
return $aliases->groupBy(function (Alias $alias) {
|
|
||||||
return $alias->getExtendsNamespace();
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Regroup aliases by namespace of alias
|
* Get the driver/connection/store from the managers
|
||||||
*
|
*
|
||||||
* @return Collection
|
* @param $alias
|
||||||
|
* @return array|bool|string
|
||||||
*/
|
*/
|
||||||
protected function getAliasesByAliasNamespace()
|
public function getDriver($alias)
|
||||||
{
|
{
|
||||||
return $this->getValidAliases()->groupBy(function (Alias $alias) {
|
try {
|
||||||
return $alias->getNamespace();
|
if ($alias == 'Auth') {
|
||||||
});
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
}
|
$driver = \Auth::driver();
|
||||||
|
} elseif ($alias == 'DB') {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
|
$driver = \DB::connection();
|
||||||
|
} elseif ($alias == 'Cache') {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
|
$driver = get_class(\Cache::driver());
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
|
$store = get_class(\Cache::getStore());
|
||||||
|
return array($driver, $store);
|
||||||
|
} elseif ($alias == 'Queue') {
|
||||||
|
/** @noinspection PhpUndefinedClassInspection */
|
||||||
|
$driver = \Queue::connection();
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
protected function getAliases()
|
return get_class($driver);
|
||||||
{
|
} catch (\Exception $e) {
|
||||||
// For Laravel, use the AliasLoader
|
$this->error("Could not determine driver/connection for $alias.");
|
||||||
if (class_exists('Illuminate\Foundation\AliasLoader')) {
|
return false;
|
||||||
return AliasLoader::getInstance()->getAliases();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$facades = [
|
|
||||||
'App' => 'Illuminate\Support\Facades\App',
|
|
||||||
'Auth' => 'Illuminate\Support\Facades\Auth',
|
|
||||||
'Bus' => 'Illuminate\Support\Facades\Bus',
|
|
||||||
'DB' => 'Illuminate\Support\Facades\DB',
|
|
||||||
'Cache' => 'Illuminate\Support\Facades\Cache',
|
|
||||||
'Cookie' => 'Illuminate\Support\Facades\Cookie',
|
|
||||||
'Crypt' => 'Illuminate\Support\Facades\Crypt',
|
|
||||||
'Event' => 'Illuminate\Support\Facades\Event',
|
|
||||||
'Hash' => 'Illuminate\Support\Facades\Hash',
|
|
||||||
'Log' => 'Illuminate\Support\Facades\Log',
|
|
||||||
'Mail' => 'Illuminate\Support\Facades\Mail',
|
|
||||||
'Queue' => 'Illuminate\Support\Facades\Queue',
|
|
||||||
'Request' => 'Illuminate\Support\Facades\Request',
|
|
||||||
'Schema' => 'Illuminate\Support\Facades\Schema',
|
|
||||||
'Session' => 'Illuminate\Support\Facades\Session',
|
|
||||||
'Storage' => 'Illuminate\Support\Facades\Storage',
|
|
||||||
'Validator' => 'Illuminate\Support\Facades\Validator',
|
|
||||||
'Gate' => 'Illuminate\Support\Facades\Gate',
|
|
||||||
];
|
|
||||||
|
|
||||||
$facades = array_merge($facades, $this->config->get('app.aliases', []));
|
|
||||||
|
|
||||||
// Only return the ones that actually exist
|
|
||||||
return array_filter(
|
|
||||||
$facades,
|
|
||||||
function ($alias) {
|
|
||||||
return class_exists($alias);
|
|
||||||
},
|
|
||||||
ARRAY_FILTER_USE_KEY
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Write a string as error output.
|
* Write a string as error output.
|
||||||
*
|
*
|
||||||
* @param string $string
|
* @param string $string
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
protected function error($string)
|
protected function error($string)
|
||||||
@@ -346,55 +242,4 @@ class Generator
|
|||||||
echo $string . "\r\n";
|
echo $string . "\r\n";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Add all macroable classes which are not already loaded as an alias and have defined macros.
|
|
||||||
*
|
|
||||||
* @param Collection $aliases
|
|
||||||
*/
|
|
||||||
protected function addMacroableClasses(Collection $aliases)
|
|
||||||
{
|
|
||||||
$macroable = $this->getMacroableClasses($aliases);
|
|
||||||
|
|
||||||
foreach ($macroable as $class) {
|
|
||||||
$reflection = new ReflectionClass($class);
|
|
||||||
|
|
||||||
if (!$reflection->getStaticProperties()['macros']) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get all loaded macroable classes which are not loaded as an alias.
|
|
||||||
*
|
|
||||||
* @param Collection $aliases
|
|
||||||
* @return Collection
|
|
||||||
*/
|
|
||||||
protected function getMacroableClasses(Collection $aliases)
|
|
||||||
{
|
|
||||||
return (new Collection(get_declared_classes()))
|
|
||||||
->filter(function ($class) {
|
|
||||||
$reflection = new ReflectionClass($class);
|
|
||||||
|
|
||||||
// Filter out internal classes and class aliases
|
|
||||||
return !$reflection->isInternal() && $reflection->getName() === $class;
|
|
||||||
})
|
|
||||||
->filter(function ($class) {
|
|
||||||
$traits = class_uses_recursive($class);
|
|
||||||
|
|
||||||
// Filter only classes with the macroable trait
|
|
||||||
return isset($traits[Macroable::class]);
|
|
||||||
})
|
|
||||||
->filter(function ($class) use ($aliases) {
|
|
||||||
$class = Str::start($class, '\\');
|
|
||||||
|
|
||||||
// Filter out aliases
|
|
||||||
return !$aliases->first(function (Alias $alias) use ($class) {
|
|
||||||
return $alias->getExtends() === $class;
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
@@ -11,78 +10,70 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
|
use Illuminate\Support\ServiceProvider;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Listeners\GenerateModelHelper;
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
use Illuminate\Console\Events\CommandFinished;
|
|
||||||
use Illuminate\Contracts\Support\DeferrableProvider;
|
|
||||||
use Illuminate\Database\Events\MigrationsEnded;
|
|
||||||
use Illuminate\Support\ServiceProvider;
|
|
||||||
|
|
||||||
class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProvider
|
/**
|
||||||
|
* @property \Illuminate\Container\Container $app
|
||||||
|
*/
|
||||||
|
class IdeHelperServiceProvider extends ServiceProvider
|
||||||
{
|
{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Bootstrap the application events.
|
* {@inheritdoc}
|
||||||
*
|
*/
|
||||||
* @return void
|
protected $defer = true;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
*/
|
*/
|
||||||
public function boot()
|
public function boot()
|
||||||
{
|
{
|
||||||
if (!$this->app->runningUnitTests() && $this->app['config']->get('ide-helper.post_migrate', [])) {
|
$this->package('barryvdh/laravel-ide-helper', 'laravel-ide-helper', __DIR__);
|
||||||
$this->app['events']->listen(CommandFinished::class, GenerateModelHelper::class);
|
|
||||||
$this->app['events']->listen(MigrationsEnded::class, function () {
|
|
||||||
GenerateModelHelper::$shouldRun = true;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($this->app->has('view')) {
|
|
||||||
$viewPath = __DIR__ . '/../resources/views';
|
|
||||||
$this->loadViewsFrom($viewPath, 'ide-helper');
|
|
||||||
}
|
|
||||||
|
|
||||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
|
||||||
if (function_exists('config_path')) {
|
|
||||||
$publishPath = config_path('ide-helper.php');
|
|
||||||
} else {
|
|
||||||
$publishPath = base_path('config/ide-helper.php');
|
|
||||||
}
|
|
||||||
$this->publishes([$configPath => $publishPath], 'config');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register the service provider.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function register()
|
public function register()
|
||||||
{
|
{
|
||||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
$this->app['command.ide-helper.generate'] = $this->app->share(
|
||||||
$this->mergeConfigFrom($configPath, 'ide-helper');
|
function ($app) {
|
||||||
|
return new GeneratorCommand($app['config'], $app['files'], $app['view']);
|
||||||
$this->commands(
|
}
|
||||||
[
|
|
||||||
GeneratorCommand::class,
|
|
||||||
ModelsCommand::class,
|
|
||||||
MetaCommand::class,
|
|
||||||
EloquentCommand::class,
|
|
||||||
]
|
|
||||||
);
|
);
|
||||||
|
|
||||||
|
$this->app['command.ide-helper.models'] = $this->app->share(
|
||||||
|
function ($app) {
|
||||||
|
return new ModelsCommand($app);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->app['command.ide-helper.meta'] = $this->app->share(
|
||||||
|
function ($app) {
|
||||||
|
return new MetaCommand($app);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the services provided by the provider.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
public function provides()
|
public function provides()
|
||||||
{
|
{
|
||||||
return [
|
return array('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
|
||||||
GeneratorCommand::class,
|
|
||||||
ModelsCommand::class,
|
|
||||||
MetaCommand::class,
|
|
||||||
EloquentCommand::class,
|
|
||||||
];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
protected function getAppViewPath($package, $namespace = null)
|
||||||
|
{
|
||||||
|
return $this->app['path'] . "/views/packages/{$package}";
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,52 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Listeners;
|
|
||||||
|
|
||||||
use Illuminate\Console\Events\CommandFinished;
|
|
||||||
use Illuminate\Contracts\Config\Repository as Config;
|
|
||||||
use Illuminate\Contracts\Console\Kernel as Artisan;
|
|
||||||
|
|
||||||
class GenerateModelHelper
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Tracks whether we should run the models command on the CommandFinished event or not.
|
|
||||||
* Set to true by the MigrationsEnded event, needs to be cleared before artisan call to prevent infinite loop.
|
|
||||||
*
|
|
||||||
* @var bool
|
|
||||||
*/
|
|
||||||
public static $shouldRun = false;
|
|
||||||
|
|
||||||
/** @var Artisan */
|
|
||||||
protected $artisan;
|
|
||||||
|
|
||||||
/** @var Config */
|
|
||||||
protected $config;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param Artisan $artisan
|
|
||||||
* @param Config $config
|
|
||||||
*/
|
|
||||||
public function __construct(Artisan $artisan, Config $config)
|
|
||||||
{
|
|
||||||
$this->artisan = $artisan;
|
|
||||||
$this->config = $config;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Handle the event.
|
|
||||||
*
|
|
||||||
* @param CommandFinished $event
|
|
||||||
*/
|
|
||||||
public function handle(CommandFinished $event)
|
|
||||||
{
|
|
||||||
if (!self::$shouldRun) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
self::$shouldRun = false;
|
|
||||||
|
|
||||||
foreach ($this->config->get('ide-helper.post_migrate', []) as $command) {
|
|
||||||
$this->artisan->call($command, [], $event->output);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-141
@@ -1,141 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
|
||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
|
||||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
|
||||||
use Illuminate\Support\Collection;
|
|
||||||
|
|
||||||
class Macro extends Method
|
|
||||||
{
|
|
||||||
protected static $macroDefaults = [];
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Macro constructor.
|
|
||||||
*
|
|
||||||
* @param \ReflectionFunctionAbstract $method
|
|
||||||
* @param string $alias
|
|
||||||
* @param \ReflectionClass $class
|
|
||||||
* @param null $methodName
|
|
||||||
* @param array $interfaces
|
|
||||||
* @param array $classAliases
|
|
||||||
* @param array $returnTypeNormalizers
|
|
||||||
*/
|
|
||||||
public function __construct(
|
|
||||||
$method,
|
|
||||||
$alias,
|
|
||||||
$class,
|
|
||||||
$methodName = null,
|
|
||||||
$interfaces = [],
|
|
||||||
$classAliases = [],
|
|
||||||
$returnTypeNormalizers = []
|
|
||||||
) {
|
|
||||||
parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases, $returnTypeNormalizers);
|
|
||||||
}
|
|
||||||
|
|
||||||
public static function setDefaultReturnTypes(array $map = [])
|
|
||||||
{
|
|
||||||
static::$macroDefaults = array_merge(static::$macroDefaults, $map);
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* @param \ReflectionFunctionAbstract $method
|
|
||||||
*/
|
|
||||||
protected function initPhpDoc($method)
|
|
||||||
{
|
|
||||||
$this->phpdoc = new DocBlock($method);
|
|
||||||
|
|
||||||
$this->addLocationToPhpDoc();
|
|
||||||
|
|
||||||
// Add macro parameters if they are missed in original docblock
|
|
||||||
if (!$this->phpdoc->hasTag('param')) {
|
|
||||||
foreach ($method->getParameters() as $parameter) {
|
|
||||||
$reflectionType = $parameter->getType();
|
|
||||||
|
|
||||||
$type = $this->concatReflectionTypes($reflectionType);
|
|
||||||
|
|
||||||
/** @psalm-suppress UndefinedClass */
|
|
||||||
if ($reflectionType && !$reflectionType instanceof \ReflectionUnionType && $reflectionType->allowsNull()) {
|
|
||||||
$type .= '|null';
|
|
||||||
}
|
|
||||||
|
|
||||||
$type = $type ?: 'mixed';
|
|
||||||
|
|
||||||
$name = $parameter->isVariadic() ? '...' : '';
|
|
||||||
$name .= '$' . $parameter->getName();
|
|
||||||
|
|
||||||
$this->phpdoc->appendTag(Tag::createInstance("@param {$type} {$name}"));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add macro return type if it missed in original docblock
|
|
||||||
if ($method->hasReturnType() && !$this->phpdoc->hasTag('return')) {
|
|
||||||
$builder = EloquentBuilder::class;
|
|
||||||
$return = $method->getReturnType();
|
|
||||||
|
|
||||||
$type = $this->concatReflectionTypes($return);
|
|
||||||
|
|
||||||
/** @psalm-suppress UndefinedClass */
|
|
||||||
if (!$return instanceof \ReflectionUnionType) {
|
|
||||||
$type .= $this->root === "\\{$builder}" && $return->getName() === $builder ? '|static' : '';
|
|
||||||
$type .= $return->allowsNull() ? '|null' : '';
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
|
||||||
}
|
|
||||||
|
|
||||||
$class = ltrim($this->declaringClassName, '\\');
|
|
||||||
if (!$this->phpdoc->hasTag('return') && isset(static::$macroDefaults[$class])) {
|
|
||||||
$type = static::$macroDefaults[$class];
|
|
||||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function concatReflectionTypes(?\ReflectionType $type): string
|
|
||||||
{
|
|
||||||
/** @psalm-suppress UndefinedClass */
|
|
||||||
$returnTypes = $type instanceof \ReflectionUnionType
|
|
||||||
? $type->getTypes()
|
|
||||||
: [$type];
|
|
||||||
|
|
||||||
return Collection::make($returnTypes)
|
|
||||||
->filter()
|
|
||||||
->map->getName()
|
|
||||||
->implode('|');
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function addLocationToPhpDoc()
|
|
||||||
{
|
|
||||||
if ($this->method->name === '__invoke') {
|
|
||||||
$enclosingClass = $this->method->getDeclaringClass();
|
|
||||||
} else {
|
|
||||||
$enclosingClass = $this->method->getClosureScopeClass();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!$enclosingClass) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
/** @var \ReflectionMethod $enclosingMethod */
|
|
||||||
$enclosingMethod = Collection::make($enclosingClass->getMethods())
|
|
||||||
->first(function (\ReflectionMethod $method) {
|
|
||||||
return $method->getStartLine() <= $this->method->getStartLine()
|
|
||||||
&& $method->getEndLine() >= $this->method->getEndLine();
|
|
||||||
});
|
|
||||||
|
|
||||||
if ($enclosingMethod) {
|
|
||||||
$this->phpdoc->appendTag(Tag::createInstance(
|
|
||||||
'@see \\' . $enclosingClass->getName() . '::' . $enclosingMethod->getName() . '()'
|
|
||||||
));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param \ReflectionFunctionAbstract $method
|
|
||||||
* @param \ReflectionClass $class
|
|
||||||
*/
|
|
||||||
protected function initClassDefinedProperties($method, \ReflectionClass $class)
|
|
||||||
{
|
|
||||||
$this->namespace = $class->getNamespaceName();
|
|
||||||
$this->declaringClassName = '\\' . ltrim($class->name, '\\');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+114
-186
@@ -1,5 +1,4 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Laravel IDE Helper Generator
|
* Laravel IDE Helper Generator
|
||||||
*
|
*
|
||||||
@@ -11,96 +10,59 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
use phpDocumentor\Reflection\DocBlock;
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
use phpDocumentor\Reflection\DocBlock\Context;
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
use phpDocumentor\Reflection\DocBlock\Tag;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
|
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
|
|
||||||
|
|
||||||
class Method
|
class Method
|
||||||
{
|
{
|
||||||
/** @var DocBlock */
|
/** @var \phpDocumentor\Reflection\DocBlock */
|
||||||
protected $phpdoc;
|
protected $phpdoc;
|
||||||
|
|
||||||
/** @var \ReflectionMethod */
|
/** @var \ReflectionMethod */
|
||||||
protected $method;
|
protected $method;
|
||||||
|
|
||||||
protected $output = '';
|
|
||||||
protected $declaringClassName;
|
|
||||||
protected $name;
|
protected $name;
|
||||||
protected $namespace;
|
protected $namespace;
|
||||||
protected $params = [];
|
protected $params = array();
|
||||||
protected $params_with_default = [];
|
protected $params_with_default = array();
|
||||||
protected $interfaces = [];
|
protected $interfaces = array();
|
||||||
protected $real_name;
|
|
||||||
protected $return = null;
|
protected $return = null;
|
||||||
protected $root;
|
|
||||||
protected $classAliases;
|
|
||||||
protected $returnTypeNormalizers;
|
|
||||||
|
|
||||||
/** @var string[] */
|
|
||||||
protected $templateNames = [];
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
* @param \ReflectionMethod $method
|
||||||
* @param string $alias
|
* @param string $alias
|
||||||
* @param \ReflectionClass $class
|
* @param \ReflectionClass $class
|
||||||
* @param string|null $methodName
|
* @param string|null $methodName
|
||||||
* @param array $interfaces
|
* @param array $interfaces
|
||||||
* @param array $classAliases
|
|
||||||
* @param array $returnTypeNormalizers
|
|
||||||
* @param string[] $templateNames
|
|
||||||
*/
|
*/
|
||||||
public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = [], array $returnTypeNormalizers = [], array $templateNames = [])
|
public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array())
|
||||||
{
|
{
|
||||||
$this->method = $method;
|
$this->method = $method;
|
||||||
$this->interfaces = $interfaces;
|
$this->interfaces = $interfaces;
|
||||||
$this->classAliases = $classAliases;
|
|
||||||
$this->returnTypeNormalizers = $returnTypeNormalizers;
|
|
||||||
$this->name = $methodName ?: $method->name;
|
$this->name = $methodName ?: $method->name;
|
||||||
$this->real_name = $method->isClosure() ? $this->name : $method->name;
|
$declaringClass = $method->getDeclaringClass();
|
||||||
$this->templateNames = $templateNames;
|
$this->namespace = $declaringClass->getNamespaceName();
|
||||||
$this->initClassDefinedProperties($method, $class);
|
|
||||||
|
|
||||||
//Reference the 'real' function in the declaring class
|
|
||||||
$this->root = '\\' . ltrim($method->name === '__invoke' ? $method->getDeclaringClass()->getName() : $class->getName(), '\\');
|
|
||||||
|
|
||||||
//Create a DocBlock and serializer instance
|
//Create a DocBlock and serializer instance
|
||||||
$this->initPhpDoc($method);
|
$this->phpdoc = new DocBlock($method, new Context($this->namespace, static::getUseStatements($declaringClass)));
|
||||||
|
|
||||||
//Normalize the description and inherit the docs from parents/interfaces
|
//Normalize the description and inherit the docs from parents/interfaces
|
||||||
try {
|
try {
|
||||||
$this->normalizeParams($this->phpdoc);
|
$this->normalizeReturnTags($this->phpdoc);
|
||||||
$this->normalizeReturn($this->phpdoc);
|
|
||||||
$this->normalizeDescription($this->phpdoc);
|
$this->normalizeDescription($this->phpdoc);
|
||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {}
|
||||||
}
|
|
||||||
|
|
||||||
//Get the parameters, including formatted default values
|
//Get the parameters, including formatted default values
|
||||||
$this->getParameters($method);
|
$this->getParameters($method);
|
||||||
|
|
||||||
//Make the method static
|
//Make the method static
|
||||||
$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
|
//$this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
//Reference the 'real' function in the declaringClass
|
||||||
* @param \ReflectionMethod $method
|
|
||||||
*/
|
|
||||||
protected function initPhpDoc($method)
|
|
||||||
{
|
|
||||||
$this->phpdoc = new DocBlock($method, new Context($this->namespace, $this->classAliases, generics: $this->templateNames));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param \ReflectionMethod $method
|
|
||||||
* @param \ReflectionClass $class
|
|
||||||
*/
|
|
||||||
protected function initClassDefinedProperties($method, \ReflectionClass $class)
|
|
||||||
{
|
|
||||||
$declaringClass = $method->getDeclaringClass();
|
|
||||||
$this->namespace = $declaringClass->getNamespaceName();
|
|
||||||
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
|
$this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
|
||||||
|
$this->root = '\\' . ltrim($class->getName(), '\\');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -123,36 +85,21 @@ class Method
|
|||||||
return $this->root;
|
return $this->root;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @return bool
|
|
||||||
*/
|
|
||||||
public function isInstanceCall()
|
|
||||||
{
|
|
||||||
return !($this->method->isClosure() || $this->method->isStatic());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getRootMethodCall()
|
|
||||||
{
|
|
||||||
if ($this->isInstanceCall()) {
|
|
||||||
return "\$instance->{$this->getRealName()}({$this->getParams()})";
|
|
||||||
} else {
|
|
||||||
return "{$this->getRoot()}::{$this->getRealName()}({$this->getParams()})";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the docblock for this method
|
* Get the docblock for this method
|
||||||
*
|
*
|
||||||
* @param string $prefix
|
* @param string $prefix
|
||||||
* @return mixed
|
* @param bool $trim
|
||||||
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getDocComment($prefix = "\t\t")
|
public function getDocComment($prefix = "\t\t", $trim = false)
|
||||||
{
|
{
|
||||||
$serializer = new DocBlockSerializer(1, $prefix);
|
$serializer = new DocBlock\Serializer(1, $prefix);
|
||||||
return $serializer->getDocComment($this->phpdoc);
|
$str = $serializer->getDocComment($this->phpdoc);
|
||||||
|
if ($trim) {
|
||||||
|
$str = preg_replace(array('/\s+$/m', '#^(\s*/\*\*[\r\n])(?:\s*\*[\r\n])+#u', '#(?:[\r\n]\s*\*)+([\r\n]\s*\*/)$#u'), array('', '$1', '$1'), $str);
|
||||||
|
}
|
||||||
|
return $str;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -166,50 +113,41 @@ class Method
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the real method name
|
* Checks whether the method is deprecated
|
||||||
*
|
*
|
||||||
* @return string
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function getRealName()
|
public function isDeprecated()
|
||||||
{
|
{
|
||||||
return $this->real_name;
|
return $this->phpdoc->hasTag('deprecated');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the declared parameters for this method
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function getDocParams()
|
||||||
|
{
|
||||||
|
return $this->phpdoc->getTagsByName('param');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the parameters for this method
|
* Get the parameters for this method
|
||||||
*
|
*
|
||||||
* @param bool $implode Whether to implode the array or not
|
* @param bool $implode Whether to implode the array or not
|
||||||
* @return string
|
* @return string|array
|
||||||
*/
|
*/
|
||||||
public function getParams($implode = true)
|
public function getParams($implode = true)
|
||||||
{
|
{
|
||||||
return $implode ? implode(', ', $this->params) : $this->params;
|
return $implode ? implode(', ', $this->params) : $this->params;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param DocBlock|null $phpdoc
|
|
||||||
* @return ReturnTag|null
|
|
||||||
*/
|
|
||||||
public function getReturnTag($phpdoc = null)
|
|
||||||
{
|
|
||||||
if ($phpdoc === null) {
|
|
||||||
$phpdoc = $this->phpdoc;
|
|
||||||
}
|
|
||||||
|
|
||||||
$returnTags = $phpdoc->getTagsByName('return');
|
|
||||||
|
|
||||||
if (count($returnTags) === 0) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return reset($returnTags);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the parameters for this method including default values
|
* Get the parameters for this method including default values
|
||||||
*
|
*
|
||||||
* @param bool $implode Whether to implode the array or not
|
* @param bool $implode Whether to implode the array or not
|
||||||
* @return string
|
* @return string|array
|
||||||
*/
|
*/
|
||||||
public function getParamsWithDefault($implode = true)
|
public function getParamsWithDefault($implode = true)
|
||||||
{
|
{
|
||||||
@@ -227,85 +165,59 @@ class Method
|
|||||||
$description = $phpdoc->getText();
|
$description = $phpdoc->getText();
|
||||||
|
|
||||||
//Loop through parents/interfaces, to fill in {@inheritdoc}
|
//Loop through parents/interfaces, to fill in {@inheritdoc}
|
||||||
if (strpos($description, '{@inheritdoc}') !== false) {
|
if (stripos($description, '{@inheritdoc}') !== false && ($inheritdoc = $this->getInheritDoc($this->method))) {
|
||||||
$inheritdoc = $this->getInheritDoc($this->method);
|
|
||||||
$inheritDescription = $inheritdoc->getText();
|
$inheritDescription = $inheritdoc->getText();
|
||||||
|
|
||||||
$description = str_replace('{@inheritdoc}', $inheritDescription, $description);
|
$description = str_ireplace('{@inheritdoc}', $inheritDescription, $description);
|
||||||
$phpdoc->setText($description);
|
$phpdoc->setText($description);
|
||||||
|
|
||||||
$this->normalizeParams($inheritdoc);
|
$this->normalizeReturnTags($inheritdoc);
|
||||||
$this->normalizeReturn($inheritdoc);
|
|
||||||
|
|
||||||
//Add the tags that are inherited
|
//Add the tags that are inherited
|
||||||
$inheritTags = $inheritdoc->getTags();
|
foreach ($inheritdoc->getTags() as $tag) {
|
||||||
if ($inheritTags) {
|
$tag->setDocBlock();
|
||||||
/** @var Tag $tag */
|
$phpdoc->appendTag($tag);
|
||||||
foreach ($inheritTags as $tag) {
|
|
||||||
$tag->setDocBlock();
|
|
||||||
$phpdoc->appendTag($tag);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalize the parameters
|
* Normalize the return tag (make full namespace, replace interfaces)
|
||||||
*
|
*
|
||||||
* @param DocBlock $phpdoc
|
* @param DocBlock $phpdoc
|
||||||
*/
|
*/
|
||||||
protected function normalizeParams(DocBlock $phpdoc)
|
protected function normalizeReturnTags(DocBlock $phpdoc)
|
||||||
{
|
{
|
||||||
//Get the return type and adjust them for beter autocomplete
|
static $typeProp;
|
||||||
$paramTags = $phpdoc->getTagsByName('param');
|
if (!isset($typeProp)) {
|
||||||
if ($paramTags) {
|
$typeProp = new \ReflectionProperty('phpDocumentor\Reflection\DocBlock\Tag\ReturnTag', 'type');
|
||||||
/** @var ParamTag $tag */
|
$typeProp->setAccessible(true);
|
||||||
foreach ($paramTags as $tag) {
|
|
||||||
// Convert the keywords
|
|
||||||
$content = $this->convertKeywords($tag->getContent());
|
|
||||||
$tag->setContent($content);
|
|
||||||
|
|
||||||
// Get the expanded type and re-set the content
|
|
||||||
$content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription();
|
|
||||||
$tag->setContent(trim($content));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
$this->return = null;
|
||||||
* Normalize the return tag (make full namespace, replace interfaces, resolve $this)
|
|
||||||
*
|
|
||||||
* @param DocBlock $phpdoc
|
|
||||||
*/
|
|
||||||
protected function normalizeReturn(DocBlock $phpdoc)
|
|
||||||
{
|
|
||||||
//Get the return type and adjust them for better autocomplete
|
//Get the return type and adjust them for better autocomplete
|
||||||
$tag = $this->getReturnTag($phpdoc);
|
foreach ($phpdoc->getTags() as $tag) {
|
||||||
|
if ($tag instanceof ReturnTag) {
|
||||||
|
// Convert the keywords
|
||||||
|
$typeValue = static::convertKeywords($typeProp->getValue($tag));
|
||||||
|
$typeProp->setValue($tag, $typeValue);
|
||||||
|
|
||||||
if ($tag === null) {
|
// Get the expanded type
|
||||||
$this->return = null;
|
$typeValue = $tag->getType();
|
||||||
return;
|
|
||||||
|
// Replace the interfaces
|
||||||
|
if (preg_match('/\bReturnTag$/', get_class($tag))) {
|
||||||
|
foreach ($this->interfaces as $interface => $real) {
|
||||||
|
$typeValue = preg_replace('/(^|\|)' . preg_quote($interface, '/') . '\b/', $real, $typeValue);
|
||||||
|
}
|
||||||
|
$this->return = $typeValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Re-set the type
|
||||||
|
$typeProp->setValue($tag, $typeValue);
|
||||||
|
$tag->setDescription($tag->getDescription());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get the expanded type
|
|
||||||
$returnValue = $tag->getType();
|
|
||||||
|
|
||||||
if (array_key_exists($returnValue, $this->returnTypeNormalizers)) {
|
|
||||||
$returnValue = $this->returnTypeNormalizers[$returnValue];
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($returnValue === '$this') {
|
|
||||||
$returnValue = $this->root;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Replace the interfaces
|
|
||||||
foreach ($this->interfaces as $interface => $real) {
|
|
||||||
$returnValue = str_replace($interface, $real, $returnValue);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set the changed content
|
|
||||||
$tag->setContent($returnValue . ' ' . $tag->getDescription());
|
|
||||||
$this->return = $returnValue;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -314,24 +226,29 @@ class Method
|
|||||||
* @param string $string
|
* @param string $string
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
protected function convertKeywords($string)
|
protected static function convertKeywords($string)
|
||||||
{
|
{
|
||||||
$string = str_replace('\Closure', 'Closure', $string);
|
$types = explode('|', $string);
|
||||||
$string = str_replace('Closure', '\Closure', $string);
|
foreach ($types as &$type) {
|
||||||
$string = str_replace('dynamic', 'mixed', $string);
|
if ($type === 'Closure')
|
||||||
|
$type = '\Closure';
|
||||||
return $string;
|
elseif ($type === 'dynamic')
|
||||||
|
$type = 'mixed';
|
||||||
|
elseif (strrpos($type, '\\') && $type[0] !== '\\' && (class_exists($type) || interface_exists($type)))
|
||||||
|
$type = '\\' . $type;
|
||||||
|
}
|
||||||
|
return implode('|', $types);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Should the function return a value?
|
* Should the function return a value?
|
||||||
*
|
*
|
||||||
* @return bool
|
* @return bool|int
|
||||||
*/
|
*/
|
||||||
public function shouldReturn()
|
public function shouldReturn()
|
||||||
{
|
{
|
||||||
if ($this->return !== 'void' && $this->method->name !== '__construct') {
|
if ($this->return !== 'void' && $this->method->name !== '__construct') {
|
||||||
return true;
|
return isset($this->return) ? true : 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
return false;
|
return false;
|
||||||
@@ -340,34 +257,35 @@ class Method
|
|||||||
/**
|
/**
|
||||||
* Get the parameters and format them correctly
|
* Get the parameters and format them correctly
|
||||||
*
|
*
|
||||||
* @param \ReflectionMethod $method
|
* @param \ReflectionMethod $method
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function getParameters($method)
|
public function getParameters($method)
|
||||||
{
|
{
|
||||||
//Loop through the default values for parameters, and make the correct output string
|
//Loop through the default values for parameters, and make the correct output string
|
||||||
$params = [];
|
$params = array();
|
||||||
$paramsWithDefault = [];
|
$paramsWithDefault = array();
|
||||||
|
|
||||||
foreach ($method->getParameters() as $param) {
|
foreach ($method->getParameters() as $param) {
|
||||||
$paramStr = $param->isVariadic() ? '...$' . $param->getName() : '$' . $param->getName();
|
$paramStr = '$' . $param->getName();
|
||||||
$params[] = $paramStr;
|
$params[] = $paramStr;
|
||||||
if ($param->isOptional() && !$param->isVariadic()) {
|
|
||||||
|
if ($param->isOptional()) {
|
||||||
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
|
$default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
|
||||||
if (is_bool($default)) {
|
if (is_bool($default)) {
|
||||||
$default = $default ? 'true' : 'false';
|
$default = $default ? 'true' : 'false';
|
||||||
} elseif (is_array($default)) {
|
} elseif (is_array($default)) {
|
||||||
$default = '[]';
|
$default = 'array()';
|
||||||
} elseif (is_null($default)) {
|
} elseif (is_null($default)) {
|
||||||
$default = 'null';
|
$default = 'null';
|
||||||
} elseif (is_int($default)) {
|
} elseif (is_int($default)) {
|
||||||
//$default = $default;
|
//$default = $default;
|
||||||
} elseif (is_resource($default)) {
|
|
||||||
//skip to not fail
|
|
||||||
} else {
|
} else {
|
||||||
$default = var_export($default, true);
|
$default = "'" . trim($default) . "'";
|
||||||
}
|
}
|
||||||
$paramStr .= " = $default";
|
$paramStr .= " = $default";
|
||||||
}
|
}
|
||||||
|
|
||||||
$paramsWithDefault[] = $paramStr;
|
$paramsWithDefault[] = $paramStr;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -377,7 +295,7 @@ class Method
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod $reflectionMethod
|
* @param \ReflectionMethod $reflectionMethod
|
||||||
* @return DocBlock
|
* @return DocBlock|null
|
||||||
*/
|
*/
|
||||||
protected function getInheritDoc($reflectionMethod)
|
protected function getInheritDoc($reflectionMethod)
|
||||||
{
|
{
|
||||||
@@ -391,14 +309,24 @@ class Method
|
|||||||
}
|
}
|
||||||
if ($method) {
|
if ($method) {
|
||||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
$phpdoc = new DocBlock($method, new Context($namespace, $this->classAliases, generics: $this->templateNames));
|
$phpdoc = new DocBlock($method, new Context($namespace, static::getUseStatements($method->getDeclaringClass())));
|
||||||
|
|
||||||
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
if (stripos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
||||||
//Not at the end yet, try another parent/interface..
|
//Not at the end yet, try another parent/interface..
|
||||||
return $this->getInheritDoc($method);
|
return $this->getInheritDoc($method);
|
||||||
|
} else {
|
||||||
|
return $phpdoc;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
return $phpdoc;
|
protected static function getUseStatements(\ReflectionClass $class)
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
return PhpReflection::getUseStatements($class);
|
||||||
|
} catch (\Exception $e) {
|
||||||
|
return array();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,79 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Parsers;
|
|
||||||
|
|
||||||
class PhpDocReturnTypeParser
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
private string $typeAlias;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @var array
|
|
||||||
*/
|
|
||||||
private array $namespaceAliases;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string $typeAlias
|
|
||||||
* @param array $namespaceAliases
|
|
||||||
*/
|
|
||||||
public function __construct(string $typeAlias, array $namespaceAliases)
|
|
||||||
{
|
|
||||||
$this->typeAlias = $typeAlias;
|
|
||||||
$this->namespaceAliases = $namespaceAliases;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return string|null
|
|
||||||
*/
|
|
||||||
public function parse(): string|null
|
|
||||||
{
|
|
||||||
$matches = [];
|
|
||||||
preg_match('/(\w+)(<.*>)/', $this->typeAlias, $matches);
|
|
||||||
$matchCount = count($matches);
|
|
||||||
|
|
||||||
if ($matchCount === 0 || $matchCount === 1) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (empty($this->namespaceAliases[$matches[1]])) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $this->namespaceAliases[$matches[1]] . $this->parseTemplate($matches[2] ?? null);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string|null $template
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
private function parseTemplate(string|null $template): string
|
|
||||||
{
|
|
||||||
if ($template === null || $template === '') {
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
$type = '';
|
|
||||||
$result = '';
|
|
||||||
|
|
||||||
foreach (str_split($template) as $char) {
|
|
||||||
$match = preg_match('/[A-z]/', $char);
|
|
||||||
|
|
||||||
if (!$match) {
|
|
||||||
$type = $this->namespaceAliases[$type] ?? $type;
|
|
||||||
$result .= $type;
|
|
||||||
$result .= $char;
|
|
||||||
$type = '';
|
|
||||||
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
$type .= $char;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $result;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
<?php namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PHP reflection helpers.
|
||||||
|
*
|
||||||
|
* This file is part of the Nette Framework (https://nette.org)
|
||||||
|
* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
|
||||||
|
*
|
||||||
|
* @see https://github.com/nette/di/blob/v2.4/src/DI/PhpReflection.php
|
||||||
|
*/
|
||||||
|
class PhpReflection
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Expands class name into full name.
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
* @param \ReflectionClass $rc
|
||||||
|
* @return string full name
|
||||||
|
* @throws \InvalidArgumentException
|
||||||
|
*/
|
||||||
|
public static function expandClassName($name, \ReflectionClass $rc)
|
||||||
|
{
|
||||||
|
$lower = strtolower($name);
|
||||||
|
if (empty($name)) {
|
||||||
|
throw new \InvalidArgumentException('Class name must not be empty.');
|
||||||
|
} elseif (self::isBuiltinType($lower)) {
|
||||||
|
return $lower;
|
||||||
|
} elseif ($lower === 'self' || $lower === 'static' || $lower === '$this') {
|
||||||
|
return $rc->getName();
|
||||||
|
} elseif ($name[0] === '\\') { // fully qualified name
|
||||||
|
return ltrim($name, '\\');
|
||||||
|
}
|
||||||
|
|
||||||
|
$uses = self::getUseStatements($rc);
|
||||||
|
$parts = explode('\\', $name, 2);
|
||||||
|
if (isset($uses[$parts[0]])) {
|
||||||
|
$parts[0] = $uses[$parts[0]];
|
||||||
|
return implode('\\', $parts);
|
||||||
|
} elseif ($rc->inNamespace()) {
|
||||||
|
return $rc->getNamespaceName() . '\\' . $name;
|
||||||
|
} else {
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param \ReflectionClass
|
||||||
|
* @return array of [alias => class]
|
||||||
|
*/
|
||||||
|
public static function getUseStatements(\ReflectionClass $class)
|
||||||
|
{
|
||||||
|
static $cache = array();
|
||||||
|
if (!isset($cache[$name = $class->getName()])) {
|
||||||
|
if ($class->isInternal() || !($code = @file_get_contents($class->getFileName()))) {
|
||||||
|
$cache[$name] = array();
|
||||||
|
} else {
|
||||||
|
$cache = self::parseUseStatements($code, $name) + $cache;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $cache[$name];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public static function isBuiltinType($type)
|
||||||
|
{
|
||||||
|
return in_array(strtolower($type), array('string', 'int', 'float', 'bool', 'array', 'callable'), true);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses PHP code.
|
||||||
|
*
|
||||||
|
* @param string $code
|
||||||
|
* @param string $forClass
|
||||||
|
* @return array of [class => [alias => class, ...]]
|
||||||
|
*/
|
||||||
|
public static function parseUseStatements($code, $forClass = null)
|
||||||
|
{
|
||||||
|
$tokens = token_get_all($code);
|
||||||
|
$namespace = $class = $classLevel = $level = null;
|
||||||
|
$res = $uses = array();
|
||||||
|
|
||||||
|
while ($token = current($tokens)) {
|
||||||
|
next($tokens);
|
||||||
|
switch (is_array($token) ? $token[0] : $token) {
|
||||||
|
case T_NAMESPACE:
|
||||||
|
$namespace = ltrim(self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR)) . '\\', '\\');
|
||||||
|
$uses = array();
|
||||||
|
break;
|
||||||
|
|
||||||
|
case T_CLASS:
|
||||||
|
case T_INTERFACE:
|
||||||
|
case PHP_VERSION_ID < 50400 ? -1 : T_TRAIT:
|
||||||
|
if ($name = self::fetch($tokens, T_STRING)) {
|
||||||
|
$class = $namespace . $name;
|
||||||
|
$classLevel = $level + 1;
|
||||||
|
$res[$class] = $uses;
|
||||||
|
if ($class === $forClass) {
|
||||||
|
return $res;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case T_USE:
|
||||||
|
while (!$class && ($name = self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR)))) {
|
||||||
|
$name = ltrim($name, '\\');
|
||||||
|
if (self::fetch($tokens, '{')) {
|
||||||
|
while ($suffix = self::fetch($tokens, array(T_STRING, T_NS_SEPARATOR))) {
|
||||||
|
if (self::fetch($tokens, T_AS)) {
|
||||||
|
$uses[self::fetch($tokens, T_STRING)] = $name . $suffix;
|
||||||
|
} else {
|
||||||
|
$tmp = explode('\\', $suffix);
|
||||||
|
$uses[end($tmp)] = $name . $suffix;
|
||||||
|
}
|
||||||
|
if (!self::fetch($tokens, ',')) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
} elseif (self::fetch($tokens, T_AS)) {
|
||||||
|
$uses[self::fetch($tokens, T_STRING)] = $name;
|
||||||
|
|
||||||
|
} else {
|
||||||
|
$tmp = explode('\\', $name);
|
||||||
|
$uses[end($tmp)] = $name;
|
||||||
|
}
|
||||||
|
if (!self::fetch($tokens, ',')) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case T_CURLY_OPEN:
|
||||||
|
case T_DOLLAR_OPEN_CURLY_BRACES:
|
||||||
|
case '{':
|
||||||
|
$level++;
|
||||||
|
break;
|
||||||
|
|
||||||
|
case '}':
|
||||||
|
if ($level === $classLevel) {
|
||||||
|
$class = $classLevel = null;
|
||||||
|
}
|
||||||
|
$level--;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $res;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static function fetch(&$tokens, $take)
|
||||||
|
{
|
||||||
|
$res = null;
|
||||||
|
while ($token = current($tokens)) {
|
||||||
|
list($token, $s) = is_array($token) ? $token : array($token, $token);
|
||||||
|
if (in_array($token, (array)$take, true)) {
|
||||||
|
$res .= $s;
|
||||||
|
} elseif (!in_array($token, array(T_DOC_COMMENT, T_WHITESPACE, T_COMMENT), true)) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
next($tokens);
|
||||||
|
}
|
||||||
|
return $res;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Config;
|
||||||
|
|
||||||
|
return array(
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Filename & Format
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| The default filename (without extension) and the format (php or json)
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'filename' => '_ide_helper',
|
||||||
|
'format' => 'php',
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Helper files to include
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Include helper files. By default not included, but can be toggled with the
|
||||||
|
| -- helpers (-H) option. Extra helper files can be included.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'include_helpers' => false,
|
||||||
|
|
||||||
|
'helper_files' => array(
|
||||||
|
base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
||||||
|
),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Model locations to include
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Define in which directories the ide-helper:models command should look
|
||||||
|
| for models.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'model_locations' => array(
|
||||||
|
'app/models',
|
||||||
|
),
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Extra classes
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| These implementations are not really extended, but called with magic functions
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'extra' => array(
|
||||||
|
'Artisan' => array('Illuminate\Foundation\Artisan'),
|
||||||
|
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
|
||||||
|
'Session' => array('Illuminate\Session\Store'),
|
||||||
|
),
|
||||||
|
|
||||||
|
'magic' => array(
|
||||||
|
'Log' => array(
|
||||||
|
'debug' => 'Monolog\Logger::addDebug',
|
||||||
|
'info' => 'Monolog\Logger::addInfo',
|
||||||
|
'notice' => 'Monolog\Logger::addNotice',
|
||||||
|
'warning' => 'Monolog\Logger::addWarning',
|
||||||
|
'error' => 'Monolog\Logger::addError',
|
||||||
|
'critical' => 'Monolog\Logger::addCritical',
|
||||||
|
'alert' => 'Monolog\Logger::addAlert',
|
||||||
|
'emergency' => 'Monolog\Logger::addEmergency',
|
||||||
|
)
|
||||||
|
),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Interface implementations
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| These interfaces will be replaced with the implementing class. Some interfaces
|
||||||
|
| are detected by the helpers, others can be listed below.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'interfaces' => array(
|
||||||
|
'\Illuminate\Auth\UserInterface' => Config::get('auth.model', 'User'),
|
||||||
|
)
|
||||||
|
|
||||||
|
);
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<?= '<?php' ?>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An helper file for Laravel 4, to provide autocomplete information to your IDE
|
||||||
|
* Generated for Laravel <?= $version ?> on <?= date('Y-m-d') ?>.
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||||
|
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
|
||||||
|
<?php foreach ($namespaces as $namespace => $aliases/* @var \Barryvdh\LaravelIdeHelper\Alias[] $aliases */): ?>
|
||||||
|
namespace <?= $namespace == '__root' ? '' : $namespace ?>{
|
||||||
|
<?php if ($namespace == '__root'): ?>
|
||||||
|
exit('This file should not be included, only analyzed by your IDE');
|
||||||
|
<?= $helpers ?>
|
||||||
|
<?php endif; ?>
|
||||||
|
<?php foreach ($aliases as $alias): ?>
|
||||||
|
|
||||||
|
<?php if (($cBase = class_basename($alias->getExtends())) != $alias->getExtends() && $cBase != $alias->getShortName()): ?>
|
||||||
|
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
|
||||||
|
<?php endif; ?>
|
||||||
|
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> <?= $alias->getExtends() ? 'extends ' . $alias->getExtends() : '' ?>{
|
||||||
|
<?php foreach ($alias->getMethods() as $method): ?>
|
||||||
|
|
||||||
|
<?php if (($nParams = count($method->getDocParams())) > count($mParams = $method->getParamsWithDefault(false))): ?>
|
||||||
|
/** @noinspection PhpDocSignatureInspection */
|
||||||
|
<?php endif; ?>
|
||||||
|
<?php if ($docComment = str_replace("/**\n\t\t */", '', trim($method->getDocComment("\t\t", true)))): ?>
|
||||||
|
<?= $docComment ?>
|
||||||
|
|
||||||
|
<?php endif; ?>
|
||||||
|
public static function <?= $method->getName() ?>(<?= ($docComment && $nParams < count($mParams)) ? '/** @noinspection PhpDocSignatureInspection */' . implode(', /** @noinspection PhpDocSignatureInspection */', $mParams) : $method->getParamsWithDefault() ?>){
|
||||||
|
<?php if ($method->getDeclaringClass() !== $method->getRoot()): ?>
|
||||||
|
//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||||
|
|
||||||
|
<?php endif; ?>
|
||||||
|
/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection,PhpDynamicAsStaticMethodCallInspection<?= ($method->shouldReturn() === 1 ? ',PhpVoidFunctionResultUsedInspection' : '') . ($method->isDeprecated() ? ',PhpDeprecationInspection' : '') ?> */
|
||||||
|
<?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
|
||||||
|
}
|
||||||
|
<?php endforeach; ?>
|
||||||
|
|
||||||
|
}
|
||||||
|
<?php endforeach; ?>
|
||||||
|
|
||||||
|
}
|
||||||
|
<?php endforeach; ?>
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
<?= '<?php' ?> namespace PHPSTORM_META {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PhpStorm Meta file, to provide autocomplete information for PhpStorm
|
||||||
|
* Generated on <?= date('Y-m-d') ?>.
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
||||||
|
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** @noinspection PhpIllegalArrayKeyTypeInspection,PhpUnusedLocalVariableInspection,PhpUnnecessaryFullyQualifiedNameInspection */
|
||||||
|
$STATIC_METHOD_TYPES = array(
|
||||||
|
<?php foreach ($methods as $method): ?>
|
||||||
|
<?= strpos($method, 'new ') === 0 ? $method : $method . '(\'\')' ?> => array(
|
||||||
|
<?php foreach ($bindings as $abstract => $class): ?>
|
||||||
|
<?= var_export($abstract, true) ?> instanceof \<?= $class ?>,
|
||||||
|
<?php endforeach ?>
|
||||||
|
),
|
||||||
|
<?php endforeach ?>
|
||||||
|
);
|
||||||
|
|
||||||
|
}
|
||||||
@@ -1,160 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Alias;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Macro;
|
|
||||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
|
||||||
use Illuminate\Database\Query\Builder;
|
|
||||||
use Illuminate\Support\Arr;
|
|
||||||
use Illuminate\Support\Facades\Facade;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @internal
|
|
||||||
* @coversDefaultClass \Barryvdh\LaravelIdeHelper\Alias
|
|
||||||
*/
|
|
||||||
class AliasTest extends TestCase
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* @covers ::detectMethods
|
|
||||||
*/
|
|
||||||
public function testDetectMethodsMacroableMacros(): void
|
|
||||||
{
|
|
||||||
// Mock
|
|
||||||
$macro = __FUNCTION__;
|
|
||||||
$alias = new AliasMock();
|
|
||||||
|
|
||||||
// Macros
|
|
||||||
Builder::macro(
|
|
||||||
$macro,
|
|
||||||
function () {
|
|
||||||
// empty
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
// Prepare
|
|
||||||
$alias->setClasses([Builder::class]);
|
|
||||||
$alias->detectMethods();
|
|
||||||
|
|
||||||
// Test
|
|
||||||
$this->assertNotNull($this->getAliasMacro($alias, Builder::class, $macro));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @covers ::detectMethods
|
|
||||||
*/
|
|
||||||
public function testDetectMethodsEloquentBuilderMacros(): void
|
|
||||||
{
|
|
||||||
// Mock
|
|
||||||
$macro = __FUNCTION__;
|
|
||||||
$alias = new AliasMock();
|
|
||||||
|
|
||||||
// Macros
|
|
||||||
EloquentBuilder::macro(
|
|
||||||
$macro,
|
|
||||||
function () {
|
|
||||||
// empty
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
// Prepare
|
|
||||||
$alias->setClasses([EloquentBuilder::class]);
|
|
||||||
$alias->detectMethods();
|
|
||||||
|
|
||||||
// Test
|
|
||||||
$this->assertNotNull($this->getAliasMacro($alias, EloquentBuilder::class, $macro));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @covers ::detectFake
|
|
||||||
*/
|
|
||||||
public function testNoExceptionOnRequiredFakeParameters(): void
|
|
||||||
{
|
|
||||||
// Mock
|
|
||||||
$alias = new AliasMock();
|
|
||||||
|
|
||||||
// Prepare
|
|
||||||
$alias->setFacade(MockFacade::class);
|
|
||||||
$this->expectNotToPerformAssertions();
|
|
||||||
|
|
||||||
// Test
|
|
||||||
$alias->detectFake();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @covers ::detectTemplateNames
|
|
||||||
*/
|
|
||||||
public function testTemplateNamesAreDetected(): void
|
|
||||||
{
|
|
||||||
// Mock
|
|
||||||
$alias = new AliasMock();
|
|
||||||
|
|
||||||
// Prepare
|
|
||||||
$alias->setClasses([EloquentBuilder::class]);
|
|
||||||
|
|
||||||
// Test
|
|
||||||
$this->assertSame(['TModel', 'TValue'], $alias->getTemplateNames());
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function getAliasMacro(Alias $alias, string $class, string $method): ?Macro
|
|
||||||
{
|
|
||||||
return Arr::first(
|
|
||||||
$alias->getMethods(),
|
|
||||||
function ($macro) use ($class, $method) {
|
|
||||||
return $macro instanceof Macro
|
|
||||||
&& $macro->getDeclaringClass() === "\\{$class}"
|
|
||||||
&& $macro->getName() === $method;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @internal
|
|
||||||
* @noinspection PhpMultipleClassesDeclarationsInOneFile
|
|
||||||
* @template TValue
|
|
||||||
*/
|
|
||||||
class AliasMock extends Alias
|
|
||||||
{
|
|
||||||
public function __construct()
|
|
||||||
{
|
|
||||||
// no need to call parent
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string[] $classes
|
|
||||||
*/
|
|
||||||
public function setClasses(array $classes)
|
|
||||||
{
|
|
||||||
$this->classes = $classes;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function detectMethods()
|
|
||||||
{
|
|
||||||
parent::detectMethods();
|
|
||||||
}
|
|
||||||
|
|
||||||
public function detectFake()
|
|
||||||
{
|
|
||||||
parent::detectFake();
|
|
||||||
}
|
|
||||||
|
|
||||||
public function setFacade(string $facade)
|
|
||||||
{
|
|
||||||
$this->facade = $facade;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class MockFacade extends Facade
|
|
||||||
{
|
|
||||||
protected static function getFacadeAccessor()
|
|
||||||
{
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
public static function fake(string $test1, $test2 = null)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\EloquentCommand;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
use Illuminate\Filesystem\Filesystem;
|
|
||||||
use Mockery;
|
|
||||||
use ReflectionClass;
|
|
||||||
|
|
||||||
class EloquentCommandTest extends TestCase
|
|
||||||
{
|
|
||||||
public function testCommand()
|
|
||||||
{
|
|
||||||
$modelFilename = $this->getVendorModelFilename();
|
|
||||||
$modelSource = file_get_contents($modelFilename);
|
|
||||||
if (false !== strpos($modelSource, '* @mixin')) {
|
|
||||||
$msg = sprintf('Class %s already contains the @mixin markers', Model::class);
|
|
||||||
$this->markTestSkipped($msg);
|
|
||||||
}
|
|
||||||
|
|
||||||
$actualContent = null;
|
|
||||||
$mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
|
|
||||||
$mockFilesystem
|
|
||||||
->shouldReceive('get')
|
|
||||||
// We don't care about actual args (filename)
|
|
||||||
->andReturn('abstract class Model implements'); // This is enough to trigger the replacement logic
|
|
||||||
$mockFilesystem
|
|
||||||
->shouldReceive('put')
|
|
||||||
->with(
|
|
||||||
Mockery::any(), // First arg is path, we don't care
|
|
||||||
Mockery::capture($actualContent)
|
|
||||||
)
|
|
||||||
->andReturn(1) // Simulate we wrote _something_ to the file
|
|
||||||
->once();
|
|
||||||
|
|
||||||
$this->instance(Filesystem::class, $mockFilesystem);
|
|
||||||
$command = $this->app->make(EloquentCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command);
|
|
||||||
|
|
||||||
$this->assertMatchesTxtSnapshot($actualContent);
|
|
||||||
|
|
||||||
$display = $tester->getDisplay();
|
|
||||||
$this->assertMatchesRegularExpression(
|
|
||||||
';Unexpected no document on Illuminate\\\Database\\\Eloquent\\\Model;',
|
|
||||||
$display
|
|
||||||
);
|
|
||||||
$modelClassFilePath = preg_quote(
|
|
||||||
str_replace('/', DIRECTORY_SEPARATOR, '/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php')
|
|
||||||
);
|
|
||||||
$this->assertMatchesRegularExpression(
|
|
||||||
';Wrote expected docblock to .*' . $modelClassFilePath . ';',
|
|
||||||
$display
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private function getVendorModelFilename(): string
|
|
||||||
{
|
|
||||||
$class = Model::class;
|
|
||||||
$reflectedClass = new ReflectionClass($class);
|
|
||||||
|
|
||||||
return $reflectedClass->getFileName();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
|
||||||
|
|
||||||
abstract class AbstractGeneratorCommand extends TestCase
|
|
||||||
{
|
|
||||||
protected function setUp(): void
|
|
||||||
{
|
|
||||||
parent::setUp();
|
|
||||||
$this->mockFilesystem();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get package providers.
|
|
||||||
*
|
|
||||||
* @param \Illuminate\Foundation\Application $app
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
protected function getPackageProviders($app)
|
|
||||||
{
|
|
||||||
return [IdeHelperServiceProvider::class];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateEloquentOnly;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
|
||||||
|
|
||||||
class Test extends AbstractGeneratorCommand
|
|
||||||
{
|
|
||||||
public function testGenerator(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(GeneratorCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--eloquent' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
|
||||||
$this->assertStringNotContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
|
||||||
$this->assertStringContainsString('class Eloquent extends \Illuminate\Database\Eloquent\Model', $this->mockFilesystemOutput);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateIdeHelper;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
|
||||||
use Illuminate\Support\Arr;
|
|
||||||
use Illuminate\Support\Facades\DB;
|
|
||||||
|
|
||||||
class Test extends AbstractGeneratorCommand
|
|
||||||
{
|
|
||||||
public function testGenerator(): void
|
|
||||||
{
|
|
||||||
Arr::macro('arr_custom_macro', function () {
|
|
||||||
});
|
|
||||||
DB::macro('db_custom_macro', function () {
|
|
||||||
});
|
|
||||||
$this->app['config']->set('ide-helper.macro_default_return_types', [Arr::class => 'Custom_Fake_Class']);
|
|
||||||
|
|
||||||
$command = $this->app->make(GeneratorCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
|
|
||||||
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
|
||||||
$this->assertStringContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
|
||||||
$this->assertStringContainsString('* @return \Custom_Fake_Class', $this->mockFilesystemOutput);
|
|
||||||
$this->assertStringContainsString('public static function arr_custom_macro()', $this->mockFilesystemOutput);
|
|
||||||
$this->assertStringContainsString('public static function db_custom_macro()', $this->mockFilesystemOutput);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testFilename(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(GeneratorCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'filename' => 'foo.php',
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('A new helper file was written to foo.php', $tester->getDisplay());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\MetaCommand;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
|
||||||
use Illuminate\Filesystem\Filesystem;
|
|
||||||
use Mockery\MockInterface;
|
|
||||||
use stdClass;
|
|
||||||
|
|
||||||
class MetaCommandTest extends TestCase
|
|
||||||
{
|
|
||||||
protected function setUp(): void
|
|
||||||
{
|
|
||||||
parent::setUp();
|
|
||||||
|
|
||||||
$this->mockFilesystem();
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testCommand(): void
|
|
||||||
{
|
|
||||||
/** @var Filesystem|MockInterface $mockFileSystem */
|
|
||||||
$mockFileSystem = $this->app->make(Filesystem::class);
|
|
||||||
$this->instance(Filesystem::class, $mockFileSystem);
|
|
||||||
|
|
||||||
$mockFileSystem
|
|
||||||
->shouldReceive('getRequire')
|
|
||||||
->andReturnUsing(function ($__path, $__data = []) {
|
|
||||||
return (static function () use ($__path, $__data) {
|
|
||||||
extract($__data, EXTR_SKIP);
|
|
||||||
|
|
||||||
return require $__path;
|
|
||||||
})();
|
|
||||||
});
|
|
||||||
|
|
||||||
$this->artisan('ide-helper:meta');
|
|
||||||
|
|
||||||
// We're not testing the whole file, just some basic structure elements
|
|
||||||
self::assertStringContainsString("namespace PHPSTORM_META {\n", $this->mockFilesystemOutput);
|
|
||||||
self::assertStringContainsString("PhpStorm Meta file, to provide autocomplete information for PhpStorm\n", $this->mockFilesystemOutput);
|
|
||||||
self::assertStringContainsString('override(', $this->mockFilesystemOutput);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testUnregisterAutoloader(): void
|
|
||||||
{
|
|
||||||
$current = spl_autoload_functions();
|
|
||||||
$appended = function () {
|
|
||||||
};
|
|
||||||
|
|
||||||
$this->app->bind('registers-autoloader', function () use ($appended) {
|
|
||||||
spl_autoload_register($appended);
|
|
||||||
return new stdClass();
|
|
||||||
});
|
|
||||||
|
|
||||||
/** @var Filesystem|MockInterface $mockFileSystem */
|
|
||||||
$mockFileSystem = $this->app->make(Filesystem::class);
|
|
||||||
$this->instance(Filesystem::class, $mockFileSystem);
|
|
||||||
|
|
||||||
$mockFileSystem
|
|
||||||
->shouldReceive('getRequire')
|
|
||||||
->andReturnUsing(function ($__path, $__data = []) {
|
|
||||||
return (static function () use ($__path, $__data) {
|
|
||||||
extract($__data, EXTR_SKIP);
|
|
||||||
|
|
||||||
return require $__path;
|
|
||||||
})();
|
|
||||||
});
|
|
||||||
|
|
||||||
$this->artisan('ide-helper:meta');
|
|
||||||
|
|
||||||
self::assertSame(array_merge($current, [$appended]), spl_autoload_functions());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get package providers.
|
|
||||||
*
|
|
||||||
* @param \Illuminate\Foundation\Application $app
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
protected function getPackageProviders($app)
|
|
||||||
{
|
|
||||||
return [IdeHelperServiceProvider::class];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
|
||||||
|
|
||||||
abstract class AbstractModelsCommand extends TestCase
|
|
||||||
{
|
|
||||||
protected function setUp(): void
|
|
||||||
{
|
|
||||||
parent::setUp();
|
|
||||||
|
|
||||||
$this->loadMigrationsFrom(__DIR__ . '/migrations');
|
|
||||||
$this->artisan('migrate');
|
|
||||||
$this->mockFilesystem();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get package providers.
|
|
||||||
*
|
|
||||||
* @param \Illuminate\Foundation\Application $app
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
protected function getPackageProviders($app)
|
|
||||||
{
|
|
||||||
return [IdeHelperServiceProvider::class];
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function getEnvironmentSetUp($app)
|
|
||||||
{
|
|
||||||
parent::getEnvironmentSetUp($app);
|
|
||||||
|
|
||||||
$config = $app['config'];
|
|
||||||
|
|
||||||
$config->set('database.default', 'sqlite');
|
|
||||||
$config->set('database.connections.sqlite', [
|
|
||||||
'driver' => 'sqlite',
|
|
||||||
'database' => ':memory:',
|
|
||||||
'prefix' => '',
|
|
||||||
]);
|
|
||||||
|
|
||||||
// Load the Models from the Test dir
|
|
||||||
$config->set('ide-helper.model_locations', [
|
|
||||||
dirname((new \ReflectionClass(static::class))->getFileName()) . '/Models',
|
|
||||||
]);
|
|
||||||
|
|
||||||
// Don't override integer -> int for tests
|
|
||||||
$config->set('ide-helper.type_overrides', []);
|
|
||||||
|
|
||||||
$config->set('ide-helper.write_model_relation_exists_properties', true);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections;
|
|
||||||
|
|
||||||
use Illuminate\Support\Collection;
|
|
||||||
|
|
||||||
class AdvancedCastCollection extends Collection
|
|
||||||
{
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections;
|
|
||||||
|
|
||||||
use Illuminate\Contracts\Support\Arrayable;
|
|
||||||
use JsonSerializable;
|
|
||||||
|
|
||||||
class AdvancedCastMap implements Arrayable, JsonSerializable
|
|
||||||
{
|
|
||||||
public function toArray(): array
|
|
||||||
{
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
public function jsonSerialize(): array
|
|
||||||
{
|
|
||||||
return $this->toArray();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums;
|
|
||||||
|
|
||||||
enum AdvancedCastEnum
|
|
||||||
{
|
|
||||||
case apple;
|
|
||||||
case banana;
|
|
||||||
case orange;
|
|
||||||
}
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastMap;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
|
||||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
|
||||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
|
||||||
use Illuminate\Database\Eloquent\Casts\AsEnumCollection;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
class AdvancedCast extends Model
|
|
||||||
{
|
|
||||||
protected function casts(): array
|
|
||||||
{
|
|
||||||
return [
|
|
||||||
'cast_to_date_serialization' => 'date:Y-m-d',
|
|
||||||
'cast_to_datetime_serialization' => 'datetime:Y-m-d H:i:s',
|
|
||||||
'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
|
|
||||||
'cast_to_immutable_date' => 'immutable_date',
|
|
||||||
'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
|
|
||||||
'cast_to_immutable_datetime' => 'immutable_datetime',
|
|
||||||
'cast_to_timestamp' => 'timestamp',
|
|
||||||
'cast_to_encrypted' => 'encrypted',
|
|
||||||
'cast_to_encrypted_array' => 'encrypted:array',
|
|
||||||
'cast_to_encrypted_collection' => 'encrypted:collection',
|
|
||||||
'cast_to_encrypted_json' => 'encrypted:json',
|
|
||||||
'cast_to_encrypted_object' => 'encrypted:object',
|
|
||||||
'cast_to_as_collection' => AsCollection::class,
|
|
||||||
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
|
|
||||||
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
|
||||||
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
|
|
||||||
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
|
||||||
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
|
||||||
'cast_to_as_array_object' => AsArrayObject::class,
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
public function test(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--write' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastMap;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
|
||||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
|
||||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
|
||||||
use Illuminate\Database\Eloquent\Casts\AsEnumCollection;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property \Illuminate\Support\Carbon $cast_to_date_serialization
|
|
||||||
* @property \Illuminate\Support\Carbon $cast_to_datetime_serialization
|
|
||||||
* @property \Illuminate\Support\Carbon $cast_to_custom_datetime
|
|
||||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_date
|
|
||||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_custom_datetime
|
|
||||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
|
|
||||||
* @property int $cast_to_timestamp
|
|
||||||
* @property string $cast_to_encrypted
|
|
||||||
* @property array<array-key, mixed> $cast_to_encrypted_array
|
|
||||||
* @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_encrypted_collection
|
|
||||||
* @property array<array-key, mixed> $cast_to_encrypted_json
|
|
||||||
* @property object $cast_to_encrypted_object
|
|
||||||
* @property \Illuminate\Support\Collection $cast_to_as_collection
|
|
||||||
* @property \Illuminate\Support\Collection $cast_to_as_enum_collection
|
|
||||||
* @property \Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed> $cast_to_as_array_object
|
|
||||||
* @property \Illuminate\Support\Collection<int, AdvancedCastMap> $cast_to_as_collection_of
|
|
||||||
* @property AdvancedCastCollection $cast_to_as_collection_using
|
|
||||||
* @property AdvancedCastCollection<int, AdvancedCastMap> $cast_to_as_collection_using_and_map
|
|
||||||
* @property \Illuminate\Support\Collection<int, AdvancedCastEnum> $cast_to_as_enum_collection_of
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToAsArrayObject($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToAsCollection($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToAsEnumCollection($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToCustomDatetime($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToDateSerialization($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToDatetimeSerialization($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncrypted($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncryptedArray($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncryptedCollection($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncryptedJson($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncryptedObject($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToImmutableCustomDatetime($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToImmutableDate($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToImmutableDatetime($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToTimestamp($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class AdvancedCast extends Model
|
|
||||||
{
|
|
||||||
protected function casts(): array
|
|
||||||
{
|
|
||||||
return [
|
|
||||||
'cast_to_date_serialization' => 'date:Y-m-d',
|
|
||||||
'cast_to_datetime_serialization' => 'datetime:Y-m-d H:i:s',
|
|
||||||
'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
|
|
||||||
'cast_to_immutable_date' => 'immutable_date',
|
|
||||||
'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
|
|
||||||
'cast_to_immutable_datetime' => 'immutable_datetime',
|
|
||||||
'cast_to_timestamp' => 'timestamp',
|
|
||||||
'cast_to_encrypted' => 'encrypted',
|
|
||||||
'cast_to_encrypted_array' => 'encrypted:array',
|
|
||||||
'cast_to_encrypted_collection' => 'encrypted:collection',
|
|
||||||
'cast_to_encrypted_json' => 'encrypted:json',
|
|
||||||
'cast_to_encrypted_object' => 'encrypted:object',
|
|
||||||
'cast_to_as_collection' => AsCollection::class,
|
|
||||||
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
|
|
||||||
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
|
||||||
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
|
|
||||||
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
|
||||||
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
|
||||||
'cast_to_as_array_object' => AsArrayObject::class,
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AllowGlobDirectory\Services\Post\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
class Post extends Model
|
|
||||||
{
|
|
||||||
}
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AllowGlobDirectory;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
|
|
||||||
final class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
/** @var string */
|
|
||||||
private $cwd;
|
|
||||||
|
|
||||||
protected function setUp(): void
|
|
||||||
{
|
|
||||||
parent::setUp();
|
|
||||||
|
|
||||||
$this->cwd = getcwd();
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function tearDown(): void
|
|
||||||
{
|
|
||||||
chdir($this->cwd);
|
|
||||||
|
|
||||||
parent::tearDown();
|
|
||||||
}
|
|
||||||
|
|
||||||
public function test(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
chdir(__DIR__);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--dir' => ['Services/*/Models'],
|
|
||||||
'--write' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,159 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AllowGlobDirectory\Services\Post\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property int $id
|
|
||||||
* @property string|null $char_nullable
|
|
||||||
* @property string $char_not_nullable
|
|
||||||
* @property string|null $string_nullable
|
|
||||||
* @property string $string_not_nullable
|
|
||||||
* @property string|null $text_nullable
|
|
||||||
* @property string $text_not_nullable
|
|
||||||
* @property string|null $medium_text_nullable
|
|
||||||
* @property string $medium_text_not_nullable
|
|
||||||
* @property string|null $long_text_nullable
|
|
||||||
* @property string $long_text_not_nullable
|
|
||||||
* @property int|null $integer_nullable
|
|
||||||
* @property int $integer_not_nullable
|
|
||||||
* @property int|null $tiny_integer_nullable
|
|
||||||
* @property int $tiny_integer_not_nullable
|
|
||||||
* @property int|null $small_integer_nullable
|
|
||||||
* @property int $small_integer_not_nullable
|
|
||||||
* @property int|null $medium_integer_nullable
|
|
||||||
* @property int $medium_integer_not_nullable
|
|
||||||
* @property int|null $big_integer_nullable
|
|
||||||
* @property int $big_integer_not_nullable
|
|
||||||
* @property int|null $unsigned_integer_nullable
|
|
||||||
* @property int $unsigned_integer_not_nullable
|
|
||||||
* @property int|null $unsigned_tiny_integer_nullable
|
|
||||||
* @property int $unsigned_tiny_integer_not_nullable
|
|
||||||
* @property int|null $unsigned_small_integer_nullable
|
|
||||||
* @property int $unsigned_small_integer_not_nullable
|
|
||||||
* @property int|null $unsigned_medium_integer_nullable
|
|
||||||
* @property int $unsigned_medium_integer_not_nullable
|
|
||||||
* @property int|null $unsigned_big_integer_nullable
|
|
||||||
* @property int $unsigned_big_integer_not_nullable
|
|
||||||
* @property float|null $float_nullable
|
|
||||||
* @property float $float_not_nullable
|
|
||||||
* @property float|null $double_nullable
|
|
||||||
* @property float $double_not_nullable
|
|
||||||
* @property numeric|null $decimal_nullable
|
|
||||||
* @property numeric $decimal_not_nullable
|
|
||||||
* @property int|null $boolean_nullable
|
|
||||||
* @property int $boolean_not_nullable
|
|
||||||
* @property string|null $enum_nullable
|
|
||||||
* @property string $enum_not_nullable
|
|
||||||
* @property string|null $json_nullable
|
|
||||||
* @property string $json_not_nullable
|
|
||||||
* @property string|null $jsonb_nullable
|
|
||||||
* @property string $jsonb_not_nullable
|
|
||||||
* @property string|null $date_nullable
|
|
||||||
* @property string $date_not_nullable
|
|
||||||
* @property string|null $datetime_nullable
|
|
||||||
* @property string $datetime_not_nullable
|
|
||||||
* @property string|null $datetimetz_nullable
|
|
||||||
* @property string $datetimetz_not_nullable
|
|
||||||
* @property string|null $time_nullable
|
|
||||||
* @property string $time_not_nullable
|
|
||||||
* @property string|null $timetz_nullable
|
|
||||||
* @property string $timetz_not_nullable
|
|
||||||
* @property string|null $timestamp_nullable
|
|
||||||
* @property string $timestamp_not_nullable
|
|
||||||
* @property string|null $timestamptz_nullable
|
|
||||||
* @property string $timestamptz_not_nullable
|
|
||||||
* @property int|null $year_nullable
|
|
||||||
* @property int $year_not_nullable
|
|
||||||
* @property string|null $binary_nullable
|
|
||||||
* @property string $binary_not_nullable
|
|
||||||
* @property string|null $uuid_nullable
|
|
||||||
* @property string $uuid_not_nullable
|
|
||||||
* @property string|null $ipaddress_nullable
|
|
||||||
* @property string $ipaddress_not_nullable
|
|
||||||
* @property string|null $macaddress_nullable
|
|
||||||
* @property string $macaddress_not_nullable
|
|
||||||
* @property \Illuminate\Support\Carbon|null $created_at
|
|
||||||
* @property \Illuminate\Support\Carbon|null $updated_at
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCreatedAt($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereId($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUpdatedAt($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNotNullable($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNullable($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class Post extends Model
|
|
||||||
{
|
|
||||||
}
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property array<int, string>|null $cast_to_array -- These three should not be duplicated
|
|
||||||
* @property array<int, string> $cast_to_json some-description
|
|
||||||
* @property \Illuminate\Support\Collection<int, string> $cast_to_collection some-description
|
|
||||||
*
|
|
||||||
* @property array|null $cast_to_encrypted_array -- These three are OK (no types)
|
|
||||||
* @property array $cast_to_encrypted_json some-description
|
|
||||||
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection some-description
|
|
||||||
*
|
|
||||||
* @property string $cast_to_string -- The next three are OK (no description), this not included
|
|
||||||
*
|
|
||||||
* @property array<int, string>|null $cast_to_immutable_date
|
|
||||||
* @property array<int, string> $cast_to_immutable_date_serialization
|
|
||||||
* @property \Illuminate\Support\Collection<int, string> $cast_to_immutable_custom_datetime
|
|
||||||
*/
|
|
||||||
class ArrayCastsWithComment extends Model
|
|
||||||
{
|
|
||||||
protected $table = 'simple_casts';
|
|
||||||
|
|
||||||
protected $casts = [
|
|
||||||
'cast_to_array' => 'array',
|
|
||||||
'cast_to_json' => 'json',
|
|
||||||
'cast_to_collection' => 'collection',
|
|
||||||
|
|
||||||
'cast_to_encrypted_array' => 'array',
|
|
||||||
'cast_to_encrypted_json' => 'json',
|
|
||||||
'cast_to_encrypted_collection' => 'collection',
|
|
||||||
|
|
||||||
'cast_to_string' => 'string',
|
|
||||||
|
|
||||||
'cast_to_immutable_date' => 'array',
|
|
||||||
'cast_to_immutable_date_serialization' => 'json',
|
|
||||||
'cast_to_immutable_custom_datetime' => 'collection',
|
|
||||||
];
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
public function test(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--write' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,92 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property array<int, string>|null $cast_to_array -- These three should not be duplicated
|
|
||||||
* @property array<int, string> $cast_to_json some-description
|
|
||||||
* @property \Illuminate\Support\Collection<int, string> $cast_to_collection some-description
|
|
||||||
* @property array|null $cast_to_encrypted_array -- These three are OK (no types)
|
|
||||||
* @property array $cast_to_encrypted_json some-description
|
|
||||||
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection some-description
|
|
||||||
* @property string $cast_to_string -- The next three are OK (no description), this not included
|
|
||||||
* @property array<int, string>|null $cast_to_immutable_date
|
|
||||||
* @property array<int, string> $cast_to_immutable_date_serialization
|
|
||||||
* @property \Illuminate\Support\Collection<int, string> $cast_to_immutable_custom_datetime
|
|
||||||
* @property string $cast_to_int
|
|
||||||
* @property string $cast_to_integer
|
|
||||||
* @property string $cast_to_real
|
|
||||||
* @property string $cast_to_float
|
|
||||||
* @property string $cast_to_double
|
|
||||||
* @property string $cast_to_decimal
|
|
||||||
* @property string $cast_to_bool
|
|
||||||
* @property string $cast_to_boolean
|
|
||||||
* @property string $cast_to_object
|
|
||||||
* @property string $cast_to_date
|
|
||||||
* @property string $cast_to_datetime
|
|
||||||
* @property string $cast_to_date_serialization
|
|
||||||
* @property string $cast_to_datetime_serialization
|
|
||||||
* @property string $cast_to_custom_datetime
|
|
||||||
* @property string $cast_to_immutable_datetime
|
|
||||||
* @property string $cast_to_immutable_datetime_serialization
|
|
||||||
* @property string $cast_to_timestamp
|
|
||||||
* @property string $cast_to_encrypted
|
|
||||||
* @property string $cast_to_encrypted_object
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToArray($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToBool($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToBoolean($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToCollection($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToCustomDatetime($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDate($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDateSerialization($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDatetime($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDatetimeSerialization($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDecimal($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDouble($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncrypted($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncryptedArray($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncryptedCollection($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncryptedJson($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncryptedObject($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToFloat($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableCustomDatetime($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableDate($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableDateSerialization($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableDatetime($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableDatetimeSerialization($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToInt($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToInteger($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToJson($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToObject($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToReal($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToString($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToTimestamp($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class ArrayCastsWithComment extends Model
|
|
||||||
{
|
|
||||||
protected $table = 'simple_casts';
|
|
||||||
|
|
||||||
protected $casts = [
|
|
||||||
'cast_to_array' => 'array',
|
|
||||||
'cast_to_json' => 'json',
|
|
||||||
'cast_to_collection' => 'collection',
|
|
||||||
|
|
||||||
'cast_to_encrypted_array' => 'array',
|
|
||||||
'cast_to_encrypted_json' => 'json',
|
|
||||||
'cast_to_encrypted_collection' => 'collection',
|
|
||||||
|
|
||||||
'cast_to_string' => 'string',
|
|
||||||
|
|
||||||
'cast_to_immutable_date' => 'array',
|
|
||||||
'cast_to_immutable_date_serialization' => 'json',
|
|
||||||
'cast_to_immutable_custom_datetime' => 'collection',
|
|
||||||
];
|
|
||||||
}
|
|
||||||
@@ -1,59 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Casts\Attribute;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
class BackedAttribute extends Model
|
|
||||||
{
|
|
||||||
protected function name(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nameRead(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nameWrite(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
set: function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonBackedSet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
set: function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonBackedGet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
get: function (): ?string {
|
|
||||||
return 'test';
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,117 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Casts\Attribute;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
class Simple extends Model
|
|
||||||
{
|
|
||||||
// With a backed property
|
|
||||||
protected function name(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Without backed properties
|
|
||||||
|
|
||||||
protected function typeHintedGetAndSet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (): ?string {
|
|
||||||
return $this->name;
|
|
||||||
},
|
|
||||||
function (?string $name) {
|
|
||||||
$this->name = $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function divergingTypeHintedGetAndSet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (): int {
|
|
||||||
return strlen($this->name);
|
|
||||||
},
|
|
||||||
function (?string $name) {
|
|
||||||
$this->name = $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function typeHintedGet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::get(function (): ?string {
|
|
||||||
return $this->name;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function typeHintedSet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::set(function (?string $name) {
|
|
||||||
$this->name = $name;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonTypeHintedGetAndSet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function () {
|
|
||||||
return $this->name;
|
|
||||||
},
|
|
||||||
function ($name) {
|
|
||||||
$this->name = $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonTypeHintedGet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::get(function () {
|
|
||||||
return $this->name;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonTypeHintedSet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::set(function ($name) {
|
|
||||||
$this->name = $name;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function parameterlessSet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::set(function () {
|
|
||||||
$this->name = null;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ide-helper does not recognize this method being an Attribute
|
|
||||||
* because the method has no actual return type;
|
|
||||||
* phpdoc is ignored here deliberately due to performance reasons and also
|
|
||||||
* isn't supported by Laravel itself.
|
|
||||||
*
|
|
||||||
* @return Attribute
|
|
||||||
*/
|
|
||||||
protected function notAnAttribute()
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (?string $value): ?string {
|
|
||||||
return $value;
|
|
||||||
},
|
|
||||||
function (?string $value): ?string {
|
|
||||||
return $value;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
public function test(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--write' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,209 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Casts\Attribute;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property int $id
|
|
||||||
* @property string|null $name
|
|
||||||
* @property string|null $name_read
|
|
||||||
* @property string|null $name_write
|
|
||||||
* @property-read string|null $non_backed_get
|
|
||||||
* @property-write string|null $non_backed_set
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute whereId($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute whereName($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute whereNameRead($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute whereNameWrite($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class BackedAttribute extends Model
|
|
||||||
{
|
|
||||||
protected function name(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nameRead(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nameWrite(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
set: function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonBackedSet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
set: function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonBackedGet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
get: function (): ?string {
|
|
||||||
return 'test';
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Casts\Attribute;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property int $id
|
|
||||||
* @property int $diverging_type_hinted_get_and_set
|
|
||||||
* @property string|null $name
|
|
||||||
* @property-read mixed $non_type_hinted_get
|
|
||||||
* @property mixed $non_type_hinted_get_and_set
|
|
||||||
* @property-write mixed $non_type_hinted_set
|
|
||||||
* @property-write mixed $parameterless_set
|
|
||||||
* @property-read string|null $type_hinted_get
|
|
||||||
* @property string|null $type_hinted_get_and_set
|
|
||||||
* @property-write string|null $type_hinted_set
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class Simple extends Model
|
|
||||||
{
|
|
||||||
// With a backed property
|
|
||||||
protected function name(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
},
|
|
||||||
function (?string $name): ?string {
|
|
||||||
return $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Without backed properties
|
|
||||||
|
|
||||||
protected function typeHintedGetAndSet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (): ?string {
|
|
||||||
return $this->name;
|
|
||||||
},
|
|
||||||
function (?string $name) {
|
|
||||||
$this->name = $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function divergingTypeHintedGetAndSet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (): int {
|
|
||||||
return strlen($this->name);
|
|
||||||
},
|
|
||||||
function (?string $name) {
|
|
||||||
$this->name = $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function typeHintedGet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::get(function (): ?string {
|
|
||||||
return $this->name;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function typeHintedSet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::set(function (?string $name) {
|
|
||||||
$this->name = $name;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonTypeHintedGetAndSet(): Attribute
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function () {
|
|
||||||
return $this->name;
|
|
||||||
},
|
|
||||||
function ($name) {
|
|
||||||
$this->name = $name;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonTypeHintedGet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::get(function () {
|
|
||||||
return $this->name;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function nonTypeHintedSet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::set(function ($name) {
|
|
||||||
$this->name = $name;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function parameterlessSet(): Attribute
|
|
||||||
{
|
|
||||||
return Attribute::set(function () {
|
|
||||||
$this->name = null;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ide-helper does not recognize this method being an Attribute
|
|
||||||
* because the method has no actual return type;
|
|
||||||
* phpdoc is ignored here deliberately due to performance reasons and also
|
|
||||||
* isn't supported by Laravel itself.
|
|
||||||
*
|
|
||||||
* @return Attribute
|
|
||||||
*/
|
|
||||||
protected function notAnAttribute()
|
|
||||||
{
|
|
||||||
return new Attribute(
|
|
||||||
function (?string $value): ?string {
|
|
||||||
return $value;
|
|
||||||
},
|
|
||||||
function (?string $value): ?string {
|
|
||||||
return $value;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,136 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
||||||
use Illuminate\Database\Eloquent\Relations\HasOne;
|
|
||||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
|
||||||
|
|
||||||
class Simple extends Model
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* There is not comment.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getNotCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* comment There is not format comment, invalid.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getFakerCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment There is format comment, success.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getFormatCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment There is format comment, success.
|
|
||||||
* This is second line, success too.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getFormatCommentLineTwoAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment There is format comment, success.
|
|
||||||
* @comment This is others format comment, invalid.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getManyFormatCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment Set the user's first name.
|
|
||||||
* @param $value
|
|
||||||
*/
|
|
||||||
public function setFirstNameAttribute($value)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment Scope a query to only include active users.
|
|
||||||
*
|
|
||||||
* @param $query
|
|
||||||
* @return mixed
|
|
||||||
*/
|
|
||||||
public function scopeActive($query)
|
|
||||||
{
|
|
||||||
return $query;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment HasMany relations.
|
|
||||||
*
|
|
||||||
* @return HasMany
|
|
||||||
*/
|
|
||||||
public function relationHasMany(): HasMany
|
|
||||||
{
|
|
||||||
return $this->hasMany(Simple::class);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment MorphTo relations.
|
|
||||||
* @return MorphTo
|
|
||||||
*/
|
|
||||||
public function relationMorphTo(): MorphTo
|
|
||||||
{
|
|
||||||
return $this->morphTo();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment Others relations.
|
|
||||||
* @return HasOne
|
|
||||||
*/
|
|
||||||
public function relationHasOne(): HasOne
|
|
||||||
{
|
|
||||||
return $this->hasOne(Simple::class);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment I'm a setter
|
|
||||||
*/
|
|
||||||
public function setBothSameNameAttribute(): void
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment I'm a getter
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getBothSameNameAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment I'm a setter
|
|
||||||
*/
|
|
||||||
public function setBothWithoutGetterCommentAttribute(): void
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getBothWithoutGetterCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
public function test(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--write' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,159 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
||||||
use Illuminate\Database\Eloquent\Relations\HasOne;
|
|
||||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property int $id
|
|
||||||
* @property string $both_same_name I'm a getter
|
|
||||||
* @property string $both_without_getter_comment
|
|
||||||
* @property-read string $faker_comment
|
|
||||||
* @property-read string $format_comment There is format comment, success.
|
|
||||||
* @property-read string $format_comment_line_two There is format comment, success.
|
|
||||||
* This is second line, success too.
|
|
||||||
* @property-read string $many_format_comment There is format comment, success.
|
|
||||||
* @property-read string $not_comment
|
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationHasMany HasMany relations.
|
|
||||||
* @property-read int|null $relation_has_many_count
|
|
||||||
* @property-read bool|null $relation_has_many_exists
|
|
||||||
* @property-read Simple|null $relationHasOne Others relations.
|
|
||||||
* @property-read Model|\Eloquent $relationMorphTo MorphTo relations.
|
|
||||||
* @property-write mixed $first_name Set the user's first name.
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple active() Scope a query to only include active users.
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class Simple extends Model
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* There is not comment.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getNotCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* comment There is not format comment, invalid.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getFakerCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment There is format comment, success.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getFormatCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment There is format comment, success.
|
|
||||||
* This is second line, success too.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getFormatCommentLineTwoAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment There is format comment, success.
|
|
||||||
* @comment This is others format comment, invalid.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getManyFormatCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment Set the user's first name.
|
|
||||||
* @param $value
|
|
||||||
*/
|
|
||||||
public function setFirstNameAttribute($value)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment Scope a query to only include active users.
|
|
||||||
*
|
|
||||||
* @param $query
|
|
||||||
* @return mixed
|
|
||||||
*/
|
|
||||||
public function scopeActive($query)
|
|
||||||
{
|
|
||||||
return $query;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment HasMany relations.
|
|
||||||
*
|
|
||||||
* @return HasMany
|
|
||||||
*/
|
|
||||||
public function relationHasMany(): HasMany
|
|
||||||
{
|
|
||||||
return $this->hasMany(Simple::class);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment MorphTo relations.
|
|
||||||
* @return MorphTo
|
|
||||||
*/
|
|
||||||
public function relationMorphTo(): MorphTo
|
|
||||||
{
|
|
||||||
return $this->morphTo();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment Others relations.
|
|
||||||
* @return HasOne
|
|
||||||
*/
|
|
||||||
public function relationHasOne(): HasOne
|
|
||||||
{
|
|
||||||
return $this->hasOne(Simple::class);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment I'm a setter
|
|
||||||
*/
|
|
||||||
public function setBothSameNameAttribute(): void
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment I'm a getter
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getBothSameNameAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @comment I'm a setter
|
|
||||||
*/
|
|
||||||
public function setBothWithoutGetterCommentAttribute(): void
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getBothWithoutGetterCommentAttribute(): string
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Collections;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Collection;
|
|
||||||
|
|
||||||
class SimpleCollection extends Collection
|
|
||||||
{
|
|
||||||
}
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Models;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Collections\SimpleCollection;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
||||||
|
|
||||||
class Simple extends Model
|
|
||||||
{
|
|
||||||
public function newCollection(array $models = [])
|
|
||||||
{
|
|
||||||
return new SimpleCollection($models);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function relationHasMany(): HasMany
|
|
||||||
{
|
|
||||||
return $this->hasMany(Simple::class);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
public function test(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--write' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Models;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Collections\SimpleCollection;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property int $id
|
|
||||||
* @property-read SimpleCollection<int, Simple> $relationHasMany
|
|
||||||
* @property-read int|null $relation_has_many_count
|
|
||||||
* @property-read bool|null $relation_has_many_exists
|
|
||||||
* @method static SimpleCollection<int, static> all($columns = ['*'])
|
|
||||||
* @method static SimpleCollection<int, static> get($columns = ['*'])
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class Simple extends Model
|
|
||||||
{
|
|
||||||
public function newCollection(array $models = [])
|
|
||||||
{
|
|
||||||
return new SimpleCollection($models);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function relationHasMany(): HasMany
|
|
||||||
{
|
|
||||||
return $this->hasMany(Simple::class);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomDate\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
class CustomDate extends Model
|
|
||||||
{
|
|
||||||
}
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomDate;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
use Carbon\CarbonImmutable;
|
|
||||||
use Illuminate\Support\Carbon;
|
|
||||||
use Illuminate\Support\Facades\Date;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
protected function setUp(): void
|
|
||||||
{
|
|
||||||
parent::setUp();
|
|
||||||
|
|
||||||
Date::use(CarbonImmutable::class);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function tearDown(): void
|
|
||||||
{
|
|
||||||
Date::use(Carbon::class);
|
|
||||||
|
|
||||||
parent::tearDown();
|
|
||||||
}
|
|
||||||
|
|
||||||
public function test(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--write' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomDate\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @property \Carbon\CarbonImmutable|null $created_at
|
|
||||||
* @property \Carbon\CarbonImmutable|null $updated_at
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate whereCreatedAt($value)
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate whereUpdatedAt($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class CustomDate extends Model
|
|
||||||
{
|
|
||||||
}
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomPhpdocTags\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The `@SuppressWarnings` tag below contains no space before the `(` but when
|
|
||||||
* the class phpdoc is written back, one is inserted.
|
|
||||||
*
|
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper/issues/666
|
|
||||||
*
|
|
||||||
* @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
|
|
||||||
*/
|
|
||||||
class Simple extends Model
|
|
||||||
{
|
|
||||||
}
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomPhpdocTags;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* This test makes sure that custom phpdoc tags are not mangled, e.g.
|
|
||||||
* there are no spaces inserted etc.
|
|
||||||
*
|
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper/issues/666
|
|
||||||
*/
|
|
||||||
public function testNoSpaceAfterCustomPhpdocTag(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--write' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-24
@@ -1,24 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomPhpdocTags\Models;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The `@SuppressWarnings` tag below contains no space before the `(` but when
|
|
||||||
* the class phpdoc is written back, one is inserted.
|
|
||||||
*
|
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper/issues/666
|
|
||||||
* @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
|
|
||||||
* @property int $id
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
|
||||||
* @mixin \Eloquent
|
|
||||||
*/
|
|
||||||
class Simple extends Model
|
|
||||||
{
|
|
||||||
}
|
|
||||||
-20
@@ -1,20 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Builders;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Builder;
|
|
||||||
|
|
||||||
class PostExternalQueryBuilder extends Builder
|
|
||||||
{
|
|
||||||
public function isActive(): self
|
|
||||||
{
|
|
||||||
return $this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function isStatus(string $status): self
|
|
||||||
{
|
|
||||||
return $this;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-16
@@ -1,16 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Models;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Builders\PostExternalQueryBuilder;
|
|
||||||
use Illuminate\Database\Eloquent\Model;
|
|
||||||
|
|
||||||
class Post extends Model
|
|
||||||
{
|
|
||||||
public function newEloquentBuilder($query): PostExternalQueryBuilder
|
|
||||||
{
|
|
||||||
return new PostExternalQueryBuilder($query);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
|
||||||
{
|
|
||||||
protected function getEnvironmentSetUp($app)
|
|
||||||
{
|
|
||||||
parent::getEnvironmentSetUp($app);
|
|
||||||
|
|
||||||
$app['config']->set('ide-helper.write_model_external_builder_methods', false);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function test(): void
|
|
||||||
{
|
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
|
||||||
|
|
||||||
$tester = $this->runCommand($command, [
|
|
||||||
'--nowrite' => true,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
|
||||||
$this->assertStringContainsString('Model information was written to _ide_helper_models.php', $tester->getDisplay());
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user