Edit Report a Bug

    ReflectionClass::getAttributes

    (PHP 8)

    ReflectionClass::getAttributes — Récupère les attributs d'une classe

    Description

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

    Retourne tous les attributs déclarés sur cette classe sous la forme d'un tableau de ReflectionAttribute.

    Liste de paramètres

    name

    Filtrer les résultats pour inclure uniquement les instances de ReflectionAttribute pour les attributs correspondant à ce nom de classe.

    flags

    Flags pour déterminer comment filtrer les résultats, si name est fourni.

    La valeur par défaut est 0 qui ne renverra que les résultats pour les attributs qui sont de la classe name.

    La seule autre option disponible est d'utiliser ReflectionAttribute::IS_INSTANCEOF, qui utilisera plutôt instanceof pour le filtrage.

    Valeurs de retour

    Un tableau d'attributs, sous la forme d'objets de type ReflectionAttribute.

    Exemples

    Exemple #1 Utilisation basique de ReflectionClass::getAttributes()

    <?php
    #[Attribute]
    class     Fruit {
    }

    #[    Attribute]
    class     Rouge {
    }

    #[    Fruit]
    #[    Rouge]
    class     Pomme {
    }

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

    L'exemple ci-dessus va afficher :

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

    Exemple #2 Filtrer les résultats par un nom de classe

    <?php
    #[Attribute]
    class     Fruit {
    }

    #[    Attribute]
    class     Rouge {
    }

    #[    Fruit]
    #[    Rouge]
    class     Pomme {
    }

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

    L'exemple ci-dessus va afficher :

    Array
(
    [0] => Fruit
)

    Exemple #3 Filtrer les résultats par nom de classe, avec héritage

    <?php
    interface Couleur {
    }

    #[    Attribute]
    class     Fruit {
    }

    #[    Attribute]
    class     Rouge implements Couleur {
    }

    #[    Fruit]
    #[    Rouge]
    class     Pomme {
    }

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

    L'exemple ci-dessus va afficher :

    Array
(
    [0] => Rouge
)

    add a note add a note

    User Contributed Notes 2 notes

    up
    2
    sandrenyl at gmail dot com
    3 years ago
    When using the method getAttributes() to fetch attributes based on a parent class, the proper flag constant is ReflectionAttribute::IS_INSTANCEOF (which equals 2 as mentionned by sergiolibe).

    <?php
    $reflectionClass    ->getAttributes(SomeParentAttribute::class, ReflectionAttribute::IS_INSTANCEOF);
    ?>
    up
    1
    sergiolibe at gmail dot com
    3 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