laravel-ide-helper - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #rust #deep-learning #java #nodejs #windows #awesome #kubernetes #vue #pytorch #ios #mcp

laravel-ide-helper

(★ 14,954)

Laravel용 IDE Helper

파일 탐색기

최종 버전 다운로드 (.zip)

- - 1_Bug_report.md
  - 2_Feature_request.md
  - 3_Support_question.md
- - composer-normalize.yml
  - fix-code-style.yml
  - release-drafter.yml
  - run-integration-tests.yml
  - run-static-analysis.yml
  - run-tests.yml
  - update-changelog.yaml
- dependabot.yaml
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- release-drafter.yml
- stale.yml
- ide-helper.php
- auth.php
- configs.php
- LICENSE.md
- middleware.php
- README.md
- routes.php
- translations.php
- views.php
- - helper.php
  - meta.php
- - EloquentCommand.php
  - GeneratorCommand.php
  - MetaCommand.php
  - ModelsCommand.php
- - ModelHookInterface.php
- - GenerateModelHelper.php
- - PhpDocReturnTypeParser.php
- Alias.php
- Eloquent.php
- Generator.php
- IdeHelperServiceProvider.php
- Macro.php
- Method.php
- - EloquentCommandTest.php
- - facade-0e0385307adf5db34c7986ecbd11646061356ec8.php
  - facade-9431b04ec1494fc71a1bc848f020044aba2af7b1.php
- AliasTest.php
- MacroTest.php
- MethodTest.php
- RealTimeFacadesTest.php
- SnapshotPhpDriver.php
- SnapshotTxtDriver.php
- TestCase.php
.editorconfig
.gitattributes
.gitignore
.php-cs-fixer.common.php
.php-cs-fixer.dist.php
.php-cs-fixer.tests.php
CHANGELOG.md
composer.json
LICENSE.md
phpstan-baseline.neon
phpstan.neon
phpunit.xml.dist
README.md

🚀 설치 가이드

1. 코드 내려받기

git clone https://github.com/barryvdh/laravel-ide-helper

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd laravel-ide-helper

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. PHP (Composer)

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
PHP PHP 실행 환경이 필요합니다.
Composer PHP 라이브러리 설치를 위한 패키지 매니저입니다.

