Submit a Pull Request Report a Bug

    ReflectionClass::getAttributes

    (PHP 8)

    ReflectionClass::getAttributes — Gets Attributes

    Descrizione

    public ReflectionClass::getAttributes(?string $name = null, int $flags = 0): array

    Returns all attributes declared on this class as an array of ReflectionAttribute.

    Elenco dei parametri

    name

    Filter the results to include only ReflectionAttribute instances for attributes matching this class name.

    flags

    Flags for determining how to filter the results, if name is provided.

    Default is 0 which will only return results for attributes that are of the class name.

    The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, which will instead use instanceof for filtering.

    Valori restituiti

    Array of attributes, as a ReflectionAttribute object.

    Esempi

    Example #1 Basic usage

    <?php
    #[Attribute]
    class     Fruit {
    }

    #[    Attribute]
    class     Red {
    }

    #[    Fruit]
    #[    Red]
    class     Apple {
    }

    $class = new ReflectionClass('Apple');
    $attributes = $class->getAttributes();
    print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
    ?>

    Il precedente esempio visualizzerà:

    Array
(
    [0] => Fruit
    [1] => Red
)

    Example #2 Filtering results by class name

    <?php
    #[Attribute]
    class     Fruit {
    }

    #[    Attribute]
    class     Red {
    }

    #[    Fruit]
    #[    Red]
    class     Apple {
    }

    $class = new ReflectionClass('Apple');
    $attributes = $class->getAttributes('Fruit');
    print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
    ?>

    Il precedente esempio visualizzerà:

    Array
(
    [0] => Fruit
)

    Example #3 Filtering results by class name, with inheritance

    <?php
    interface Color {
    }

    #[    Attribute]
    class     Fruit {
    }

    #[    Attribute]
    class     Red implements Color {
    }

    #[    Fruit]
    #[    Red]
    class     Apple {
    }

    $class = new ReflectionClass('Apple');
    $attributes = $class->getAttributes(Color::class, ReflectionAttribute::IS_INSTANCEOF);
    print_r(array_map(fn($attribute) => $attribute->getName(), $attributes));
    ?>

    Il precedente esempio visualizzerà:

    Array
(
    [0] => Red
)

    add a note add a note

    User Contributed Notes 1 note

    up
    0
    sergiolibe at gmail dot com
    2 years ago
    When using getAttributes() with specific attribute class and flags, flag 0 will return just matching attributes with specified class, and 2 will return matching attributes with specified class and children of that class:
    <?php
            #[Attribute(\Attribute::TARGET_CLASS)]
            class SomeAttribute {}

            #[Attribute(\Attribute::TARGET_CLASS)]
            class ChildAttribute extends SomeAttribute {}

            #[SomeAttribute]
        #[SomeChildAttribute]
            class SomeClass {}

            $rc = new ReflectionClass(SomeClass::class);

            $r_atts = $rc->getAttributes(SomeAttribute::class, 0); // 0 is default, just given class
            echo json_encode(array_map(fn(ReflectionAttribute $r_att) => $r_att->getName(), $r_atts)), PHP_EOL;

            $r_atts = $rc->getAttributes(SomeAttribute::class, 2); // given class and children classes
            echo json_encode(array_map(fn(ReflectionAttribute $r_att) => $r_att->getName(), $r_atts)), PHP_EOL;
    ?>

    output:
    ["SomeAttribute"]
    ["SomeAttribute","ChildAttribute"]
    add a note add a note
    To Top