Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oxid-esales/oxid-eshop-ide-helper
OXID eShop IDE Helper
https://github.com/oxid-esales/oxid-eshop-ide-helper
developer-tools ide-helpers oxid-eshop
Last synced: about 1 month ago
JSON representation
OXID eShop IDE Helper
- Host: GitHub
- URL: https://github.com/oxid-esales/oxid-eshop-ide-helper
- Owner: OXID-eSales
- License: other
- Created: 2016-11-17T14:33:14.000Z (about 8 years ago)
- Default Branch: b-8.0.x
- Last Pushed: 2024-11-07T14:50:06.000Z (about 2 months ago)
- Last Synced: 2024-11-07T15:33:10.887Z (about 2 months ago)
- Topics: developer-tools, ide-helpers, oxid-eshop
- Language: PHP
- Size: 96.7 KB
- Stars: 5
- Watchers: 18
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-6.x.md
- License: LICENSE
Awesome Lists containing this project
README
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`).
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.
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.