PHPackages o3-shop/shop-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. o3-shop/shop-ide-helper ActiveLibrary[Utility & Helpers](/categories/utility) o3-shop/shop-ide-helper ======================= O3-Shop IDE helper for code completion v1.0.2(1w ago)05.6k↑167.6%2GPL-3.0-onlyPHPPHP >=7.0 Since Mar 5Pushed 1mo agoCompare [ Source](https://github.com/o3-shop/shop-ide-helper)[ Packagist](https://packagist.org/packages/o3-shop/shop-ide-helper)[ RSS](/packages/o3-shop-shop-ide-helper/feed)WikiDiscussions main Synced 2d ago READMEChangelog (2)Dependencies (21)Versions (7)Used By (2) IDE code completion support for O3-Shop ======================================= [](#ide-code-completion-support-for-o3-shop) [![Build Status](https://camo.githubusercontent.com/3f432d8bd9e7de189608f6901c67c982ee5b9ed82287188460ccf6b72173eecd/68747470733a2f2f7472617669732d63692e6f72672f6f332d73686f702f6f332d73686f702d6964652d68656c7065722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/o3-shop/o3-shop-ide-helper) Synapsis -------- [](#synapsis) This component generates a helper file for your IDE, which enables you to use autocompletion for backwards compatible O3-Shop 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 O3-Shop 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 O3-Shop: ``` composer require --dev o3-shop/shop-ide-helper ``` Usage ----- [](#usage) To create or update the helper file, run the following command in the root directory of your O3-Shop project: ``` vendor/bin/oe-eshop-ide_helper ``` If you upgrade an existing O3-Shop 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 **O3-Shop (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. 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 47 — FairBetter than 93% of packages Maintenance93 Actively maintained with recent releases Popularity24 Limited adoption so far Community17 Small or concentrated contributor base Maturity45 Maturing project, gaining track record Bus Factor1 Top contributor holds 60% of commits — single point of failure 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 ~603 days Total 3 Last Release 9d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/53b105106ade5f151851db1839b344f7be04f17d881c49ca0f4da0867d5b2d82?d=identicon)[o3-shop](/maintainers/o3-shop) --- Top Contributors [![nlo-tronet](https://avatars.githubusercontent.com/u/206915827?v=4)](https://github.com/nlo-tronet "nlo-tronet (6 commits)")[![o3-shop-user](https://avatars.githubusercontent.com/u/115017537?v=4)](https://github.com/o3-shop-user "o3-shop-user (2 commits)")[![ralftrapp](https://avatars.githubusercontent.com/u/74130839?v=4)](https://github.com/ralftrapp "ralftrapp (2 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/o3-shop-shop-ide-helper/health.svg) ``` [![Health](https://phpackages.com/badges/o3-shop-shop-ide-helper/health.svg)](https://phpackages.com/packages/o3-shop-shop-ide-helper) ``` ### Alternatives [aws/aws-sdk-php AWS SDK for PHP - Use Amazon Web Services in your PHP project 6.3k543.5M2.6k](/packages/aws-aws-sdk-php)[symfony/config Helps you find, load, combine, autofill and validate configuration values of any kind 4.3k479.6M8.4k](/packages/symfony-config)[friendsofphp/php-cs-fixer A tool to automatically fix PHP code style 13.5k251.2M25.2k](/packages/friendsofphp-php-cs-fixer)[symfony/asset-mapper Maps directories of assets & makes them available in a public directory with versioned filenames. 1678.8M238](/packages/symfony-asset-mapper)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.1k17.8k](/packages/prestashop-prestashop)[pocketmine/pocketmine-mp A server software for Minecraft: Bedrock Edition written in PHP 3.5k78.3k90](/packages/pocketmine-pocketmine-mp) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)