README

A clean API for working with PHP attributes

PHP 8.0 introduced attributes, but the reflection API to actually read them is verbose and awkward. Want to check if a class has a specific attribute? That's four lines. Want to find every occurrence of an attribute across a class, its methods, properties, constants, and parameters? That's 40+ lines of nested foreach loops.

This package gives you a clean, static API instead:

use Spatie\Attributes\Attributes;

// Get a single attribute from a class
$route = Attributes::get(MyController::class, Route::class);

// Check if a class has an attribute
Attributes::has(MyController::class, Route::class); // true

// Read from methods, properties, constants, parameters
Attributes::onMethod(MyController::class, 'index', Route::class);
Attributes::onProperty(User::class, 'email', Column::class);
Attributes::onConstant(Status::class, 'ACTIVE', Label::class);
Attributes::onParameter(MyController::class, 'show', 'id', FromRoute::class);

// Find an attribute everywhere in a class at once
$results = Attributes::find(MyForm::class, Validate::class);

foreach ($results as $result) {
    $result->attribute; // The instantiated attribute
    $result->target;    // The Reflection object
    $result->name;      // e.g. 'email', 'handle.request'
}

Every method returns instantiated attribute objects, missing targets return null instead of throwing exceptions, and child attributes are matched automatically.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Documentation

All documentation is available on our documentation site.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

spatie / php-attribute-reader

Maintainers

Details