Getter et Setter PHP dans VSCode

Parce que vous êtes un excellent développeur, vous n'autorisez personne à accéder directement aux propriétés de votre classe, mais uniquement via un getter ou un setter.

Autrement dit, dans votre classe PHP, vous n'avez pas de propriétés public (c'est le diable) mais exclusivement des protected ou mieux, des private.

Et grâce aux getters et setters, vous permettez à d'autres objets d'interagir avec vos propriétés privées en les lisant (getters) ou en modifiant leurs valeurs (setters).

Rector peut repérer les endroits où une propriété aurait dû être privée dès le départ, et Tabnine devinera souvent le setter complet dès que vous commencez à taper private function set.

Certains diront « Oui, mais c'est fastidieux d'écrire ces fonctions ». Pas du tout.

L'extension en action​

Faites un clic droit sur une propriété, choisissez une action, et le code du getter/setter est généré pour vous :

Plus d'excuse pour les ignorer — l'extension PHP Getters & Setters tape à votre place.

Le mauvais scénario​

<?php

namespace Cavo;?

class Product
{
    public string $name = '';?
    public float $price = 0;?
}

Comme vous le voyez, $name est public, donc je peux écrire des choses comme ci-dessous et c'est... OK.

$product = new Product();
$product->name='coMPuteR';
$product->price=-10;

Par OK, je veux dire : bon, j'ai utilisé un mélange de minuscules et de majuscules pour le nom et, bon, j'ai dit que je vendais des ordinateurs à -10 €. C'est OK parce que je ne fais aucune validation sur les valeurs, et c'est très mauvais.

En utilisant un setter (une fonction appelée quand la propriété est initialisée), je peux vérifier la valeur et corriger la casse par exemple, ou refuser un prix négatif.

La bonne approche​

Créons notre classe avec des propriétés privées :

<?php

namespace Cavo;?

class Product
{
    private string $name = '';?
    private float $price = 0;?

    public function __construct()
    {
    }
}

Donc, pour chaque propriété, vous devez écrire une fonction appelée Getter pour lire son contenu et une autre appelée Setter pour la modifier. Ça pourrait être pénible, mais ça ne l'est pas, grâce à l'extension présentée en haut de cet article : faites juste un clic droit sur une propriété, choisissez l'action souhaitée et lancez-la.

Maintenant, je peux écrire :

$product = new Product();
$product->setName('coMPuteR');
$product->setPrice(-10);

Et le code qui utilise la classe :

//highlight-next-line
public function getName(): string
{
    return $this->name;
}

//highlight-next-line
public function setName(string $name): self
{
    // Force the product name to be written in lowercase
    $this->name = strtolower($name);?

    return $this;?
}

//highlight-next-line
public function getPrice(): float
{
    return $this->price;
}

//highlight-next-line
public function setPrice(float $price): self
{
    if ($price < 0) {?
        throw new \Exception("Negative prices are not correct; please review your code");
    }

    $this->price = $price;

    return $this;?
}

Laisser l'éditeur générer ce code répétitif est une façon de garder votre PHP propre. Le laisser vérifier votre code en est une autre : Développement PHP dans un devcontainer avec des outils de qualité de code préinstallés met en place un environnement prêt à l'emploi avec les linters et l'analyse statique déjà configurés.