oxid-esales/oxideshop-ide-helper

OXID eShop IDE helper for code completion

Tuesday, July 31, 2018
by oxid
Repository
14 Watchers
3 Stars
23,300 Installations

PHP
3 Dependents
0 Suggesters
1 Forks
0 Open issues
19 Versions
18 % Grown

The README.md

IDE code completion support for OXID eShop

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)., _(*1)

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., _(*2)

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., _(*3)

NOTE: in case of changes in modules please update the helper file as described below., _(*4)

Installation

To install this component, run the following command in the root directory of your OXID eShop:, _(*5)

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:, _(*6)

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., _(*7)

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., _(*8)

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., _(*9)

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., _(*10)

The Versions

31/07 2018

dev-master

9999999-dev

OXID eShop IDE helper for code completion

library oxideshop-ide-helper

OXID eShop IDE helper for code completion

oxid-esales/oxideshop-ide-helper

The README.md

IDE code completion support for OXID eShop

Synapsis

Installation

Usage

Bugs and Issues

Known Issues

Note for PhpStorm users

The Versions

dev-master

The Requires

The Development Requires

v3.1.1

The Requires

The Development Requires

dev-without_unified_ns_gen

The Requires

The Development Requires

v3.1.0

The Requires

The Development Requires

dev-master-add_phpstorm_oxnew_autocompletion

The Requires

The Development Requires

v3.0.0-beta.2

The Requires

The Development Requires

v3.0.0

The Requires

The Development Requires

dev-ESDEV-4524

dev-SPIKE_unified_namespaces-ESDEV-4500

dev-TMP

v3.0.0-beta.1

v2.0.5

v2.0.4

dev-ide_helper_without_config

v2.0.3

v2.0.2

v2.0.1

v2.0.0

v1.0.0