{"id":13684172,"url":"https://github.com/dereuromark/cakephp-ide-helper","last_synced_at":"2026-04-12T03:09:25.946Z","repository":{"id":17641935,"uuid":"82395792","full_name":"dereuromark/cakephp-ide-helper","owner":"dereuromark","description":"IDE Helper plugin for CakePHP","archived":false,"fork":false,"pushed_at":"2025-05-12T12:06:07.000Z","size":2377,"stargazers_count":186,"open_issues_count":7,"forks_count":39,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-12T13:24:06.351Z","etag":null,"topics":["annotations","autocompletion","cakephp","cakephp-plugin","ide-helper","support-annotations","typehinting"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dereuromark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/Contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"dereuromark"}},"created_at":"2017-02-18T15:25:50.000Z","updated_at":"2025-05-12T12:16:07.000Z","dependencies_parsed_at":"2023-12-15T02:31:34.425Z","dependency_job_id":"9b585774-32ed-4008-a0a6-66029bba2114","html_url":"https://github.com/dereuromark/cakephp-ide-helper","commit_stats":{"total_commits":956,"total_committers":34,"mean_commits":28.11764705882353,"dds":0.4769874476987448,"last_synced_commit":"b9de5b45f1c5db220b6f439168bab3bfc490912d"},"previous_names":[],"tags_count":161,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dereuromark%2Fcakephp-ide-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dereuromark%2Fcakephp-ide-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dereuromark%2Fcakephp-ide-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dereuromark%2Fcakephp-ide-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dereuromark","download_url":"https://codeload.github.com/dereuromark/cakephp-ide-helper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254249198,"owners_count":22039029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotations","autocompletion","cakephp","cakephp-plugin","ide-helper","support-annotations","typehinting"],"created_at":"2024-08-02T14:00:30.473Z","updated_at":"2026-04-12T03:09:25.941Z","avatar_url":"https://github.com/dereuromark.png","language":"PHP","funding_links":["https://github.com/sponsors/dereuromark"],"categories":["Code Analysis","Plugins"],"sub_categories":["Frameworks","Code Analysis"],"readme":"#  CakePHP IdeHelper Plugin\n\n[![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)\n[![Coverage Status](https://img.shields.io/codecov/c/github/dereuromark/cakephp-ide-helper/master.svg)](https://app.codecov.io/github/dereuromark/cakephp-ide-helper/tree/master)\n[![PHPStan](https://img.shields.io/badge/PHPStan-level%208-brightgreen.svg?style=flat)](https://phpstan.org/)\n[![Latest Stable Version](https://poser.pugx.org/dereuromark/cakephp-ide-helper/v/stable.svg)](https://packagist.org/packages/dereuromark/cakephp-ide-helper)\n[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.2-8892BF.svg)](https://php.net/)\n[![License](https://poser.pugx.org/dereuromark/cakephp-ide-helper/license.svg)](LICENSE)\n[![Total Downloads](https://poser.pugx.org/dereuromark/cakephp-ide-helper/d/total.svg)](https://packagist.org/packages/dereuromark/cakephp-ide-helper)\n\nIdeHelper plugin for CakePHP applications.\n\n\u003e Boost your productivity. Avoid mistakes.\n\nThis branch is for use with **CakePHP 5.1+**. For details see [version map](https://github.com/dereuromark/cakephp-ide-helper/wiki#cakephp-version-map).\n\n## Features\n\nThe main idea is to improve IDE compatibility and use annotations to make the IDE understand the\n\"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).\n\nThis also improves compatibility with tools like [PHPStan](https://github.com/phpstan/phpstan).\nThose can then follow the code easier and provide more valuable help.\n\n- Add annotations to existing code (e.g. when upgrading an application) just like baking would to new code.\n- Can run multiple times without adding the annotations again.\n- It can also replace or remove outdated annotations.\n- Works with your application as well as any loaded plugin.\n- CI check support, hook it up just like the coding standards check.\n- Set up as watcher and have live in-real-time annotations added/updated.\n\nSupports annotations for:\n- Models (Tables and Entities)\n- Controllers (including prefixes like `Admin`) and Components\n- View (AppView) and Helpers\n- Templates (`.php` PHP template files including elements)\n- Commands and Tasks\n- ... and more\n\n![Screenshot](docs/screenshot.jpg)\n\nSupports code completion help for:\n- Behaviors (property access on the BehaviorRegistry)\n\nSupports IDE autocomplete/typehinting of (magic)strings as well as return types/values for:\n- Plugins, Components, Behaviors, Helpers, Mailers\n- Associations, Validation\n- I18n Translation, Cache\n- Elements and layouts\n- Tables and their fields\n- Route paths, Request/ENV, Connection\n- ... and more (using PhpStorm meta file)\n\nSupports better IDE usage with Illuminator tasks to enhance existing code:\n- EntityFieldTask adds all entity fields as class constants for easier usage in IDEs\n\n### IDE support\nThis plugin is supposed to work with ANY IDE that supports annotations and code completion.\nIDEs tested so far for 100% compatibility:\n- **[PhpStorm](https://github.com/dereuromark/cakephp-ide-helper/wiki/PHPStorm)** (incl. meta file generator)\n- IntelliJ\n- Atom\n- **[VS Code](https://github.com/dereuromark/cakephp-ide-helper/wiki/Visual-Studio-Code)**\n- ... [Report or PR your IDE of choice here to confirm its full compatibility]\n\nSee [Wiki](https://github.com/dereuromark/cakephp-ide-helper/wiki) for details and tips/settings.\n\n### Plugins with meta file generator tasks\nThe following plugins use this plugin to improve IDE compatibility around factory and magic string usage:\n- [Migrations](https://github.com/cakephp/migrations) for migration file writing (included in IdeHelper directly).\n- [Queue](https://github.com/dereuromark/cakephp-queue) for `QueuedJobsTable::createJob()` usage.\n- [Burzum/CakeServiceLayer](https://github.com/burzum/cakephp-service-layer) for `loadService()` usage.\n- ... (add yours here)\n\n### Plugins with Illuminator tasks\n- [StateMachine](https://github.com/spryker/cakephp-statemachine) for syncing states from XML into PHP.\n- ... (add yours here)\n\n### More\nMore collections of useful tasks can be found in the [IdeHelperExtra plugin](https://github.com/dereuromark/cakephp-ide-helper-extra).\n\n### Install, Setup, Usage\nSee the **[Docs](docs/)** for details.\n\n\n### Powered by\n[![PhpStorm logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/PhpStorm.svg)](https://jb.gg/OpenSourceSupport)\n\nThey are sponsoring my IDE for my FOSS work on this repository and beyond.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdereuromark%2Fcakephp-ide-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdereuromark%2Fcakephp-ide-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdereuromark%2Fcakephp-ide-helper/lists"}