NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist, #2600 most downloaded on Packagist
CakePHP IdeHelper Plugin to improve auto-completion
Latest stable
2.23.1
Last release 1 months ago
11 Oct 2026
Ships on a steady schedule
a new release about every 2 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
10 years old
207 releases · first in 2017
Drag across the ruler to compare, or tap a release to open it.
### Fixes - Fixed up paginate() annotation
Reverted mixed[] back to array as it brings no real value. The feature flag will still be able to enable array , though.
array<string, mixed>, though.Allow more complex array parsing for Illuminator and Annotator.
genericsInParam feature flag (NOT yet supported by most IDEs) - can be useful for PHPStan/Psalm.concreteEntitiesInParam feature flag (NOT recommended) - can be useful for PHPStan/Psalm.…
Full Changelog: https://github.com/dereuromark/cakephp-ide-helper/compare/2.4.0...2.5.0
Your coding agent can read these notes before it upgrades. Set up the MCP server →
sebastian/diff v6 compatibility by @LordSimal in https://github.com/dereuromark/cakephp-ide-helper/pull/355
Full Changelog: https://github.com/dereuromark/cakephp-ide-helper/compare/2.3.0...2.4.0
Add _joinData property for HABTM.
Included commits: https://github.com/dereuromark/cakephp-ide-helper/compare/2.2.4...2.3.0
Dont use appNamespace for plugins.
appNamespace for plugins.Included commits: https://github.com/dereuromark/cakephp-ide-helper/compare/2.2.3...2.2.4
Removed lying through annotation for HABTM relations.
Full Changelog: https://github.com/dereuromark/cakephp-ide-helper/compare/2.2.2...2.2.3
Added support for multiline annotations by @Harfusha in https://github.com/dereuromark/cakephp-ide-helper/pull/345
Full Changelog: https://github.com/dereuromark/cakephp-ide-helper/compare/2.2.1...2.2.2
Support more complex array shape annotations as well as union types within them for @var
@varcodeCompletionReturnType config added: Allow configuration of return type vs docblock for controller/component events. Use true to not allow void here
codeCompletionReturnType config added:
Allow configuration of return type vs docblock for controller/component events.
Use true to not allow void here for any such event, and always hardcode Response|null as return type (recommended).
Use false to only document types and here allow for void in general.
Added generics for table associations as opt-in. You can enable this by setting 'IdeHelper.assocsAsGenerics' config to true.
Added generics for table associations as opt-in.
You can enable this by setting 'IdeHelper.assocsAsGenerics' config to true.
e.g. WheelsTable:
- * @property \TestApp\Model\Table\CarsTable&\Cake\ORM\Association\BelongsTo $Cars
+ * @property \Cake\ORM\Association\BelongsTo<\TestApp\Model\Table\CarsTable> $Cars
This is designed to work with CakePHP 5.0.3+ and allows PHPStan to better see those associations and their actual type. The main idea here is that less inline annotations are needed for PHPStan/Psalm to detect those.
Inside Wheels table accessing Owner table methods through Cars:
$result = $this->Cars->Owner->someMethod();
Warning: This does not yet play well with most IDEs. The tradeoff seems to be that you lose IDE compatibility/autocomplete on the table methods here. So use with caution.
* @property \TestApp\Model\Enum\CarStatus $status ```
- * @property int $status
+ * @property \TestApp\Model\Enum\CarStatus $status
Full Changelog: https://github.com/dereuromark/cakephp-ide-helper/compare/2.0.1...2.0.2
Added missing View::addHelper() support
Added missing View::addHelper() support
Fix up docblock finding around Attribute usage.
Fixes compared to RC:
Note: The docs contain migration notes when coming from 4.x
Removed Shim as hidden dependency ("require" section)
Fixes:
### CakePHP 5 compatible pre-release For CakePHP 5.0+ apps.
For CakePHP 5.0+ apps.
Fix -p all on the annotate commands: all was treated as a plugin name instead of running over all app plugins
-p all on the annotate commands: all was treated as a plugin name instead of running over all app pluginsphpstan/phpdoc-parser 2.x and sebastian/diff 3.x (#481). Apps with cakephp/cakephp-codesniffer 4.x or PHPUnit 8 could only install 1.14.1, which fails in bin/cake phpstorm generate on find*() methods with a union-typed first parameterFull Changelog: https://github.com/dereuromark/cakephp-ide-helper/compare/1.21.0...1.21.1
Allow wildcard for partial match on plugin option: MyNamespace/* would run over all such matching app plugins
MyNamespace/* would run over all such matching app plugins-p all to run over all app pluginsReturn types for callbacks as docblock vs type
Backported features from v5:
Full Changelog: https://github.com/dereuromark/cakephp-ide-helper/compare/1.19.0...1.20.0
Backported addHelper() autocomplete for View from 5.x
Now CakePHP 4.4+
Fixed RoutesAnnotator to skip adding $routes where not needed due to new routes definition.
Fixed RoutesAnnotator to skip adding $routes where not needed due to new routes definition.
Remove return type for Controller events for now
Fixed compatibility with differ library versions.
Fixed compatibility with differ library versions.
### Improvements - Allow sebastian/diff v5 Note: PHP 7.4+ from here on
sebastian/diff v5Note: PHP 7.4+ from here on
Fixed infinite loop on annotate classes by @asgraf in https://github.com/dereuromark/cakephp-ide-helper/pull/296
Full Changelog: https://github.com/dereuromark/cakephp-ide-helper/compare/1.18.5...1.18.6
Fixed code completion scripts to have valid method signature and body for IDE not to report it.
Fixed code completion scripts to have valid method signature and body for IDE not to report it.
Enhanced further signature autocompletes for event callbacks.
Enhanced further signature autocompletes for event callbacks.
Added missing autocomplete for the "event" callback methods for
Added missing autocomplete for the "event" callback methods for
It includes full signature.
Just run bin/cake code_completion generate and enjoy!
E.g.:
Thx to @toggenation for his initiative and work on this one.
Fixed dependency to be declared directly.
Fixed dependency to be declared directly.
Fixed template docblocks to be recognized as main docblocks if clearly not license ones.
Fixed template docblocks to be recognized as main docblocks if clearly not license ones.
Allow entity virtual fields to be annotated with @see tag to directly link property and method in IDE.
PHP docblock parsing is now using PHPStan's functionality. This allows for more complex types, e.g. generics (array ), to be recognized and handled.
PHP docblock parsing is now using PHPStan's functionality.
This allows for more complex types, e.g. generics (array<int, int>), to be recognized and handled.
Note: The old alternative of @property \Cake\Controller\Component\SecurityComponent Security is now not working anymore, always needs a $ in front of property name now to be found as existing annotation (@property \Cake\Controller\Component\SecurityComponent $Security).
Also, added config objectAsGenerics (default false) allows to control the object collection annotations.
It seems IDEs (e.g. PHPStorm) are not able to handle those yet, specifically inside templates. See this for details.
It completes the existing arrayAsGenerics config which now only handles simple arrays.
It is recommended to use config 'templateCollectionObject' => 'iterable' here for templates if you are not passing your collections always as arrays.
Example config:
'arrayAsGenerics' => true,
'objectAsGenerics' => true,
'templateCollectionObject' => 'iterable',
Completed arrayAsGenerics config for controller and model classes
arrayAsGenerics config for controller and model classesFix for templates with declare() in PHP open tag
Support FQCN in belongsToMany through option, thx to @andrii-pukhalevych
Support FQCN in belongsToMany through option, thx to @andrii-pukhalevych
Annotation support for inline topics have been added:
/** @uses \App\Form\ReleaseForm::_execute() */
$result = $releaseForm->execute($data);
/** @uses \App\Mailer\NotificationMailer::notify() */
$notificationMailer->send('notify', [$username]);
You can use the new inline annotator functionality to add custom ones on top.
Added routes annotation for new dynamic style (as static setup is deprecated). Adds the following into routes.php files: ```diff <?php +/
<?php
+/**
+ * @var \Cake\Routing\RouteBuilder $routes
+ */
$routes->...
...
... = $entity->get('group_id'); // field $entity->group_id
... = $entity->get('group'); // association $entity->group
Cell autocomplete - thanks to @LordSimal
arrayAsGenerics config. It is disabled by default for BC, but recommended to enable if it fits to your coding standards.Updates for CakePHP 4.3+:
LocatorAwareTrait::fetchTable() autocomplete and return type support. Best to use this together with PHPStan extension.The main advantages of this release and the plugin in general can be used together with PHPStorm IDE, as that one provides the most comprehensive support for meta data.
Note: This plugin is now CakePHP 4.2+ and PHP 7.3+.
Fixed up Component annotator to respect configured application namespace (defaults to App otherwise)
Fixed up Component annotator to respect configured application namespace (defaults to App otherwise)
Allow also inherited loadModel() annotating.
loadModel() annotating.If you want to reuse existing argument sets from other tasks, you can now use the ArgumentsSet value object referencing them within your task:
If you want to reuse existing argument sets from other tasks, you can now use the ArgumentsSet value object referencing them within your task:
use IdeHelper\Generator\Directive\ExpectedArguments;
use IdeHelper\ValueObject\ArgumentsSet;
$method = '\\' . static::CLASS_FORMAT_HELPER . '::sidebarLink()';
$list = [
ArgumentsSet::create(FormatIconFontAwesome5Task::SET_ICONS_FONTAWESOME),
];
$directive = new ExpectedArguments($method, 1, $list);
Just make sure those argument sets are actually available, as this is not checked for you.
Disabling object collection annotation in templates is now possible using config templateCollectionObject set to false This way, if you always pass ar
Disabling object collection annotation in templates is now possible using config templateCollectionObject set to false
This way, if you always pass arrays of Entities for find() or paginate() calls, you can now reflect that.
You can also set a custom FQCN if you need to.
Allow using --ci flag on annotate subcommands
Allow using --ci flag on annotate subcommands
Fixed WinOS compatibility for Illuminator
Fixed WinOS compatibility for Illuminator
Skip table classes that have files ending in "Table" in the App\Model\Table namespace without them actually extending the CakePHP ORM Table class.
Skip table classes that have files ending in "Table" in the App\Model\Table namespace without them actually extending the CakePHP ORM Table class.
Add (App) controller annotation for components where needed. This helps to make application-specific controller usage available, e.g. loaded component
Add (App) controller annotation for components where needed. This helps to make application-specific controller usage available, e.g. loaded components.
With PHPStorm 2020.3.1 they finally fixed the broken/buggy behavior around meta data and trait/inheritance usage. Now it works as expected for PHP and
With PHPStorm 2020.3.1 they finally fixed the broken/buggy behavior around meta data and trait/inheritance usage. Now it works as expected for PHP and as such we can now ship some really awesome and useful new features for it:
setDirty(), setError(), getOriginal() and othersunload() auto-complete/suggestAdded Configure key autocomplete for
Added Configure key autocomplete for
Fixed key collision of DatabaseTableColumnNameTask vs DatabaseTableColumnTypeTask
Fixed key collision of DatabaseTableColumnNameTask vs DatabaseTableColumnTypeTask
Don't fail table task on empty DB.
Added several IDE autocomplete/typehinting:
Added several IDE autocomplete/typehinting:
$table->removeBehavior($alias)$this->Form->control()PHPStan level 8 now.
Fixed finders to be found and collected also in Table classes by default. So far only behavior ones were included and one had to use a special config
Fixed finders to be found and collected also in Table classes by default. So far only behavior ones were included and one had to use a special config for the others.
Fixture auto-complete added (CakePHP 4.1+)
Fixture auto-complete added (CakePHP 4.1+)
/**
* @return string[]
*/
protected function getFixtures(): array
{
$this->addFixture('core.Articles')
->addFixture('app.SomeModel')
->addFixture('plugin.Some/ComplicatedName.SomePluginModel');
return parent::getFixtures();
}
Example image:
Added new 2020.01 meta directive ExitPoint
ExitPointFixed deprecated Type calls to TypeFactory ones
Type::map() autocomplete@property-read (read-only).Router::pathUrl()UrlHelper::buildFromPath()HtmlHelper::linkFromPath()Note: Requires cakephp/bake 2.1+ now and with it the new CakePHP TwigView plugin.
URL generation has never been this easy and fast. Type 1-2 chars and select quickly what you meant. Almost mind-reading capability here :)
Fixed file existence checks for Translate task.
Fixed file existence checks for Translate task.
Fixed notice for Translate task.
Fixed notice for Translate task.
FIxed generation of directives for chainable methods from Override to ExpectedArguments.
FIxed generation of directives for chainable methods from Override to ExpectedArguments.
Added several more IDE autocomplete improvements as generator tasks.
The most useful and important one is autocomplete now for __() and __d() translating:
Also:
DatabaseTableColumnNameTask added
Column names:
Column types:
Added Plugin whitelist and blacklist as IdeHelper.plugins. This makes it possible to already generate and annotate based on not loaded plugins, since
IdeHelper.plugins. This makes it possible to already generate and annotate based on not loaded plugins, since plugins often do not have to be loaded to function.DatabaseTableTask generator task. This task is useful when using Migrations plugin and creating Migration files.Fixed prefixed (e.g. Admin) Controller to be annotated properly.
Fixed prefixed (e.g. Admin) Controller to be annotated properly.
Allow for custom project namespace (default is usually App).
App).binaryuuid Type class type as string in entities.One column per quarter.