Het nieuwe code-analyse-ecosysteem van Laravel — surveyor / ranger / roster

composer require laravel/surveyor

use Laravel\Surveyor\Analyzer\Analyzer;

$analyzer = app(Analyzer::class);

// Analyseren op bestandspad
$result = $analyzer->analyze('/path/to/your/File.php');

// Toegang tot de geanalyseerde scope
$scope = $result->analyzed();

// Toegang tot het klasseresultaat
$classResult = $result->result();

$result = $analyzer->analyzeClass(\App\Models\User::class);
$classResult = $result->result();

$classResult = $analyzer->analyzeClass(App\Models\User::class)->result();

// Klasse-informatie
$name = $classResult->name();            // 'App\Models\User'
$namespace = $classResult->namespace();  // 'App\Models'
$filePath = $classResult->filePath();

// Overervingsrelaties
$extends = $classResult->extends();
$implements = $classResult->implements();

// Methode-informatie
$method = $classResult->getMethod('store');
$returnType = $method->returnType();
$parameters = $method->parameters();
$rules = $method->validationRules(); // ook validatieregels op te vragen

// Property-informatie
$property = $classResult->getProperty('email');
$type = $property->type;
$visibility = $property->visibility; // 'public', 'protected', 'private'

// Lijst van publieke methoden en properties
$publicMethods = $classResult->publicMethods();
$publicProperties = $classResult->publicProperties();

use Laravel\Surveyor\Types\Type;

// Verschillende types aanmaken
$stringType = Type::string();
$intType = Type::int();
$boolType = Type::bool();
$nullType = Type::null();

// Uniontypes (zoals string|null)
$unionType = Type::union(Type::string(), Type::null());

// Typecontrole
use Laravel\Surveyor\Types\StringType;

if (Type::is($returnType, StringType::class)) {
    // Verwerking van het stringtype
}

use Laravel\Surveyor\Analyzer\AnalyzedCache;

// Diskcache inschakelen
AnalyzedCache::enableDiskCache(storage_path('surveyor-cache'));

// De cache wissen
AnalyzedCache::clear();

SURVEYOR_CACHE_ENABLED=true
SURVEYOR_CACHE_DIR=/path/to/cache

$result = $analyzer->analyzeClass(App\Models\User::class)->result();

// Databaseattributen worden automatisch gedetecteerd
$emailProperty = $result->getProperty('email');

// Bepalen of een methode een relatie is
$method = $result->getMethod('posts');
if ($method->isModelRelation()) {
    // Deze methode is een relatie
}

composer require laravel/ranger

use Laravel\Ranger\Ranger;
use Laravel\Ranger\Components;
use Illuminate\Support\Collection;

$ranger = app(Ranger::class);

// Wordt aangeroepen telkens wanneer een route wordt gevonden
$ranger->onRoute(function (Components\Route $route) {
    echo $route->uri();
});

// Wordt aangeroepen telkens wanneer een model wordt gevonden
$ranger->onModel(function (Components\Model $model) {
    foreach ($model->getAttributes() as $name => $type) {
        // Verwerking van de attribuutnaam en het type
    }
});

// Wordt aangeroepen telkens wanneer een enum wordt gevonden
$ranger->onEnum(function (Components\Enum $enum) {
    //
});

// Wordt aangeroepen telkens wanneer een broadcast-event wordt gevonden
$ranger->onBroadcastEvent(function (Components\BroadcastEvent $event) {
    //
});

// Wordt één keer aangeroepen nadat alle routes zijn verzameld
$ranger->onRoutes(function (Collection $routes) {
    //
});

// Wordt één keer aangeroepen nadat alle modellen zijn verzameld
$ranger->onModels(function (Collection $models) {
    //
});

// De hele applicatie doorlopen en de callbacks afvuren
$ranger->walk();

composer require laravel/roster --dev

use Laravel\Roster\Roster;
use Laravel\Roster\Packages;

// Een directory scannen en de Roster ophalen
$roster = Roster::scan($directory);

// Lijst van geïnstalleerde pakketten
$roster->packages();

// Alleen productiepakketten
$roster->packages()->production();

// Alleen dev-pakketten
$roster->packages()->dev();

// Controleren op de aanwezigheid van een specifiek pakket
$roster->uses(Packages::INERTIA);        // bool
$roster->uses(Packages::LIVEWIRE);       // bool

// Controleren met een versievoorwaarde
$roster->usesVersion(Packages::INERTIA, '2.0.0', '>=');   // Inertia 2.0.0 of hoger?
$roster->usesVersion(Packages::LIVEWIRE, '3.0.0', '>=');  // Livewire 3.0.0 of hoger?

// Detectie van de JavaScript-pakketbeheerder
$packageManager = $roster->nodePackageManager(); // 'npm', 'yarn', 'bun', enz.

use Laravel\Roster\Roster;
use Laravel\Roster\Packages;

$roster = Roster::scan(base_path());

if ($roster->uses(Packages::INERTIA)) {
    // Verwerking voor Inertia
    if ($roster->usesVersion(Packages::INERTIA, '2.0.0', '>=')) {
        // Verwerking voor Inertia v2 en hoger
    }
}

if ($roster->uses(Packages::LIVEWIRE)) {
    // Verwerking voor Livewire
}

// Het installatiecommando aanpassen aan de JavaScript-pakketbeheerder
$pm = $roster->nodePackageManager();
echo "Run: {$pm} install your-package";

use Laravel\Ranger\Ranger;
use Laravel\Ranger\Components;

$ranger = app(Ranger::class);
$docs = [];

$ranger->onRoute(function (Components\Route $route) use (&$docs) {
    $docs['routes'][] = [
        'uri' => $route->uri(),
        // ook validatieregels en responsetypes van de route op te vragen
    ];
});

$ranger->onModel(function (Components\Model $model) use (&$docs) {
    $docs['models'][] = [
        'attributes' => $model->getAttributes(),
    ];
});

$ranger->walk();

// In $docs is de structuurinformatie van de hele app verzameld