OXID-eSales/oxid-eshop-ide-helper

Name: oxid-eshop-ide-helper

Owner: OXID eSales AG

Description: OXID eShop IDE Helper

Created: 2016-11-17 14:33:14.0

Updated: 2018-03-07 10:58:26.0

Pushed: 2018-02-12 15:44:33.0

Homepage: null

Size: 31

Language: PHP

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

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.

Installation

To install this component, run the following command in the root directory of your OXID eShop:

oser 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:

or/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.

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.