README

概要

此组件为您的 IDE 生成辅助文件，使您能够使用自动补全功能，以便向后兼容 OXID eShop 类（例如，类 oxArticle）。

生成的文件名为 .ide-helper.php（注意开头的点）。它位于您的 OXID eShop 项目的根目录中。

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

注意：在模块发生更改的情况下，请按以下说明更新辅助文件。

要安装此组件，请在您的 OXID eShop 根目录中运行以下命令

composer require --dev oxid-esales/oxideshop-ide-helper

要在您的 OXID eShop 项目根目录中创建或更新辅助文件，请运行以下命令

vendor/bin/oe-eshop-ide_helper

如果您升级了现有的 OXID eShop 版本（>= 6.x），则应在升级后更新 IDE 辅助文件。只需在升级过程之后运行上述命令即可。

如果您遇到任何错误或问题，请在 https://bugs.oxid-esales.com 的 OXID eShop（所有版本） 部分中报告。

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

有一个优秀的第三方插件适用于 PhpStorm，它补充了此 IDE 辅助组件的功能。有关详细信息，请参阅 Haehnchen 的 IntelliJ IDEA / PhpStorm 插件 for OXID。