o3-shop/shop-ide-helper

O3-Shop IDE辅助工具,用于代码补全

v1.0.0 2023-03-05 15:26 UTC

This package is auto-updated.

Last update: 2024-09-30 01:29:07 UTC


README

Build Status

概要

此组件为您生成IDE辅助文件,使您能够对向后兼容的O3-Shop类(例如,类oxArticle)使用自动补全。

生成的文件名为.ide-helper.php(注意开头的点)。它位于您的O3-Shop项目根目录中。

此外,此组件还会为PhpStorm IDE生成辅助文件,以便点击命名空间模块的虚拟父类(*_parent)。生成的文件名为.phpstorm.meta.php/oxid.meta.php。这使您能够找到由模块扩展的关联商店类。

注意:在模块发生更改时,请按照以下说明更新辅助文件。

安装

要安装此组件,请在您的O3-Shop根目录中运行以下命令

composer require --dev o3-shop/shop-ide-helper

用法

要在O3-Shop项目根目录中创建或更新辅助文件,请运行以下命令

vendor/bin/oe-eshop-ide_helper

如果您升级了现有的O3-Shop版本(>= 6.x),则应随后更新IDE辅助文件。只需在升级过程之后运行上述命令即可。

错误和问题

如果您遇到任何错误或问题,请在https://bugs.o3-shop.comO3-Shop(所有版本)部分中报告它们。

已知问题

虚拟模块父类(*_parent)是可点击的,但类链未构建。这影响多个模块链式扩展相同商店类的情况。未命名空间模块的虚拟父类不可点击。

PhpStorm用户注意事项

有一个优秀的第三方插件,可以补充此IDE辅助组件的功能。有关详细信息和使用说明,请参阅Haehnchen的IntelliJ IDEA / PhpStorm插件