IDE Helper for OctoberCMS - Documentation

IDE Helper enhances your OctoberCMS development experience by providing seamless integration with popular IDEs such as PHPStorm and VSCode. By generating helper files, this plugin enables powerful autocompletion, accurate syntax highlighting, and real-time error checking, significantly improving developer productivity and code maintenance.

Installation via OctoberCMS Marketplace

The recommended way to install IDE Helper is directly from the OctoberCMS Marketplace.

1. Open your OctoberCMS administration panel.
2. Navigate to Settings → Updates & Plugins.
3. Click on Install plugins.
4. Search for "IDE Helper by IC Studio" and click on Install.

Manual Installation (Optional)

Alternatively, you can manually install the plugin:

cd plugins
git clone https://github.com/icstudio-ua/oc-idehelper-plugin icstudio/idehelper
cd icstudio/idehelper
composer install
php artisan ide-helper:generate

Advanced Configuration

While IDE Helper requires minimal configuration out-of-the-box, additional features can be enabled for enhanced model analysis:

Generating Model Helper Files

If you wish to generate helper files specifically for your models, use the following command:

php artisan ide-helper:models

You may need to adjust your /config/config.php to include specific model files that should be scanned.

Requirements

Ensure your environment meets the following requirements:

• OctoberCMS version 3.x
• PHP 8.0 or higher

Key Features

• Enhanced IDE Integration: Automatically generates IDE helper files for OctoberCMS, leveraging Laravel IDE Helper.
• Improved Productivity: Accelerates coding with advanced autocompletion, robust navigation, and real-time code assistance.
• Simplified Code Maintenance: Provides clear visibility of methods, properties, and relationships within OctoberCMS models.
• Supports Multiple IDEs: Compatible with major IDEs, including PHPStorm and VSCode.
• Ease of Use: Requires minimal setup—get started quickly with just a few simple commands.

Troubleshooting

If you encounter any issues:

• Make sure your Composer dependencies are updated by running composer update.
• Ensure your PHP version is compatible (8.0 or above).
• Double-check paths in your /config/config.php file if using model helpers.

License

This project is distributed under the MIT License.

Make your coding process faster and more enjoyable with IDE Helper for OctoberCMS!

IDE Helper for OctoberCMS - Upgrade Guide

Follow these simple steps to upgrade IDE Helper to the latest version:

Upgrade via OctoberCMS Marketplace

1. Open your OctoberCMS administration panel.
2. Navigate to Settings → Updates & Plugins.
3. Check for available updates.
4. Click Update next to "IDE Helper by IC Studio".

Manual Upgrade

If you've installed IDE Helper manually, follow these steps:

cd plugins/icstudio/idehelper
git pull
composer update
php artisan ide-helper:generate

Post-Upgrade Recommendations

• Clear your application cache to ensure the latest helper files are active:

php artisan cache:clear

• Optionally regenerate model helper files:

php artisan ide-helper:models

Ensure that your environment meets the requirements:

• OctoberCMS version 3.x
• PHP 8.0 or higher