PhpStorm 2021.3 Help

拉拉维尔

Laravel是一个免费的开源 PHP Web 应用程序框架。它建立在几个Symfony组件之上,使身份验证、路由、会话和缓存等常见任务更容易实现。

在开始使用 Laravel 之前,请确保已安装并启用以下任一插件:

此外,请确保 Composer 已安装在您的计算机上并在当前项目中初始化,如Composer 依赖项管理器中所述。

观看此视频以快速了解 PhpStorm 中的 Laravel 支持:

安装 Laravel IDE 助手生成器

  1. 使用 Composer安装Laravel IDE 助手生成器。为此,请将barryvdh/laravel-ide-helper包的依赖项添加到composer.json。有关详细信息,请参阅安装依赖项。

  2. Laravel IDE 助手作为 a添加ServiceProvider到应用程序中。在config/app.php文件中,Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::classproviders元素下添加:

    return array( // ... 'providers' => array( // ... // Laravel IDE 助手 'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class', ), // ... );

Laravel IDE Helper 可能必须在更改或添加服务、控制器、模型和视图后运行。或者,在 PhpStorm 中设置文件观察器以在更新composer.json时自动重新生成此文件。

您还可以安装Laravel 生成器 Composer 包,为模型、视图、控制器等添加各种 Laravel 生成器。

编码协助

Laravel 插件为各种 Laravel 组件提供代码完成和导航:控制器、路由、视图、配置、服务和翻译。你还可以使用 Laravel 特定的实时模板来生成各种 Laravel 实体。

代码完成

在编辑器中,按下Ctrl+Space以调用代码完成并执行以下任一操作:

  • 使用RedirectRoute门面的各种功能时引用控制器:

    Laravel 控制器完成
  • View使用外观时引用 Blade 模板(或视图) :

    Laravel 视图补全
  • Configuration使用外观时引用我们应用程序设置中定义的各种键:

    Laravel 配置键补全
  • Lang使用和 调用时完成各种翻译键Lang::get()

    Laravel 翻译键补全

代码导航

要导航到项目的声明,请将插入符号放在其使用处,然后按Ctrl+B。或者,Ctrl+Click用法。

  • 导航到控制器的声明:

    导航到 Laravel 控制器声明
  • 导航到 Blade 模板(或视图)声明:

    导航到 Blade 模板声明
  • 导航到配置条目或服务的声明:

    导航到配置条目或服务声明
  • 导航到翻译键的声明:

    导航到翻译密钥声明

使用实时模板生成代码

PhpStorm 提供了许多代码生成工具。下载并安装PhpStorm Laravel Live Templates后,您可以使用 Laravel 特定的实时模板扩展标准实时模板集,例如:

  • 刀片指令

  • 输入和请求片段

  • 饼干片段

  • 路由片段和生成

  • 查看、响应和重定向模板

  • 构建模式(包括列类型)

  • 缓存

  • 表单和会话片段

  • 调用各种助手的片段

刀片模板支持

在开始之前,请确保Blade插件已安装并启用。Blade插件与PhpStorm 捆绑并默认激活。如果插件被禁用,请在设置/首选项的已安装选项卡上启用它。插件页面,如管理插件中所述。

PhpStorm 提供对Laravel Blade 模板引擎的全面支持。它突出显示了各种 Blade 语法结构,以及模板中的任何 HTML、JavaScript 和 CSS 代码。

除了语法高亮,PhpStorm 还提供了其他几个 Blade 特定的特性。

大括号和指令的代码完成

PhpStorm 的编辑器为标准和自定义 Blade 指令提供代码完成,可以在PHP |下的Settings/Preferences对话框 ( Ctrl+Alt+S)中定义。刀片

Laravel Blade 指令完成

使用@for@foreach指令时,可以在构造体中使用带有代码完成的变量引入。

Laravel Blade 变量介绍完成

部分支持

在处理 Blade 模板时,您可以使用该@section指令打开一个部分。PhpStorm 为Ctrl+Space项目中所有已知部分的名称提供代码完成。

Laravel Blade 部分完成

PhpStorm 提供代码检查,可检测未使用该@stop指令关闭的部分。

Laravel Blade 闭合截面检查

要导航到部分的声明,请将插入符号放在其用法处并按Ctrl+B。或者,Ctrl+Click用法。

Laravel 插件还向编辑器装订线添加了一个标记,让您可以导航到父部分。

通过装订线图标导航到父部分

扩展和包含的代码完成和导航

刀片模板通常由各种可重复使用的小块组成,这些块又是其他模板。您还可以扩展模板并为其他部分提供内容。PhpStorm 和 Laravel 插件在 the@extends@include指令中都提供了模板名称的补全。完成建议包括模板目录名称以及完整的模板名称。

Laravel Blade @extends 指令完成

要导航到模板的声明,请将插入符号放在其使用处,然后按Ctrl+B。或者,Ctrl+Click用法。

Blade 模板中的语言注入

使用 Blade 模板时,您可以在模板块中注入代码片段。PhpStorm 将为您提供全面的语言帮助来编辑该代码片段。

自动将 JavaScript 或 CSS 注入 Blade 模板部分

PhpStorm 可以根据定义的注入规则自动将代码注入 Blade 模板部分。开箱即用,自动注入 JavaScript 和 CSS 代码的规则可用。

  • 在 Blade 模板中,添加一个名为javascript(注入 JavaScript)或css(注入 CSS)的部分,如下所示:

    @section('javascript') // 注入 JavaScript 代码 @stop @section('css') // 注入 CSS 代码 @stop

    PhpStorm 会自动将 JavaScript 或 CSS 注入模板部分。

    在 Blade 模板中自动注入 JavaScript 和 CSS

调试刀片模板

您可以使用与常规 PHP 文件相同的技术来调试 Blade 模板。

启用刀片调试

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到PHP | 调试 | 模板并展开Blade Debug区域。

  2. 缓存路​​径字段中,提供 Blade编译模板缓存文件夹的绝对路径。手动键入路径或单击浏览按钮并在打开的对话框中选择相关文件夹。默认情况下,编译好的 Blade 模板存储在项目的storage/framework/views/文件夹中。

启动调试会话

按照Ultimate 调试指南中的说明启动调试会话。最简单和推荐的方法是使用零配置调试

  1. 选择并安装适合您浏览器的浏览器扩展。

  2. 在 PhpStorm 工具栏上,切换开始侦听 PHP 调试连接按钮以开始侦听传入的 PHP 调试连接,或选择Run | 从主菜单开始侦听 PHP 调试连接。

  3. 在代码中设置断点

  4. 使用已安装的浏览器扩展在浏览器中启动调试会话。

  5. 在调试会话期间,检查程序状态:查看变量值、计算表达式、逐步执行程序等。

配置刀片模板

添加、修改或删除 Blade 指令

Blade指令在Blade Page的Directives选项卡上进行管理。该选项卡列出了所有当前可用的Blade指令,对于那些具有参数的指令,还显示了前缀和后缀。当您开始时,该列表仅包含预定义的指令。您可以编辑这些指令以及创建自定义指令。

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到PHP | 刀片

  2. 在打开的Blade页面上,切换到Directives选项卡,其中显示了所有当前可用指令的列表。

    • 要定义新指令,请单击并在名称字段添加按钮中指定指令的名称。

      如果新指令需要前缀和后缀,请选中Has parameter复选框并分别在PrefixSuffix字段中键入要使用的前缀和后缀。PhpStorm 会自动将前缀和后缀括在前后括号和引号中,并添加冒号分隔符:,因此参数将如下所示:("<prefix>:<suffix>")

    • 要编辑现有指令,请在列表中选择它并更改以下字段中的值。

      要恢复原始定义,请单击重置为默认值按钮

    • 要从列表中删除指令,请选择它并单击删除按钮

配置刀片分隔符

PhpStorm 识别Blade模板并根据您指定的分隔符为它们提供错误突出显示和代码完成。

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到PHP | 刀片

  2. 在打开的Blade页面上,切换到Text Tags。选项卡中的字段显示原始标签内容标签转义标签的开始和结束字符。

  3. 这些字段使用符合Blade Templates 5.8的默认值填充。如果您使用的是早期版本,您可以指定相关的自定义分隔符,PhpStorm 将根据新规则提供编码帮助。

使用来自 PhpStorm 的 Artisan 命令行工具

PhpStorm 与 Laravel 中包含的Artisan 命令行界面集成,并提供了几个方便的命令。

自动配置 Artisan

手动配置 Artisan

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到工具 | 命令行工具支持

  2. 单击添加按钮工具栏上的 。

  3. 命令行工具对话框中,从列表中选择 Laravel,并指定其可见性级别(项目全局)。

    命令行工具对话框
  4. 单击OK时,将打开工具设置对话框。

    指定工具别名,提供artisan的路径,然后从PHP 解释器列表中选择一个配置的 PHP 解释器。有关详细信息,请参阅配置本地 PHP 解释器配置远程 PHP 解释器

    artisan 命令行工具设置
  5. 单击确定应用更改并返回命令行工具支持页面。或者,单击编辑按钮以编辑工具属性或编辑源按钮自定义命令集。有关详细信息,请参阅自定义工具

运行 Artisan 命令

  • 从主菜单中,选择工具 | 运行命令或按Ctrl两次。

    在打开的“运行任何内容”窗口中,以<artisan> <command>格式键入命令的调用。

    命令执行结果显示在运行工具窗口中。

    运行工匠命令

终止命令

调试 Artisan 命令

Laravel 命令在扩展的控制器类中定义Command。要调试命令,启动命令本身的调试会话至关重要,而不是它定义的控制器类文件。否则,Laravel 引导过程将被跳过,执行将失败。

  1. 在与所选命令对应的控制器类中,单击要设置断点的代码行处的编辑器装订线。

    在 Laravel 命令中设置断点
  2. 创建一个运行/调试配置,该配置将使用所选命令运行artisan工具。在主菜单中,选择运行 | 编辑配置,然后单击并从列表中添加按钮选择PHP 脚本。

    运行/调试配置:PHP 脚本
  3. PHP 脚本对话框中,提供运行/调试配置参数。

    • 文件字段中,提供工匠可执行文件的路径。

    • 参数字段中,键入实际命令及其参数,例如view:cache.

    Laravel CLI 命令的运行/调试配置对话框
  4. 在 PhpStorm 工具栏上,选择创建的运行/调试配置并单击调试按钮。命令执行将在指定的断点处停止。

    调试 Laravel 命令
最后修改:2021 年 8 月 31 日