https://github.com/ekvedaras/laravel-query-intellij

💿 Laravel Query Builder integration for PhpStorm
https://github.com/ekvedaras/laravel-query-intellij

database intellij-plugin laravel php phpstorm phpstorm-plugin

Last synced: 2 months ago
JSON representation

💿 Laravel Query Builder integration for PhpStorm

• Host: GitHub
• URL: https://github.com/ekvedaras/laravel-query-intellij
• Owner: ekvedaras
• License: mit
• Created: 2020-12-31T09:50:37.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T20:00:18.000Z (7 months ago)
• Last Synced: 2024-06-25T21:40:38.954Z (7 months ago)
• Topics: database, intellij-plugin, laravel, php, phpstorm, phpstorm-plugin
• Language: Kotlin
• Homepage:
• Size: 1.41 MB
• Stars: 47
• Watchers: 2
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Query

![Build](https://github.com/ekvedaras/laravel-query-intellij/workflows/Build/badge.svg)

[![Version](https://img.shields.io/jetbrains/plugin/v/16309.svg)](https://plugins.jetbrains.com/plugin/16309)

[![Downloads](https://img.shields.io/jetbrains/plugin/d/16309.svg)](https://plugins.jetbrains.com/plugin/16309)



## Laravel + DataGrip = ♥️



This plugin provides database integration for Laravel query builder.

## Features

* Schemas, tables, views and columns completion for query and schema builder methods

* Completion for database assertion test methods

* Completion for migrations

* Inspection of unknown database elements

* Table alias support

* Table name resolving from model for eloquent builder methods

* Model relation table name resolving for eloquent builder relation closure methods

* Text linking with database elements for navigation and refactoring

* Configurable table prefix and datasource filtering

## Prerequisites

### Connect your database

See  for instructions.

### Laravel tools

You also need either [Laravel Idea](https://laravel-idea.com) plugin (paid) or [Laravel IDE helper](https://github.com/barryvdh/laravel-ide-helper) added to your project and run 

```shell

php artisan ide-helper:generate

php artisan ide-helper:meta

php artisan ide-helper:models

php artisan ide-helper:eloquent

```

which will generate some helper files so your IDE could see Eloquent methods.

Laravel Query plugin needs either of those to work otherwise, it cannot understand for which methods to trigger autocompletion.

## Future plans

`V5` as a complete rewrite to reduce cognitive load, improve readability and maintainability. It is coming soon. [Branch](https://github.com/ekvedaras/laravel-query-intellij/tree/v5) already available for PRs and suggestions.

## Installation

- Using IDE built-in plugin system:

  

  Preferences > Plugins > Marketplace > Search for "Laravel Query" >

  Install Plugin

  

- Manually:

  Download the [latest release](https://github.com/ekvedaras/laravel-query-intellij/releases/latest) and install it manually using

  Preferences > Plugins > ⚙️ > Install plugin from disk...

---

Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template