dereuromark/cakephp-ide-helper

CakePHP IdeHelper Plugin to improve auto-completion

2.5.4 2024-11-19 12:55 UTC

Requires

• php: >=8.1
• cakephp/bake: ^3.0.4
• cakephp/cakephp: ^5.0.7
• phpstan/phpdoc-parser: ^1.23.1
• sebastian/diff: ^5.0 || ^6.0
• squizlabs/php_codesniffer: ^3.8

Requires (Dev)

• cakephp/migrations: ^4.0.1
• cakephp/plugin-installer: ^2.0.1
• dereuromark/cakephp-shim: ^3.3.0
• fig-r/psr2r-sniffer: dev-master
• phpunit/phpunit: ^10.5.5 || ^11.1.3

MIT

• Mark Scherer
• Other contributors

• annotations
• phpdoc
• plugin
• autocomplete
• cakephp
• dev
• ide
• phpstorm

README

IdeHelper plugin for CakePHP applications.

Boost your productivity. Avoid mistakes.

This branch is for use with CakePHP 5.0+. For details see version map.

Features

The main idea is to improve IDE compatibility and use annotations to make the IDE understand the "magic" of CakePHP, so you can click through the class methods and object chains as well as spot obvious issues and mistakes easier. The IDE will usually mark problematic code yellow (missing, wrong method etc).

This also improves compatibility with tools like PHPStan. Those can then follow the code easier and provide more valuable help.

• Add annotations to existing code (e.g. when upgrading an application) just like baking would to new code.
• Can run multiple times without adding the annotations again.
• It can also replace or remove outdated annotations.
• Works with your application as well as any loaded plugin.
• CI check support, hook it up just like the coding standards check.

Supports annotations for:

• Models (Tables and Entities)
• Controllers (including prefixes like Admin) and Components
• View (AppView) and Helpers
• Templates (.php PHP template files including elements)
• Commands, Shells and Tasks
• ... and more

Supports code completion help for:

• Behaviors (property access on the BehaviorRegistry)

Supports IDE autocomplete/typehinting of (magic)strings as well as return types/values for:

• Plugins, Components, Behaviors, Helpers, Mailers
• Associations, Validation
• I18n Translation, Cache
• Elements and layouts
• Tables and their fields
• Route paths, Request/ENV, Connection
• ... and more (using PhpStorm meta file)

Supports better IDE usage with Illuminator tasks to enhance existing code:

• EntityFieldTask adds all entity fields as class constants for easier usage in IDEs

IDE support

This plugin is supposed to work with ANY IDE that supports annotations and code completion. IDEs tested so far for 100% compatibility:

• PhpStorm (incl. meta file generator)
• IntelliJ
• Atom
• VS Code
• ... [Report or PR your IDE of choice here to confirm its full compatibility]

See Wiki for details and tips/settings.

Plugins with meta file generator tasks

The following plugins use this plugin to improve IDE compatibility around factory and magic string usage:

• Migrations for migration file writing (included in IdeHelper directly).
• Queue for QueuedJobsTable::createJob() usage.
• Burzum/CakeServiceLayer for loadService() usage.
• ... (add yours here)

Plugins with Illuminator tasks

• StateMachine for syncing states from XML into PHP.
• ... (add yours here)

More

More collections of useful tasks can be found in the IdeHelperExtra plugin.

Install, Setup, Usage

See the Docs for details.