Download the PHP package o3-shop/shop-ide-helper without Composer

On this page you can find all versions of the php package o3-shop/shop-ide-helper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package shop-ide-helper

IDE code completion support for O3-Shop

Build Status

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

To install this component, run the following command in the root directory of your O3-Shop:

Usage

To create or update the helper file, run the following command in the root directory of your O3-Shop project:

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

If you experience any bugs or issues, please report them in the section O3-Shop (all versions) of https://bugs.o3-shop.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 for details and installation instructions.

All versions of shop-ide-helper with dependencies

PHP Build Version
Package Version
Requires php Version >=7.0
smarty/smarty Version ^v2.6.30
o3-shop/shop-facts Version ^v1.0.0
symfony/filesystem Version ^3.3 || ^4.4.17
webmozart/path-util Version ^2.3
o3-shop/shop-unified-namespace-generator Version ^v1.0.00
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package o3-shop/shop-ide-helper contains the following files

Loading the files please wait ....