#! 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"
Declaring Attribute Classes
While not strictly required it is recommended to create an actual class for every attribute.
In the most simple case only an empty class is needed with the #[Attribute] attribute declared
that can be imported from the global namespace with a use statement.
Example #1 Simple Attribute Class
<?php
namespace Example;
use Attribute;
#[Attribute]
class MyAttribute
{
}
To restrict the type of declaration an attribute can be assigned to, a bitmask can be passed as the first
argument to the #[Attribute] declaration.
Example #2 Using target specification to restrict where attributes can be used
<?php
namespace Example;
use Attribute;
#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)]
class MyAttribute
{
}Declaring MyAttribute on another type will now throw an exception during the call to ReflectionAttribute::newInstance()
The following targets can be specified:
Attribute::TARGET_CLASSAttribute::TARGET_FUNCTIONAttribute::TARGET_METHODAttribute::TARGET_PROPERTYAttribute::TARGET_CLASS_CONSTANTAttribute::TARGET_PARAMETERAttribute::TARGET_ALL
By default an attribute can only be used once per declaration. If the attribute should be repeatable on declarations it must
be specified as part of the bitmask to the #[Attribute] declaration.
Example #3 Using IS_REPEATABLE to allow attribute on a declaration multiple times
<?php
namespace Example;
use Attribute;
#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION | Attribute::IS_REPEATABLE)]
class MyAttribute
{
}
add a note
User Contributed Notes 1 note
esdras-schonevald ¶
3 years ago
