Aperçu des attributs
(PHP 8)
Les attributs permettent d'ajouter des informations de métadonnées structurées et lisibles par la machine
sur les déclarations dans le code : les classes, les méthodes, les fonctions, les paramètres, les propriétés
et les constantes de classe peuvent être la cible d'un attribut. Les métadonnées
définies par les attributs peuvent ensuite être inspectées au moment de l'exécution à l'aide de
l'API de Réflexion.
Les attributs peuvent donc être considérés comme un langage de configuration intégré directement dans le code.
Avec les attributs, il est possible de découpler la mise en œuvre générique d'une fonctionnalité
et son utilisation concrète dans une application. D'une certaine manière, ils sont
comparables aux interfaces et à leurs implémentations. Mais là où les interfaces et les implémentations
portent sur le code, les attributs concernent l'annotation d'informations supplémentaires et la configuration.
Les interfaces peuvent être implémentées par des classes, mais les attributs peuvent également être déclarés sur
les méthodes, les fonctions, les paramètres, les propriétés et les constantes de classe.
Ils sont donc plus flexibles que les interfaces.
Un exemple simple d'utilisation d'attributs consiste à convertir une interface
qui a des méthodes optionnelles pour utiliser des attributs. Supposons qu'une
interface ActionHandler représentant une opération dans une application
où certaines implémentations d'un gestionnaire d'action nécessitent une configuration et d'autres non.
Au lieu d'exiger que toutes les classes qui implémentent ActionHandler implémentent
une méthode setUp(), un attribut peut être utilisé. L'un des avantages
de cette approche est que nous pouvons utiliser l'attribut plusieurs fois.
Exemple #1 Implémentation de méthodes optionnelles d'une interface avec des attributs
<?php
interface ActionHandler
{
public function execute();
}
#[Attribute]
class SetUp {}
class CopyFile implements ActionHandler
{
public string $fileName;
public string $targetDirectory;
#[SetUp]
public function fileExists()
{
if (!file_exists($this->fileName)) {
throw new RuntimeException("Le fichier n'existe pas.");
}
}
#[SetUp]
public function targetDirectoryExists()
{
if (!file_exists($this->targetDirectory)) {
mkdir($this->targetDirectory);
} elseif (!is_dir($this->targetDirectory)) {
throw new RuntimeException("Le répertoire cible $this->targetDirectory n'est pas un répertoire.");
}
}
public function execute()
{
copy($this->fileName, $this->targetDirectory . '/' . basename($this->fileName));
}
}
function executeAction(ActionHandler $actionHandler)
{
$reflection = new ReflectionObject($actionHandler);
foreach ($reflection->getMethods() as $method) {
$attributes = $method->getAttributes(SetUp::class);
if (count($attributes) > 0) {
$methodName = $method->getName();
$actionHandler->$methodName();
}
}
$actionHandler->execute();
}
$copyAction = new CopyFile();
$copyAction->fileName = "/tmp/foo.jpg";
$copyAction->targetDirectory = "/home/user";
executeAction($copyAction);
Harshdeep ¶3 years ago
While the example displays us what we can accomplish with attributes, it should be kept in mind that the main idea behind attributes is to attach static metadata to code (methods, properties, etc.). This metadata often includes concepts such as "markers" and "configuration". For example, you can write a serializer using reflection that only serializes marked properties (with optional configuration, such as field name in serialized file). This is reminiscent of serializers written for C# applications.That said, full reflection and attributes go hand in hand. If your use case is satisfied by inheritance or interfaces, prefer that. The most common use case for attributes is when you have no prior information about the provided object/class.<?phpinterface JsonSerializable{ public function toJson() : array;}?>versus, using attributes,<?php#[Attribute]class JsonSerialize { public function __constructor(public ?string $fieldName = null) {}}class VersionedObject{ #[JsonSerialize] public const version = '0.0.1';}public class UserLandClass extends VersionedObject{ #[JsonSerialize('call it Jackson')] public string $myValue;}?>The example above is a little extra convoluted with the existence of the VersionedObject class as I wished to display that with attribute mark ups, you do not need to care how the base class manages its attributes (no call to parent in overriden method).
Florian Krmer ¶2 years ago
I've tried Harshdeeps example and it didn't run out of the box and I think it is not complete, so I wrote a complete and working naive example regarding attribute based serialization.<?phpdeclare(strict_types=1);#[Attribute(Attribute::TARGET_CLASS_CONSTANT|Attribute::TARGET_PROPERTY)]class JsonSerialize{ public function __construct(public ?string $fieldName = null) {}}class VersionedObject{ #[JsonSerialize] public const version = '0.0.1';}class UserLandClass extends VersionedObject{ protected string $notSerialized = 'nope'; #[JsonSerialize('foobar')] public string $myValue = ''; #[JsonSerialize('companyName')] public string $company = ''; #[JsonSerialize('userLandClass')] protected ?UserLandClass $test; public function __construct(?UserLandClass $userLandClass = null) { $this->test = $userLandClass; }}class AttributeBasedJsonSerializer { protected const ATTRIBUTE_NAME = 'JsonSerialize'; public function serialize($object) { $data = $this->extract($object); return json_encode($data, JSON_THROW_ON_ERROR); } protected function reflectProperties(array $data, ReflectionClass $reflectionClass, object $object) { $reflectionProperties = $reflectionClass->getProperties(); foreach ($reflectionProperties as $reflectionProperty) { $attributes = $reflectionProperty->getAttributes(static::ATTRIBUTE_NAME); foreach ($attributes as $attribute) { $instance = $attribute->newInstance(); $name = $instance->fieldName ?? $reflectionProperty->getName(); $value = $reflectionProperty->getValue($object); if (is_object($value)) { $value = $this->extract($value); } $data[$name] = $value; } } return $data; } protected function reflectConstants(array $data, ReflectionClass $reflectionClass) { $reflectionConstants = $reflectionClass->getReflectionConstants(); foreach ($reflectionConstants as $reflectionConstant) { $attributes = $reflectionConstant->getAttributes(static::ATTRIBUTE_NAME); foreach ($attributes as $attribute) { $instance = $attribute->newInstance(); $name = $instance->fieldName ?? $reflectionConstant->getName(); $value = $reflectionConstant->getValue(); if (is_object($value)) { $value = $this->extract($value); } $data[$name] = $value; } } return $data; } protected function extract(object $object) { $data = []; $reflectionClass = new ReflectionClass($object); $data = $this->reflectProperties($data, $reflectionClass, $object); $data = $this->reflectConstants($data, $reflectionClass); return $data; }}$userLandClass = new UserLandClass();$userLandClass->company = 'some company name';$userLandClass->myValue = 'my value';$userLandClass2 = new UserLandClass($userLandClass);$userLandClass2->company = 'second';$userLandClass2->myValue = 'my second value';$serializer = new AttributeBasedJsonSerializer();$json = $serializer->serialize($userLandClass2);var_dump(json_decode($json, true));
