cakephp-ide-helper

Improvements

Added a CodeCompletion shell on top of the existing ones to allow a more generic IDE support from now on.
You can generate a basic file that any IDE should understand. With this you can provide correct typehinting now for a lot of magic properties and methods that so far haven't worked.
See the documentation on details - and on how to write your own custom (project/plugin) tasks on top!

Give it a try - and let me know in the Wiki or via PR (pull request) if your IDE works out or what might still be missing.

MCGA - Make CakePHP Great Again! :)

Bugfixes

Generator:

• Auto-create the new ROOT folder if necessary for the meta file.

Improvements

Generator:

• With preemptive option enabled it will now also fetch and add all custom finders to auto-completion.
  But it seems to only be possible to add them all globally for the time being. Thus not all of them will work, you need to still load the behavior for it first in some cases.

Annotator:

• AppView annotations are now always added as they should enable the developer to use the View class access right away.

Improvements

Added even more IDE auto-completion for various magic strings:

• Table::find(): 'all', 'list', 'threaded' etc
• Table associations belongsTo(), hasOne(), hasMany(), belongsToMany(): all current tables

Further:

• For meta file generation it now uses a ROOT folder. Please make sure to remove the old ROOT file.
  This allows for custom and manual meta files on top.
• test_files and test_app test dirs are now removed for tagged releases, this avoids IDE warnings about multiple occurrences.

Improvements

Added IDE auto-completion for

• loadModel() for Controllers
• loadHelper() for Views
• loadComponent() for Controllers
• addBehavior() for Models

Also now allows to customize or skip certain native generator tasks.

Bugfixes

Fixed output of annotator. Count of added lines is now shown correctly.

Improvements

Also annotate the dynamic model factory calls:

• ModelAwareTrait: $this->loadModel('Users')
• LocatorAwareTrait: $this->getTableLocator()->get('Users')

Bugfixes

Use own error code (2) for CI and dry-run.

Enhancements

Static method call annotations

Added meta file generation for PHPStorm that allows static factory method calls to be typehinted.
For now mainly TableRegistry::get(...) calls are supported out of the box.

You can also easily add your own custom tasks to be used for the generation of this file.

Enhancements

Allow App helpers to be added by default

Improvements

Allow removing outdated annotations

Careful: This is still an alpha feature and experimental. Please backup everything before using -r flag and/or use -d (dry run) preview.

Allow custom entity column/field types

Often times you have a custom mapping of e.g. JSON, array or mediumtext/longtext columns in your DB.
The Bake plugin does not handle them all currently.
With the custom map config typeMap you can specify anything (and also overwrite the current IdeHelper defaults). If you want to unset, just set the value to false for a specific key.

More enhancements

• A preemptive config option has been added to be more pre-annotative especially in View templates.
• The output now is more verbose and tells you how many annotations have been added, updated, removed or skipped (due to comments those are considered custom annotations not to be touched).
• The mixin annotation is now fully supported.
• Method annotations can now have a description (also to prevent them from being modified or removed).
• Annotations can be marked as "in use" internally to avoid them being removed with -r flag.

Bugfixes

Normalize the diff output on CLI.

Enhancements

Added support for pagination annotations in Controllers.
This follows recent changes in Bake plugin that also does this.

Bugfixes

Allow for global phpcs installation to work well with this plugin.

Adjustments

Allow for new diff major.

Improvements

• Allow $ to be optional for property annotations.
• Allow configurable prefixes for controller annotations via IdeHelper.prefixes.

Improvements

Code modification relies on the PHP token parsing/updating of the PHP_CodeSniffer tool.

• PHP_CodeSniffer v2.8 and v3.0 are now both supported, depending on what coding standard in what version you have you can now still use this IdeHelper plugin.

Bugfixes

• Fix annotation generator for entity annotations around property tags to be properly merged.

Bugfixes

• Fix annotations for plugin controllers regarding components.

Adjustments

• Follow https://github.com/cakephp/bake/pull/337 to allow collection typehinting for entity collections in templates.

Bugfixes

• Fix plugin controller annotations

Improvements

• Support expressions like $this->Form->create($entity, ...) for template annotations

Bugfixes

Fix controllers and their component annotations

Improvements

• Fix ModelAnnotator to replace property annotations.
• Allow plugins to be annotated correctly.
• Added PHPStan check