Propriétés PHP en lecture seule ?

Question

En utilisant les classes DOM de PHP (DOMNode, DOMEElement, etc), j'ai remarqué qu'elles possèdent des propriétés en lecture seule. Par exemple, je peux lire la propriété $nodeName d'un DOMNode, mais je ne peux pas y écrire (si je le fais, PHP envoie une erreur fatale).

Comment puis-je créer mes propres propriétés en lecture seule en PHP ?

Answer 1

Vous pouvez le faire comme ça :

class Example {
    private $__readOnly = 'hello world';
    function __get($name) {
        if($name === 'readOnly')
            return $this->__readOnly;
        user_error("Invalid property: " . __CLASS__ . "->$name");
    }
    function __set($name, $value) {
        user_error("Can't set property: " . __CLASS__ . "->$name");
    }
}

Ne l'utilisez que lorsque vous en avez vraiment besoin - il est plus lent que l'accès normal à la propriété. En PHP, il est préférable d'adopter une politique consistant à n'utiliser que les méthodes setter pour modifier une propriété depuis l'extérieur.

Answer 2

Depuis PHP 8.1, il existe des propriétés natives en lecture seule.

Documentation

Vous ne pouvez initialiser une propriété en lecture seule qu'une seule fois lors de la déclaration de la propriété.

class Test {
    public readonly string $prop;

    public function __construct(string $prop) {
        $this->prop = $prop;
    }
}

--

class Test {
    public function __construct(
        public readonly string $prop,
    ) {}
}

Essayer de modifier la propriété en lecture seule provoquera l'erreur suivante :

Error: Cannot modify readonly property Test::$prop

Answer 3

Mais les propriétés privées exposées uniquement à l'aide de __get() ne sont pas visibles pour les fonctions qui énumèrent les membres d'un objet - json_encode() par exemple.

Je passe régulièrement des objets PHP à Javascript en utilisant json_encode() car cela semble être un bon moyen de passer des structures complexes avec beaucoup de données provenant d'une base de données. Je dois utiliser des propriétés publiques dans ces objets pour que ces données soient transmises au Javascript qui les utilise, mais cela signifie que ces propriétés doivent être publiques (et donc courir le risque qu'un autre programmeur qui n'est pas sur la même longueur d'onde (ou probablement moi-même après une mauvaise nuit) puisse les modifier directement). Si je les rends privées et utilise __get() et __set(), alors json_encode() ne les voit pas.

Ne serait-il pas agréable d'avoir un mot-clé d'accessibilité "en lecture seule" ?

Answer 4

Je vois que vous avez déjà obtenu votre réponse, mais pour ceux qui cherchent encore.. :

Il suffit de déclarer toutes les variables "en lecture seule" comme étant privées ou protégées et d'utiliser la méthode magique __get() comme ceci :

/**
 * This is used to fetch readonly variables, you can not read the registry
 * instance reference through here.
 * 
 * @param string $var
 * @return bool|string|array
 */
public function __get($var)
{
    return ($var != "instance" && isset($this->$var)) ? $this->$var : false;
}

Comme vous pouvez le voir, j'ai également protégé la variable $this->instance car cette méthode permettra aux utilisateurs de lire toutes les variables déclarées. Pour bloquer plusieurs variables, utilisez un tableau avec in_array().

Answer 5

Voici un moyen de rendre toutes les propriétés de votre classe en lecture seule depuis l'extérieur, les classes héritées ont un accès en écriture ;-).

class Test {
    protected $foo;
    protected $bar;

    public function __construct($foo, $bar) {
        $this->foo = $foo;
        $this->bar = $bar;
    }

/**
 * All property accessible from outside but readonly
 * if property does not exist return null
 *
 * @param string $name
 *
 * @return mixed|null
 */
    public function __get ($name) {
        return $this->$name ?? null;
    }

/**
 * __set trap, property not writeable
 *
 * @param string $name
 * @param mixed $value
 *
 * @return mixed
 */
    function __set ($name, $value) {
        return $value;
    }
}

testé en php7