Download the PHP package laravel/ranger without Composer
On this page you can find all versions of the php package laravel/ranger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravel/ranger
More information about laravel/ranger
Files in laravel/ranger
Package ranger
Short Description Laravel Ranger is a powerful introspection library for Laravel applications.
License MIT
Homepage https://github.com/laravel/ranger
Informations about the package ranger
Laravel Ranger
[!IMPORTANT] Ranger is currently in Beta, the API is subject (and likely) to change prior to the v1.0.0 release. All notable changes will be documented in the changelog.
Introduction
Ranger is a powerful introspection library for Laravel applications. It walks through your codebase and collects detailed information about your application's components, including routes, models, enums, broadcast events, environment variables, and Inertia.js components.
With Ranger, you can register callbacks that fire as each component is discovered, each callback returns a detailed Data Transport Object (DTO) that you can decide what to do with.
Basic Usage
What Ranger Collects
| Collector | Description |
|---|---|
| Routes | All registered routes with URIs, parameters, HTTP verbs, controllers, validation rules, and possible responses |
| Models | Eloquent models with their attributes, types, and relationships |
| Enums | PHP backed enums with their cases and values |
| Broadcast Events | Events implementing ShouldBroadcast with their payloads |
| Broadcast Channels | Registered broadcast channels |
| Environment Variables | Variables defined in your .env file |
| Inertia Shared Data | Globally shared Inertia.js props |
| Inertia Components | Inertia.js page components with their expected props |
Each collector skips whatever carries an ignore marker. See Ignore Markers.
Ignore Markers
Every collector leaves out declarations an application has marked to be left out, so a consumer cannot pass on something the author held back. Ranger honors any attribute implementing Laravel\Surveyor\Contracts\Ignored, on a model, an enum or one of its cases, a broadcast event or channel, and a controller class or action, whose routes are dropped with it. A relation pointing at a marked model is dropped too, since no type is left to point at.
Markers can carry a condition, which ranger resolves as a config key, a [class, method] callable, or a plain bool:
Conditions are resolved while collecting, not while analyzing, so a cached analysis is still answered for the environment collecting it.
Contributing
Thank you for considering contributing to Ranger! The contribution guide can be found in the Laravel documentation.
Code of Conduct
In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
License
Laravel Ranger is open-sourced software licensed under the MIT license.
All versions of ranger with dependencies
illuminate/console Version ^11.0|^12.0|^13.0
illuminate/contracts Version ^11.0|^12.0|^13.0
illuminate/routing Version ^11.0|^12.0|^13.0
illuminate/support Version ^11.0|^12.0|^13.0
laravel/pint Version ^1.22
laravel/surveyor Version ^0.3.0
nikic/php-parser Version ^5.4
phpstan/phpdoc-parser Version ^2.1
spatie/php-structure-discoverer Version ^2.3