Déclaration des classes d'attributs

    Bien que cela ne soit pas strictement nécessaire, il est recommandé de créer une classe réelle pour chaque attribut. Dans le cas le plus simple, seule une classe vide est nécessaire avec l'attribut #[Attribut] déclaré qui peut être importé à partir de l'espace de noms global à l'aide d'une déclaration d'utilisation.

    Exemple #1 Classe d'attribut simple

    <?php

    namespace Example;

    use     Attribute;

    #[    Attribute]
    class     MyAttribute
    {
    }

    Pour restreindre le type de déclaration auquel un attribut peut être assigné, un masque de bits peut être passé comme premier argument à la déclaration de l'attribut #[Attribute].

    Exemple #2 Utilisation de la spécification de la cible pour restreindre l'utilisation des attributs

    <?php

    namespace Example;

    use     Attribute;

    #[    Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)]
    class     MyAttribute
    {
    }

    La déclaration de MyAttribute sur un autre type lèvera désormais une exception lors de l'appel à ReflectionAttribute::newInstance()

    Les cibles suivantes peuvent être spécifiées:

    Par défaut, un attribut ne peut être utilisé qu'une seule fois par déclaration. Si l'attribut doit pouvoir être répété dans les déclarations, cela doit être spécifié dans le masque de bits de la déclaration #[Attribute].

    Exemple #3 Utilisation de IS_REPEATABLE pour permettre à un attribut d'être utilisé plusieurs fois dans une déclaration

    <?php

    namespace Example;

    use     Attribute;

    #[    Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION | Attribute::IS_REPEATABLE)]
    class     MyAttribute
    {
    }

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 1 note

    up
    15
    esdras-schonevald
    2 years ago
    #! Require PHP >= 8.0

    #! This is a Sample

    <?php

    declare(strict_types = 1);

    #[    Attribute]
    class     Foo
    {
    function     __construct(){
    echo     "Running " . __METHOD__ . PHP_EOL;
    }
    }

    #[    Attribute(Attribute::TARGET_CLASS|Attribute::IS_REPEATABLE)]
    class     Bar {
    function     __construct(?string ...$args){
    echo     "Running " . __METHOD__ ,
    " args: " . implode(", ", $args) . PHP_EOL;
    }
    }

    #[    Attribute(Attribute::TARGET_ALL)]
    class     Baz {
    function     __construct(
    private     string $parameter
    ){
    echo     "Running " . __METHOD__ ,
    " arg: " . $this->parameter . PHP_EOL;
    }
    }

    #[    Foo] // [0]
    #[Bar] // [1]
    #[Bar("Banana")] // [2]
    #[Bar("Banana", "Apple", "Lemon", "Grape")] // [3]
    #[Baz("The Only One")] // [4]
    class Qux
    {
    }

    // Getting class attribute with ReflectionClass
    $ref = new ReflectionClass(Qux::class);
    $attrs = $ref->getAttributes(); // Array of attributes

    $attrs[0]->newInstance(); // "Running Foo::__construct"
    $attrs[1]->newInstance(); // "Running Bar::__construct args: "
    $attrs[2]->newInstance(); // "Running Bar::__construct args: Banana"
    $attrs[3]->newInstance(); // "Running Bar::__construct args: Banana, Apple, Lemon, Grape"
    $attrs[4]->newInstance(); // "Running Baz::__construct arg: The Only One"
    ＋add a note
    To Top