Controllers

All controllers should at least annotate their primary model. They should also annotate the other loaded models as well as the loaded components.

bin/cake annotate controllers

Primary Model via Convention

<?php
namespace App\Controller;

class ApplesController extends AppController {
}

becomes:

<?php
namespace App\Controller;

/**
 * @property \App\Model\Table\ApplesTable $Apples
 */
class ApplesController extends AppController {
}

You get autocompletion on any $this->Apples->...() usage in your controllers.

Use -p PluginName to annotate inside a plugin.

Plugin wildcards

Use * to refer to a group of plugins, e.g. -p SomePrefix/* for everything under your own plugins/ directory. You can also use all for all app plugins.

For more than one plugin the command will not run into vendor/ plugins, to avoid accidental modification there.

Primary Model via $defaultTable

When defining $defaultTable it will be used instead:

<?php
namespace App\Controller;

/**
 * @property \App\Model\Table\MyApplesTable $MyApples
 */
class ApplesController extends AppController {

    protected ?string $defaultTable = 'MyApples';

}

Custom Prefixes

By default, the annotator supports any prefix for your controllers (as a subfolder). Using the Configure key 'IdeHelper.prefixes' you can configure a prefix whitelist.