PHPackages                             dereuromark/cakephp-ide-helper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI &amp; Console](/categories/cli)
4. /
5. dereuromark/cakephp-ide-helper

ActiveCakephp-plugin[CLI &amp; Console](/categories/cli)

dereuromark/cakephp-ide-helper
==============================

CakePHP IdeHelper Plugin to improve auto-completion

2.16.1(2mo ago)1862.1M—1.6%41[4 issues](https://github.com/dereuromark/cakephp-ide-helper/issues)[1 PRs](https://github.com/dereuromark/cakephp-ide-helper/pulls)20MITPHPPHP &gt;=8.2CI passing

Since Mar 12Pushed 1mo ago12 watchersCompare

[ Source](https://github.com/dereuromark/cakephp-ide-helper)[ Packagist](https://packagist.org/packages/dereuromark/cakephp-ide-helper)[ Docs](https://github.com/dereuromark/cakephp-ide-helper/)[ GitHub Sponsors](https://github.com/dereuromark)[ RSS](/packages/dereuromark-cakephp-ide-helper/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (24)Versions (186)Used By (20)

CakePHP IdeHelper Plugin
========================

[](#cakephp-idehelper-plugin)

[![CI](https://github.com/dereuromark/cakephp-ide-helper/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/dereuromark/cakephp-ide-helper/actions/workflows/ci.yml?query=branch%3Amaster)[![Coverage Status](https://camo.githubusercontent.com/c185e9f6ff42f13dd06d37f108dd22aa7c95ba6c9d90901c587f1986a433d330/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f6465726575726f6d61726b2f63616b657068702d6964652d68656c7065722f6d61737465722e737667)](https://app.codecov.io/github/dereuromark/cakephp-ide-helper/tree/master)[![PHPStan](https://camo.githubusercontent.com/f60d96f7c2579690ab6dfa8918f777fe93a02a92301c661eb38a85861a92b780/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d6c6576656c253230382d627269676874677265656e2e7376673f7374796c653d666c6174)](https://phpstan.org/)[![Latest Stable Version](https://camo.githubusercontent.com/476f50d70fe62cd822bc2239df4ca410deb95fcaf4e0484989b8ed2453b605ad/68747470733a2f2f706f7365722e707567782e6f72672f6465726575726f6d61726b2f63616b657068702d6964652d68656c7065722f762f737461626c652e737667)](https://packagist.org/packages/dereuromark/cakephp-ide-helper)[![Minimum PHP Version](https://camo.githubusercontent.com/ec21f169d70b69344c67d6f18fa1a24d20476d2f0cd680e8c4a1534c22f34e5f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344253230382e322d3838393242462e737667)](https://php.net/)[![License](https://camo.githubusercontent.com/ddf9b55a3e16b54d0b08becbe230580e4a01466222e684b8409197f18de8daee/68747470733a2f2f706f7365722e707567782e6f72672f6465726575726f6d61726b2f63616b657068702d6964652d68656c7065722f6c6963656e73652e737667)](LICENSE)[![Total Downloads](https://camo.githubusercontent.com/2e9427f4a2d7755b859c66aad2c38c373336f35bab5a5d20e5ddfbaa02e6476c/68747470733a2f2f706f7365722e707567782e6f72672f6465726575726f6d61726b2f63616b657068702d6964652d68656c7065722f642f746f74616c2e737667)](https://packagist.org/packages/dereuromark/cakephp-ide-helper)

IdeHelper plugin for CakePHP applications.

> Boost your productivity. Avoid mistakes.

This branch is for use with **CakePHP 5.1+**. For details see [version map](https://github.com/dereuromark/cakephp-ide-helper/wiki#cakephp-version-map).

Features
--------

[](#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](https://github.com/phpstan/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.
- Set up as watcher and have live in-real-time annotations added/updated.

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 and Tasks
- ... and more

[![Screenshot](docs/screenshot.jpg)](docs/screenshot.jpg)

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

[](#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](https://github.com/dereuromark/cakephp-ide-helper/wiki/PHPStorm)** (incl. meta file generator)
- IntelliJ
- Atom
- **[VS Code](https://github.com/dereuromark/cakephp-ide-helper/wiki/Visual-Studio-Code)**
- ... \[Report or PR your IDE of choice here to confirm its full compatibility\]

See [Wiki](https://github.com/dereuromark/cakephp-ide-helper/wiki) for details and tips/settings.

### Plugins with meta file generator tasks

[](#plugins-with-meta-file-generator-tasks)

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

- [Migrations](https://github.com/cakephp/migrations) for migration file writing (included in IdeHelper directly).
- [Queue](https://github.com/dereuromark/cakephp-queue) for `QueuedJobsTable::createJob()` usage.
- [Burzum/CakeServiceLayer](https://github.com/burzum/cakephp-service-layer) for `loadService()` usage.
- ... (add yours here)

### Plugins with Illuminator tasks

[](#plugins-with-illuminator-tasks)

- [StateMachine](https://github.com/spryker/cakephp-statemachine) for syncing states from XML into PHP.
- ... (add yours here)

### More

[](#more)

More collections of useful tasks can be found in the [IdeHelperExtra plugin](https://github.com/dereuromark/cakephp-ide-helper-extra).

### Install, Setup, Usage

[](#install-setup-usage)

See the **[Docs](docs/)** for details.

### Powered by

[](#powered-by)

[![PhpStorm logo.](https://camo.githubusercontent.com/1e31d98d23a59aa7fddbdae1155126adeac9ad6cded9a478fc8c5d377942c433/68747470733a2f2f7265736f75726365732e6a6574627261696e732e636f6d2f73746f726167652f70726f64756374732f636f6d70616e792f6272616e642f6c6f676f732f50687053746f726d2e737667)](https://jb.gg/OpenSourceSupport)

They are sponsoring my IDE for my FOSS work on this repository and beyond.

###  Health Score

74

—

ExcellentBetter than 100% of packages

Maintenance87

Actively maintained with recent releases

Popularity59

Moderate usage in the ecosystem

Community41

Growing community involvement

Maturity95

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 92% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~18 days

Total

181

Last Release

82d ago

Major Versions

1.18.9 → 2.0.0-RC2023-09-10

1.18.10 → 2.0.22023-11-03

1.19.0 → 2.1.02023-12-15

1.20.0 → 2.2.32024-03-15

1.21.0 → 2.6.02024-11-22

PHP version history (6 changes)0.1PHP &gt;=5.6

1.0.0-betaPHP &gt;=7.2

1.15.0PHP &gt;=7.3

1.18.7PHP &gt;=7.4

2.0.0-RCPHP &gt;=8.1

2.16.0PHP &gt;=8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/39854?v=4)[Mark Scherer](/maintainers/dereuromark)[@dereuromark](https://github.com/dereuromark)

---

Top Contributors

[![dereuromark](https://avatars.githubusercontent.com/u/39854?v=4)](https://github.com/dereuromark "dereuromark (1040 commits)")[![dakota](https://avatars.githubusercontent.com/u/83255?v=4)](https://github.com/dakota "dakota (19 commits)")[![LordSimal](https://avatars.githubusercontent.com/u/9105243?v=4)](https://github.com/LordSimal "LordSimal (12 commits)")[![challgren](https://avatars.githubusercontent.com/u/88909?v=4)](https://github.com/challgren "challgren (9 commits)")[![o0h](https://avatars.githubusercontent.com/u/907122?v=4)](https://github.com/o0h "o0h (6 commits)")[![raul338](https://avatars.githubusercontent.com/u/7199046?v=4)](https://github.com/raul338 "raul338 (5 commits)")[![andrii-pukhalevych](https://avatars.githubusercontent.com/u/3767063?v=4)](https://github.com/andrii-pukhalevych "andrii-pukhalevych (4 commits)")[![saeideng](https://avatars.githubusercontent.com/u/8215801?v=4)](https://github.com/saeideng "saeideng (4 commits)")[![markusramsak](https://avatars.githubusercontent.com/u/6324059?v=4)](https://github.com/markusramsak "markusramsak (3 commits)")[![hacheraw](https://avatars.githubusercontent.com/u/10481749?v=4)](https://github.com/hacheraw "hacheraw (3 commits)")[![skie](https://avatars.githubusercontent.com/u/130799?v=4)](https://github.com/skie "skie (3 commits)")[![ADmad](https://avatars.githubusercontent.com/u/142658?v=4)](https://github.com/ADmad "ADmad (2 commits)")[![DBnR1](https://avatars.githubusercontent.com/u/16005931?v=4)](https://github.com/DBnR1 "DBnR1 (2 commits)")[![Harfusha](https://avatars.githubusercontent.com/u/47174548?v=4)](https://github.com/Harfusha "Harfusha (2 commits)")[![ramondantas-cp](https://avatars.githubusercontent.com/u/156222208?v=4)](https://github.com/ramondantas-cp "ramondantas-cp (2 commits)")[![josbeir](https://avatars.githubusercontent.com/u/26058?v=4)](https://github.com/josbeir "josbeir (1 commits)")[![NickBusey](https://avatars.githubusercontent.com/u/280825?v=4)](https://github.com/NickBusey "NickBusey (1 commits)")[![jmfederico](https://avatars.githubusercontent.com/u/237977?v=4)](https://github.com/jmfederico "jmfederico (1 commits)")[![passchn](https://avatars.githubusercontent.com/u/77938819?v=4)](https://github.com/passchn "passchn (1 commits)")[![PhantomWatson](https://avatars.githubusercontent.com/u/1965565?v=4)](https://github.com/PhantomWatson "PhantomWatson (1 commits)")

---

Tags

annotationsautocompletioncakephpcakephp-pluginide-helpersupport-annotationstypehintingcliphpdocautocompletedevidephpstormannotationscakephp

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/dereuromark-cakephp-ide-helper/health.svg)

```
[![Health](https://phpackages.com/badges/dereuromark-cakephp-ide-helper/health.svg)](https://phpackages.com/packages/dereuromark-cakephp-ide-helper)
```

###  Alternatives

[barryvdh/laravel-ide-helper

Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[nunomaduro/collision

Cli error handling for console/command-line PHP applications.

4.6k331.8M8.5k](/packages/nunomaduro-collision)[cakephp/bake

Bake plugin for CakePHP

11211.2M158](/packages/cakephp-bake)[mis/yii2-ide-helper

Yii2 IDE Helper, generates correct PHPDocs for all components, to improve auto-completion.

1664.2k3](/packages/mis-yii2-ide-helper)[cnizzardini/cakephp-preloader

OPCache Preloader plugin for CakePHP

1234.4k](/packages/cnizzardini-cakephp-preloader)[stolt/lean-package-validator

Library and CLI for validating if a project or package has and will have lean releases.

172.4k8](/packages/stolt-lean-package-validator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
