Fixes

• Remove return type for Controller events for now

Fixes

Fixed compatibility with differ library versions.

Improvements

• Allow sebastian/diff v5

Note: PHP 7.4+ from here on

Fixes

• Fixed infinite loop on annotate classes by @asgraf in https://github.com/dereuromark/cakephp-ide-helper/pull/296

New Contributors

• @asgraf made their first contribution 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

Fixes

Fixed code completion scripts to have valid method signature and body for IDE not to report it.

Improvements

Enhanced further signature autocompletes for event callbacks.

Improvements

Added missing autocomplete for the "event" callback methods for

• Controllers, components
• Models, behaviors
• Helpers

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.

Fixes

Fixed dependency to be declared directly.

Fixes

Fixed template docblocks to be recognized as main docblocks if clearly not license ones.

Improvements

Allow entity virtual fields to be annotated with @see tag to directly link property and method in IDE.

Improvements

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',

Improvements

• Completed arrayAsGenerics config for controller and model classes

Fixes

• Quick fixed an issue with directives

Fixes

• Fix for templates with declare() in PHP open tag
• Fix generator's TableFinderTask to not fail on union types, thx to @passchn
• Skip routes annotation if present already anywhere in file

Improvements

FQCN usage in associations

Support FQCN in belongsToMany through option, thx to @andrii-pukhalevych

Inline annotations

Annotation support for inline topics have been added:

Form

/** @uses \App\Form\ReleaseForm::_execute() */
$result = $releaseForm->execute($data);

Mailer

/** @uses \App\Mailer\NotificationMailer::notify() */
$notificationMailer->send('notify', [$username]);

Custom

You can use the new inline annotator functionality to add custom ones on top.

Improvements

• Added routes annotation for new dynamic style (as static setup is deprecated).
  Adds the following into routes.php files:

 <?php
+/**
+ * @var \Cake\Routing\RouteBuilder $routes
+ */
 
 $routes->...
 ...

• Make sure virtual fields and relation-based (association) properties are also autocompleted for EntityTask of meta file generator.

... = $entity->get('group_id'); // field $entity->group_id
... = $entity->get('group'); // association $entity->group

Improvements

• Cell autocomplete - thanks to @LordSimal

• Array generics support in doc blocks using 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+.

Fixes

Fixed up Component annotator to respect configured application namespace (defaults to App otherwise)

Improvements

• Allow also inherited loadModel() annotating.

Improvements

Reusing existing argument sets

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.

Improvements

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.