composer require --dev barryvdh/laravel-ide-helper

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ php -S localhost:8000 같은 내장 서버로 실행한 뒤 브라우저에서 http://localhost:8000 으로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Laravel용 IDE Helper 생성기
[![Tests](https://github.com/barryvdh/laravel-ide-helper/actions/workflows/run-tests.yml/badge.svg)](https://github.com/barryvdh/laravel-ide-helper/actions)
[![Packagist License](https://img.shields.io/badge/Licence-MIT-blue)](http://choosealicense.com/licenses/mit/)
[![Latest Stable Version](https://img.shields.io/packagist/v/barryvdh/laravel-ide-helper?label=Stable)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
[![Total Downloads](https://img.shields.io/packagist/dt/barryvdh/laravel-ide-helper?label=Downloads)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
[![Fruitcake](https://img.shields.io/badge/Powered%20By-Fruitcake-b2bc35.svg)](https://fruitcake.nl/)

\*\*소스 코드에서 직접 추출하는 완전한 PHPDocs\*\*

이 패키지는 IDE가 정확한 자동완성 기능을 제공할 수 있도록 헬퍼 파일을 생성합니다.
프로젝트 내의 파일을 바탕으로 생성이 이루어지므로 항상 최신 상태를 유지합니다.

3.x 브랜치는 Laravel 10 이상을 지원합니다. 이전 버전의 경우 2.x 릴리즈를 사용하세요.

- [설치](#installation)
- [사용법](#usage)
- [Laravel Facades를 위한 자동 PHPDoc 생성](#automatic-phpdoc-generation-for-laravel-facades)
- [모델을 위한 자동 PHPDocs](#automatic-phpdocs-for-models)
- [모델 디렉토리](#model-directories)
- [모델 제외하기](#ignore-models)
- [모델 훅](#model-hooks)
- [Laravel Fluent 메서드를 위한 자동 PHPDocs 생성](#automatic-phpdocs-generation-for-laravel-fluent-methods)
- [팩토리 빌더를 위한 자동완성](#auto-completion-for-factory-builders)
- [컨테이너 인스턴스를 위한 PhpStorm Meta](#phpstorm-meta-for-container-instances)
- [라이선스](#license)

## 설치

다음 명령어를 사용하여 composer로 이 패키지를 요구(require)하세요:

```bash
composer require --dev barryvdh/laravel-ide-helper
```

## 사용법

### 요약 (TL;DR)

Facades에 대한 자동완성을 생성하려면 다음을 실행하세요. 이 명령어는 `_ide_helper.php`를 생성합니다.

```
php artisan ide-helper:generate
```

모델에 phpdoc을 추가하려면 다음을 실행하세요. `-RW`를 추가하면 기존 phpdoc을 재설정(Reset)하고 모델에 직접 작성(Write)합니다.

```
php artisan ide-helper:models -RW
```

전체 `_ide_helper.php` 파일이 필요 없는 경우, 모델 명령어에 `--write-eloquent-helper`를 추가하여 `@mixin \Eloquent`가 QueryBuilder 메서드를 추가하는 데 필요한 소형 버전을 생성할 수 있습니다.

모든 phpdoc을 모델에 직접 추가하고 싶지 않다면, `--nowrite`를 사용하여 별도의 파일을 생성할 수 있습니다. `--write-mixin` 옵션을 사용하면 모델에는 `@mixin`만 추가하고, 생성된 phpdoc은 별도의 파일에 저장할 수 있습니다. 이를 통해 결과가 중복으로 표시되는 것을 방지할 수 있습니다.

\_빠른 소개 및 설명을 원하시면 [이 Laracasts 영상](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15)을 확인해 보세요!\_

- `php artisan ide-helper:generate` - [Laravel Facades를 위한 PHPDoc 생성](#automatic-phpdoc-generation-for-laravel-facades)
- `php artisan ide-helper:models` - [모델을 위한 PHPDocs](#automatic-phpdocs-for-models)
- `php artisan ide-helper:meta` - [PhpStorm Meta 파일](#phpstorm-meta-for-container-instances)

> 참고: Sublime Text용 CodeComplice가 필요합니다: https://github.com/spectacles/CodeComplice

### Laravel Facades를 위한 자동 PHPDoc 생성

이제 (향후 업데이트를 위해) 직접 문서를 다시 생성할 수 있습니다.

```bash
php artisan ide-helper:generate
```

이렇게 하면 자동완성을 위해 IDE에서 추가로 파싱할 것으로 예상되는 `_ide_helper.php` 파일이 생성됩니다. `filename` 설정을 사용하여 이름을 변경할 수 있습니다.

의존성을 업데이트할 때마다 이 작업이 수행되도록 `composer.json`을 설정할 수 있습니다:

```js
"scripts": {
"post-update-cmd": [
"Illuminate\\Foundation\\ComposerScripts::postUpdate",
"@php artisan ide-helper:generate",
"@php artisan ide-helper:meta"
]
},
```

구현을 변경(예: 인터페이스를 특정 클래스로 변경)하거나 `--helpers`의 기본값을 설정하기 위해 설정 파일을 퍼블리시할 수도 있습니다.

```bash
php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperService

Provider" --tag=config
```
생성기는 실제 클래스를 식별하려고 시도하지만, 찾을 수 없는 경우 설정 파일에서 정의할 수 있습니다.
일부 클래스는 작동하는 데이터베이스 연결이 필요합니다. 기본으로 작동하는 연결이 없는 경우, 일부 facade는 포함되지 않습니다.
`-M` 옵션을 추가하여 인메모리 SQLite 드라이버를 사용할 수 있습니다.
앱에서 [real-time facades](https://laravel.com/docs/master/facades#real-time-facades)를 사용하는 경우, 해당 기능도 `@mixin` 어노테이션을 사용하고 facade 내부의 원본 클래스를 확장하여 생성된 파일에 포함됩니다.
> \*\*참고\*\*: 이 기능은 `storage/framework/cache` 폴더에 생성된 실시간 facade 파일을 사용합니다. 이 파일들은 실시간 facade를 사용할 때 온디맨드 방식으로 생성되므로, 프레임워크가 먼저 생성하지 않은 경우 헬퍼 파일에 포함되지 않습니다. 라우트/명령어/코드를 먼저 실행한 후 헬퍼 파일을 다시 생성하면 이번에는 실시간 facade가 포함됩니다.
헬퍼 파일을 포함하도록 선택할 수 있습니다. 기본적으로 활성화되어 있지는 않지만, `--helpers (-H)` 옵션으로 재정의할 수 있습니다.
`Illuminate/Support/helpers.php`는 이미 설정되어 있지만, 설정 파일에서 자신의 파일을 추가하거나 제거할 수 있습니다.
### 매크로 및 믹스인을 위한 자동 PHPDoc 생성
이 패키지는 `\_ide\_helper.php` 파일에 추가될 매크로 및 믹스인용 PHPDoc을 생성할 수 있습니다.
하지만 이는 매크로를 선언할 때 타입 힌트를 사용하는 경우에만 작동합니다.
```php
Str::macro('concat', function(string $str1, string $str2) : string {
return $str1 . $str2;
});
```
### 모델을 위한 자동 PHPDocs
프로퍼티를 직접 작성하고 싶지 않다면, 테이블 컬럼, 관계, 게터/세터를 기반으로 PHPDoc을 생성하는 `php artisan ide-helper:models` 명령어를 사용할 수 있습니다.
> 참고: 이 명령어는 각 모델의 테이블을 검사하기 위해 작동하는 데이터베이스 연결이 필요합니다.
기본적으로 별도의 파일(`\_ide\_helper\_models.php`)에 덮어쓸지 여부를 묻습니다.
`--write (-W)` 옵션을 사용하여 모델 파일에 직접 주석을 작성하거나, `--nowrite (-N)`을 사용하여 작성을 강제로 건너뛸 수 있습니다.
대안으로 `--write-mixin (-M)` 옵션을 사용하면 모델 파일에 mixin 태그만 추가되고, 나머지는 (`\_ide\_helper\_models.php`)에 작성됩니다.
클래스 이름이 모델과 달라지므로 IDE 중복 경고 번거로움을 피할 수 있습니다.
> 정보를 작성하기 전에 반드시 모델을 백업하십시오.
> QueryBuilder 메서드를 추가하려면 \_ide\_helper.php 파일이 필요합니다. 최소 버전을 생성하려면 --write-eloquent-helper/-E를 추가할 수 있습니다. 이 파일이 존재하지 않으면 생성이 프롬프트로 요청됩니다.
모델에 작성할 때는 기존 주석이 유지되며 새로운 프로퍼티/메서드만 추가됩니다. 변경된 프로퍼티/메서드는 업데이트되지 않습니다.
`--reset (-R)` 옵션을 사용하면 작성된 모든 주석을 포함하여 기존 PHPDoc 전체가 교체됩니다.
```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|\App\Models\Post newModelQuery()
\* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newQuery()
\* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post query()
\* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post whereTitle($value)
\* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post forAuthors(\User ...$authors)
\* …
\*/
```
`--write-mixin (-M)` 옵션 사용 시
```php
/\*\*
\* …
\* @mixin IdeHelperPost
\*/
```
#### 모델 디렉터리
기본적으로 `app/models`의 모델들이 스캔됩니다. 선택적 인자는 사용할 모델을 지정합니다 (`app/models` 외부도 가능).
```bash
php

artisan ide-helper:models "App\Models\Post" "App\Models\User"
```
또한 `--dir` 옵션을 사용하여 (기본 경로 기준 상대 경로로) 다른 디렉터리를 스캔할 수도 있습니다:
```bash
php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
```
설정 파일(`php artisan vendor:publish`)을 발행하고 기본 디렉터리를 설정할 수 있습니다.
#### 모델 무시하기
`--ignore (-I)` 옵션을 사용하여 모델을 무시할 수 있습니다.
```bash
php artisan ide-helper:models --ignore="App\Models\Post,App\Models\User"
```
또는 `ignored\_models` 설정을 지정하여 무시할 수도 있습니다.
```php
'ignored\_models' => [
App\Post::class,
Api\User::class
],
```
#### 매직 `where\*` 메서드
Eloquent는 모델에서 `where` 호출을 허용합니다(예: `Post::whereTitle(…)`). 이는 자동으로 `Post::where('title', '=', '…')` 등으로 변환됩니다.
어떤 이유로든 이러한 메서드들이 생성되는 것을 원하지 않는 경우(컬럼당 하나씩 생성됨), 설정 `write\_model\_magic\_where`를 `false`로 설정하여 비활성화할 수 있습니다.
#### 매직 `\*\_count` 및 `\*\_exists` 속성
[`::withCount`](https://laravel.com/docs/master/eloquent-relationships#counting-related-models) 및 [`::withExists`](https://laravel.com/docs/master/eloquent-relationships#other-aggregate-functions) 메서드를 사용하면 실제로 관계된 모델을 로드하지 않고도 관계의 결과 수를 셀 수 있습니다. 이 결과들은 `\_count` 및 `\_exists` 규칙에 따르는 속성에 저장됩니다.
기본적으로 이 속성들은 phpdoc에 생성됩니다. 설정 `write\_model\_relation\_count\_properties`와 `write\_model\_relation\_exists\_properties`를 `false`로 설정하여 이를 끌 수 있습니다.
#### 제네릭스 어노테이션
Laravel 9에서는 컬렉션을 위한 DocBlock 제네릭스 어노테이션이 도입되었습니다. PhpStorm 2022.3 이상에서는 DocBlock 내의 `@property` 및 `@property-read` 선언에서 `Collection|User[]` 대신 `Collection`과 같은 제네릭스 어노테이션 사용을 지원합니다.
이는 설정 `use\_generics\_annotations`를 `false`로 설정하여 비활성화할 수 있습니다.
#### DocBlock 기반의 `@comment` 지원
IDE를 더 잘 지원하기 위해 관계 및 게터/세터에서도 테이블 컬럼처럼 속성에 주석을 추가할 수 있습니다. 이를 위해 커스텀 docblock `@comment`가 사용됩니다:
```php
class Users extends Model
{
/\*\*
\* @comment Get User's full name
\*
\* @return string
\*/
public function getFullNameAttribute(): string
{
return $this->first\_name . ' ' .$this->last\_name ;
}
}
// => 모델 생성 후
/\*\*
\* App\Models\Users
\*
\* @property-read string $full\_name Get User's full name
\* …
\*/
```
#### 전용 Eloquent Builder 메서드
Eloquent 모델에 `newEloquentBuilder`라는 새로운 메서드가 추가되었습니다 [참조](https://timacdonald.me/dedicated-eloquent-model-query-builders/). 이를 통해 모델 자체에서 로컬 스코프를 사용하는 대신, 새로 전용 클래스를 생성하는 것을 지원할 수 있습니다.
어떤 이유로든 이러한 메서드들이 생성되는 것을 원하지 않는 경우(컬럼당 하나씩 생성됨), 설정 `write\_model\_external\_builder\_methods`를 `false`로 설정하여 비활성화할 수 있습니다.
#### 커스텀 관계 유형
Laravel에 내장되지 않은 관계를 사용하는 경우, 올바른 생성을 위해 설정에 이름과 반환 클래스를 지정해야 합니다.
```php
'additional\_relation\_types' => [
'externalHasMany' => \My\Package\externalHasMany::class
],
```
발견된 관계는 일반적으로 관계의 이름을 기반으로 반환 값을 생성합니다.
커스텀 관계가 이러한 전통적인 네이밍 방식을 따르지 않는 경우 반환 유형을 수동으로 정의할 수 있습니다. 사용 가능한 옵션은 `many`와 `morphTo`입니다.
```php
'additional\_relation\_return\_types' => [
'externalHasMultiple' => 'many'
],
```
#### 모델 후크
기본적으로 처리되지 않는 소스에서 모델에 대한 추가 정보가 필요한 경우, 모델 후크를 사용하여 생성 프로세스에 개입하고 즉석에서 추가 정보를 더할 수 있습니다.
`ModelHookInterface`를 구현하는 클래스를 생성하고 설정의 `model\_hooks` 배열에 추가하기만 하면 됩니다:
```php
'model\_ho

oks' => [
MyCustomHook::class,
],
```
`run` 메서드는 모든 모델 생성 과정에서 호출되며, 현재 실행 중인 `ModelsCommand`와 현재 `Model`을 인자로 받습니다. 예시:
```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
```
### Laravel Fluent 메서드를 위한 자동 PHPDocs 생성
마이그레이션에서 Fluent 메서드에 대한 PHPDocs 지원이 필요한 경우, 예를 들어
```php
$table->string("somestring")->nullable()->index();
```
벤더 파일을 발행한 후, `config/ide-helper.php` 파일에서 `include\_fluent` 라인을 다음과 같이 변경하기만 하면 됩니다.
```php
'include\_fluent' => true,
```
그런 다음 `php artisan ide-helper:generate`를 실행하면, 이제 IDE에서 인식되는 모든 Fluent 메서드를 확인할 수 있습니다.
### 팩토리 빌더를 위한 자동 완성
`factory()->create()` 및 `factory()->make()` 메서드가 올바른 모델 클래스를 반환하도록 하려면,
`config/ide-helper.php` 파일의 `include\_factory\_builders` 라인을 활성화하여 커스텀 팩토리 빌더를 사용할 수 있습니다.
Laravel 8 이상 버전에서는 더 이상 사용되지 않습니다 (Deprecated).
```php
'include\_factory\_builders' => true,
```
이 기능이 작동하려면 PhpStorm 메타 파일도 함께 발행해야 합니다 (아래 참고).
## 컨테이너 인스턴스를 위한 PhpStorm Meta
[팩토리 디자인 패턴에 대한 지원을 추가하기 위해](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html) PhpStorm 메타 파일을 생성할 수 있습니다.
Laravel의 경우, 이는 IoC 컨테이너로부터 해결(resolving)하려는 객체의 종류를 PhpStorm이 이해할 수 있도록 만들어 줍니다.
예를 들어, `events`는 `Illuminate\Events\Dispatcher` 객체를 반환하므로,
메타 파일을 사용하면 `app('events')`를 호출할 때 Dispatcher 메서드들이 자동으로 완성됩니다.
```bash
php artisan ide-helper:meta
```
```php
app('events')->fire();
\App::make('events')->fire();
/\*\* @var \Illuminate\Foundation\Application $app \*/
$app->make('events')->fire();
// 키를 찾을 수 없는 경우, 인수를 클래스 이름으로 사용합니다
app('App\SomeClass');
// 다음과 같이도 작동합니다
app(App\SomeClass::class);
```
> 참고: PhpStorm을 재시작해야 할 수 있으며, `.phpstorm.meta.php`가 색인(indexed)되었는지 확인하세요.
> 참고: FatalException: class not found 오류가 발생하는 경우, 설정을 확인하세요
> (예: S3가 설정되지 않은 경우 클라우드 드라이버에서 S3를 제거하고, Redis를 사용하지 않는 경우 Redis ServiceProvider를 제거하세요).
`meta\_filename` 설정을 통해 생성되는 파일 이름을 변경할 수 있습니다. 이는 PhpStorm이 지원하는 `\_directory\_` `.phpstorm.meta.php/` 디렉터리를 활용하려는 경우에 유용할 수 있습니다. 해당 디렉터리에 배치된 모든 파일은 PhpStorm에 추가 파일을 제공하려는 목적으로 파싱됩니다.
## 라이선스
Laravel IDE Helper Generator는 [MIT 라이선스](http://opensource.org/licenses/MIT)에 따라 배포되는 오픈소스 소프트웨어입니다.