README

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

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

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

If you experience any bugs or issues, please report them in the section OXID eShop (all versions) of https://bugs.oxid-esales.com.

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

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

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 for details and installation instructions.