PhpStorm 2025.2 Help

Joomla!

将 PhpStorm 用作 Joomla! 开发的 IDE。

在 PhpStorm 中启用 Joomla! 支持

选项 1:在 PhpStorm 设置中启用 Joomla! 支持

  1. 打开 设置Ctrl+Alt+S| PHP | 框架

  2. 展开 Joomla! 节点,选择 启用 Joomla! 集成 复选框,并按如下所示指定参数:

    在设置中启用 Drupal 支持

    Joomla! 安装 路径

    指定包含已安装 Joomla! 核心的根目录路径。

    JConfig 的路径

    指定包含 Joomla 的 JConfig 类定义的 configuration.php 文件路径。

  3. 请点击 Apply 以保存更改。

选项 2:从 Joomla! 模板创建一个新的 PhpStorm 项目

您可以在 PhpStorm 中从 Joomla! 集成 模板创建一个新的 Joomla! 项目。

PhpStorm 创建了一个包含 PHP 类 <project name>.php <project name>.xml 清单文件 的 Joomla! 项目模板。 如需更多信息,请参阅 www.joomla.org

  1. 通过在主菜单中选择 文件 | 新建项目 或单击 PhpStorm 欢迎屏幕上的 创建新项目 ,打开 新项目 对话框。

  2. 在左侧窗格中选择 Joomla! 集成

  3. 在右侧窗格中, 指定 Joomla! 支持参数。 在 项目类型 字段中,从列表中选择一个 Joomla! 项目类型 (组件、模块或插件)。

选项 3:导入现有的 Joomla! 项目

当您在主菜单中打开(文件 | 打开 )一个 Joomla! 模块、插件或扩展,或 Joomla! 核心目录时,IDE 会识别 Joomla! 特定的项目结构并建议激活 Joomla! 支持。

检测到 Joomla 项目结构

单击 启用支持 打开模态对话框,并 指定参数

    安装 Joomla DocBlock 模板

    当 PhpStorm 识别到 Joomla! 项目结构时,它会建议安装 Joomla DocBlocks 标准,用于 PHP 文件、类、类属性等。

    Joomla DocBlocks 安装通知

    在 PhpStorm 项目中设置 Joomla! 代码样式

    如果 PhpStorm 识别该项目为 Joomla! 模块、插件或扩展,它会自动建议为该项目应用预配置的 Joomla! 代码样式。

    启用 Joomla! 样式格式化

    手动更改代码样式设置

    您还可以在 代码样式:PHP 页面 上手动设置预定义的代码样式。

    1. 设置 对话框(Ctrl+Alt+S )中,导航到 编辑器 | 代码样式 | PHP

    2. 单击 设置从 并从打开的下拉列表中选择 Joomla!

    检测 Joomla! 项目中的数据库

    PhpStorm 检测项目中的数据库。 请点击 "添加"按钮数据库工具窗口 工具窗口,并选择 导入数据源。 检测到文件 configuration.php 中指定的设置,并将其用于新的数据源连接。

    PhpStorm 提供数据库前缀支持,并将 #__ 更改为在 configuration.php 文件的 $dbprefix 字段中定义的前缀。

    此外,PhpStorm 会检测与您的数据库类型匹配的 SQL 方言,并显示通知,提示您自动设置检测到的默认方言或在 设置 对话框(Ctrl+Alt+S )的 SQL 方言 页面上手动配置。

    默认 SQL 方言通知

    根据 Joomla 编码标准检查代码

    使用 PhpStorm,您可以结合使用 PHP_CodeSniffer 工具(检测编码标准问题)和 Joomla 编码标准 (为 PHP_CodeSniffer 提供一组 Joomla 特定标准)。 这将确保您的代码干净、一致,并避免一些常见错误。

    要开始,请使用 安装并配置 PHP_CodeSniffer 中描述的任何方法安装 PHP_CodeSniffer。 可能最简单的方法是使用 Composer 安装它。

    安装 PHP_CodeSniffer

    1. composer.json 中,将 squizlabs/php_codesniffer 依赖项记录添加到 requirerequire-dev 键中。 要获取包名称和版本的代码补全,请按 Ctrl+Space

    2. 请执行以下操作之一:

      • 单击编辑器面板顶部的 安装 快捷链接。

      • 如果启用了 未安装的 Composer 包 检查,PhpStorm 将突出显示当前未安装的声明依赖项。 按 Alt+Enter 并选择是要安装特定依赖项还是一次性安装所有依赖项。

    接下来,安装 Joomla 编码标准 ,它将为 PHP_CodeSniffer 提供 Joomla 特定标准。

    安装 Joomla 编码标准

    1. composer.json 中,将 joomla/coding-standards 依赖项记录添加到 requirerequire-dev 键中。 要获取包名称和版本的代码补全,请按 Ctrl+Space

    2. 请执行以下操作之一:

      • 单击编辑器面板顶部的 安装 快捷链接。

      • 如果启用了 未安装的 Composer 包 检查,PhpStorm 将突出显示当前未安装的声明依赖项。 按 Alt+Enter 并选择是要安装特定依赖项还是一次性安装所有依赖项。

    Joomla 编码标准 包将被安装,并且相应的 Joomla 标准将自动为 PHP_CodeSniffer 验证 检查选择。 如果需要,您可以在 编辑器|检查 页面的 设置 对话框中(Ctrl+Alt+S )进一步自定义检查。 欲了解更多信息,请参阅 启用 PHP_CodeSniffer 作为 PhpStorm 检查

    最后修改日期: 2025年 9月 26日