README

PHP library for checking the presence of attributes on classes, properties, methods, parameters, functions, class constants, and enum cases.

Requirements

• PHP 8.0+

Installation

composer require damirco/attr

Usage

use Damirco\Attr\ClassAttribute;
use Damirco\Attr\PropertyAttribute;
use Damirco\Attr\MethodAttribute;
use Damirco\Attr\ParameterAttribute;
use Damirco\Attr\FunctionAttribute;
use Damirco\Attr\ClassConstantAttribute;
use Damirco\Attr\EnumCaseAttribute;

Check class attributes

$attribute = new ClassAttribute(MyAttribute::class);

$attribute->isPresentOn(MyClass::class);       // by class name
$attribute->isPresentOn(new MyClass());         // by instance

Check property attributes

$attribute = new PropertyAttribute(MyAttribute::class);

$attribute->isPresentOn(MyClass::class, 'propertyName');

Check method attributes

$attribute = new MethodAttribute(MyAttribute::class);

$attribute->isPresentOn(MyClass::class, 'methodName');

Check parameter attributes

$attribute = new ParameterAttribute(MyAttribute::class);

$attribute->isPresentOn(myFunction(...), 'paramName');

Check function attributes

$attribute = new FunctionAttribute(MyAttribute::class);

$attribute->isPresentOn(myFunction(...));

Check class constant attributes

$attribute = new ClassConstantAttribute(MyAttribute::class);

$attribute->isPresentOn(MyClass::class, 'CONSTANT_NAME');

Check enum case attributes

$attribute = new EnumCaseAttribute(MyAttribute::class);

$attribute->isPresentOn(MyEnum::class, 'CASE_NAME');

Available classes

Configuration

All classes extend AbstractAttribute and accept two constructor parameters:

new ClassAttribute(
    attribute_class: MyAttribute::class,  // attribute to check for
    flags: \ReflectionAttribute::IS_INSTANCEOF  // matching mode (default)
);

Flags

• \ReflectionAttribute::IS_INSTANCEOF (default) — matches if the attribute is an instance of the given class
• 0 — exact class match only

Fluent setters

$attribute = new ClassAttribute(MyAttribute::class)
    ->setAttributeClass(AnotherAttribute::class)
    ->setFlags(0);

Testing

composer test

License

MIT