crustum / scrutator
CakePHP Scrutator introspects routes, entities, enums, broadcast events and channels, forms, environment variables, and Inertia shared data into typed components
Requires
- php: >=8.4
- cakephp/cakephp: ^5.4
- crustum/broadcasting: ^1.3
- crustum/investigator: dev-main
- josegonzalez/dotenv: ^3.2|^4.0
- 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 18:40:05 UTC
README
The Scrutator plugin is a powerful introspection library for CakePHP applications. It walks through your codebase and collects detailed information about your application's components, including routes, controller actions, entities, enums, broadcast events, broadcast channels, environment variables, form validators, and Inertia.js shared data.
With Scrutator, you register callbacks that fire as each component is discovered. Each callback receives a detailed data transfer object (DTO) that you can decide what to do with. Discovery covers the host app and loaded plugins, and collectors are built on the sibling Investigator and Broadcasting packages.
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.