PHPackages oxid-esales/oxideshop-ide-helper - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. oxid-esales/oxideshop-ide-helper ActiveLibrary[Utility & Helpers](/categories/utility) oxid-esales/oxideshop-ide-helper ================================ OXID eShop IDE helper for code completion v6.5.0(2mo ago)6534.2k↓32%61proprietaryPHPPHP >=8.3 Since Dec 8Pushed 1mo ago14 watchersCompare [ Source](https://github.com/OXID-eSales/oxid-eshop-ide-helper)[ Packagist](https://packagist.org/packages/oxid-esales/oxideshop-ide-helper)[ RSS](/packages/oxid-esales-oxideshop-ide-helper/feed)WikiDiscussions b-8.0.x Synced 3d ago READMEChangelog (8)Dependencies (11)Versions (40)Used By (1) IDE code completion support for OXID eShop ========================================== [](#ide-code-completion-support-for-oxid-eshop) Synapsis -------- [](#synapsis) This component generates a helper file for your IDE, which enables you to use autocompletion for backwards compatible OXID eShop classes (e.g. class `oxArticle`). The name of the generated file is `.ide-helper.php` (note the leading dot). It's located in the root directory of your OXID eShop project. Also this component generates a helper file for PhpStorm IDE so that virtual module parent classes (\*\_parent) of namespaced modules are clickable. The name of the generated file is `.phpstorm.meta.php/oxid.meta.php`. This enables you to find the related shop class that is extended by a module. NOTE: in case of changes in modules please update the helper file as described below. Installation ------------ [](#installation) To install this component, run the following command in the root directory of your OXID eShop: ``` composer require --dev oxid-esales/oxideshop-ide-helper ``` Usage ----- [](#usage) To create or update the helper file, run the following command in the root directory of your OXID eShop project: ``` vendor/bin/oe-eshop-ide_helper ``` If you upgrade an existing OXID eShop edition (>= 6.x), the IDE helper file should be updated afterwards. Simply run the above command after the upgrade process. Bugs and Issues --------------- [](#bugs-and-issues) If you experience any bugs or issues, please report them in the section **OXID eShop (all versions)** of . Known Issues ------------ [](#known-issues) Virtual module parent classes (\*\_parent) are clickable but the class chain is not built. This affects the case that multiple modules chain extend the same shop class. Virtual parent classes for not namescpaed modules are not clickable. Development ----------- [](#development) To run the tests, install the dev dependencies in the module root directory and run it from there: ``` cd vendor/oxid-esales/oxideshop-ide-helper composer install vendor/bin/phpunit tests --bootstrap=/var/www/source/bootstrap.php ``` Note for PhpStorm users ----------------------- [](#note-for-phpstorm-users) There is an excellent third-party plug-in for PhpStorm, which complements the functionality of this IDE helper component. See [Haenchen's IntelliJ IDEA / PhpStorm Plugin for OXID](https://github.com/Haehnchen/idea-php-oxid-plugin)for details and installation instructions. ### Health Score 66 — FairBetter than 99% of packages Maintenance86 Actively maintained with recent releases Popularity43 Moderate usage in the ecosystem Community28 Small or concentrated contributor base Maturity90 Battle-tested with a long release history Bus Factor4 4 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~142 days Recently: every ~107 days Total 25 Last Release 87d ago Major Versions v3.1.2 → v4.0.02020-11-04 v4.1.0 → v5.0.02021-07-06 v4.2.0 → v6.0.02022-10-28 v6.3.0 → v7.0.0-alpha.12025-02-03 v6.4.1 → v8.0.0-alpha.22026-02-12 PHP version history (7 changes)v3.0.0PHP >=5.6 v4.0.0PHP >=7.0 v5.0.0PHP >=7.3 v4.2.0PHP >=7.4 v6.0.0PHP >=8.0 v6.3.0PHP >=8.2 v6.5.0PHP >=8.3 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1374817?v=4)[oxid](/maintainers/oxid)[@OxID](https://github.com/OxID) --- Top Contributors [![liulka-oxid](https://avatars.githubusercontent.com/u/56023474?v=4)](https://github.com/liulka-oxid "liulka-oxid (20 commits)")[![robertblank](https://avatars.githubusercontent.com/u/7868142?v=4)](https://github.com/robertblank "robertblank (18 commits)")[![Sieg](https://avatars.githubusercontent.com/u/98882?v=4)](https://github.com/Sieg "Sieg (13 commits)")[![AshrafOxid](https://avatars.githubusercontent.com/u/145345202?v=4)](https://github.com/AshrafOxid "AshrafOxid (13 commits)")[![kenariosz](https://avatars.githubusercontent.com/u/2828175?v=4)](https://github.com/kenariosz "kenariosz (11 commits)")[![daveoxs](https://avatars.githubusercontent.com/u/298579544?v=4)](https://github.com/daveoxs "daveoxs (7 commits)")[![moritzdemmer](https://avatars.githubusercontent.com/u/56080577?v=4)](https://github.com/moritzdemmer "moritzdemmer (5 commits)")[![godefroy-le-hardi](https://avatars.githubusercontent.com/u/31134636?v=4)](https://github.com/godefroy-le-hardi "godefroy-le-hardi (5 commits)")[![RahatHameed](https://avatars.githubusercontent.com/u/11661532?v=4)](https://github.com/RahatHameed "RahatHameed (4 commits)")[![MantasVaitkunas](https://avatars.githubusercontent.com/u/623436?v=4)](https://github.com/MantasVaitkunas "MantasVaitkunas (4 commits)")[![a-afsharfarnia](https://avatars.githubusercontent.com/u/54709809?v=4)](https://github.com/a-afsharfarnia "a-afsharfarnia (3 commits)")[![sauliusstasiukaitis](https://avatars.githubusercontent.com/u/3603014?v=4)](https://github.com/sauliusstasiukaitis "sauliusstasiukaitis (2 commits)")[![boesing](https://avatars.githubusercontent.com/u/2189546?v=4)](https://github.com/boesing "boesing (2 commits)")[![MohannadAlturk](https://avatars.githubusercontent.com/u/122265543?v=4)](https://github.com/MohannadAlturk "MohannadAlturk (2 commits)")[![AlfonsMartin](https://avatars.githubusercontent.com/u/35966734?v=4)](https://github.com/AlfonsMartin "AlfonsMartin (2 commits)")[![cgsmith](https://avatars.githubusercontent.com/u/570018?v=4)](https://github.com/cgsmith "cgsmith (1 commits)")[![sebbbbauer](https://avatars.githubusercontent.com/u/1807282?v=4)](https://github.com/sebbbbauer "sebbbbauer (1 commits)")[![tarique-iqbal](https://avatars.githubusercontent.com/u/89069083?v=4)](https://github.com/tarique-iqbal "tarique-iqbal (1 commits)") --- Tags developer-toolside-helpersoxid-eshop ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/oxid-esales-oxideshop-ide-helper/health.svg) ``` [![Health](https://phpackages.com/badges/oxid-esales-oxideshop-ide-helper/health.svg)](https://phpackages.com/packages/oxid-esales-oxideshop-ide-helper) ``` ### Alternatives [easycorp/easyadmin-bundle Admin generator for Symfony applications 4.3k17.9M388](/packages/easycorp-easyadmin-bundle)[craftcms/cms Craft CMS 3.6k3.6M3.1k](/packages/craftcms-cms)[drupal/core Drupal is an open source content management platform powering millions of websites and applications. 21866.0M1.7k](/packages/drupal-core)[phpactor/phpactor PHP refactoring and intellisense tool for text editors 1.9k17.1k1](/packages/phpactor-phpactor)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.6M574](/packages/shopware-core)[metamodels/core MetaModels core 10156.4k68](/packages/metamodels-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)