crustum / investigator
CakePHP Investigator static analysis: structured metadata about classes, methods, properties, types, Table schemas, and Entity shapes from your application code
Requires
- php: >=8.4
- cakephp/cakephp: ^5.4
- nikic/php-parser: ^5.4
- phpstan/phpdoc-parser: ^2.1
Requires (Dev)
- cakedc/cakephp-phpstan: ^4.3
- cakephp/cakephp-codesniffer: ^5.3
- crustum/inertia-cakephp: dev-main
- crustum/plugin-manifest: ^1.2
- pestphp/pest: ^4.7
- pestphp/pest-plugin-type-coverage: ^4.0
- phpstan/phpstan: ^2.3
- phpunit/phpunit: ^12.5 || ^13.0
- rector/rector: ^2.7
Suggests
- crustum/plugin-manifest: CakePHP plugin installer
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-18 03:49:26 UTC
README
The Investigator plugin is a static analysis tool for CakePHP applications. It parses and analyzes PHP files to extract comprehensive metadata about classes, methods, properties, return types, and more — making this information available in a structured, consumable format for use by other tools and packages.
Investigator analyzes files through the shared Analyzer engine (file path or class name in, analyzed Scope and ClassLikeResult out). Ignore markers hide selected members from results, a Type factory system represents PHP types, and AnalyzedCache speeds up repeated analysis with in-memory and signed disk persistence. Cake-specific analyzers merge Table schema, associations, and Entity virtuals into results, and read the serializable entity shape as the API resource surface. Engine services are wired through the plugin's services() bindings with constructor injection.
Requirements
- PHP 8.4+
See Versions.md for the supported CakePHP versions.
Documentation
For documentation, as well as tutorials, see the docs directory of this repository.
License
Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.