Visibilité

La visibilité d'une propriété, d'une méthode ou (à partir de PHP 7.1.0) d'une constante peut être définie en préfixant sa déclaration avec un mot-clé : public, protected, ou private. Les éléments déclarés comme publics sont accessibles partout. L'accès aux éléments protégés est limité à la classe elle-même, ainsi qu'aux classes qui en héritent et à la classe parente. L'accès aux éléments privés est uniquement réservé à la classe qui les a définis.

Visibilité des propriétés

Les propriétés des classes peuvent être définies comme publiques, privées ou protégées. Les propriétés déclarées sans explicitement utiliser un mot-clef de visibilité seront automatiquement définies comme publiques.

Exemple #1 Déclaration de propriétés

<?php
/**
 * Définition de MyClass
 */
class MyClass
{
    public $public = 'Public';
    protected $protected = 'Protected';
    private $private = 'Private';

    function printHello()
    {
        echo $this->public;
        echo $this->protected;
        echo $this->private;
    }
}

$obj = new MyClass();
echo $obj->public; // Fonctionne
echo $obj->protected; // Erreur fatale
echo $obj->private; // Erreur fatale
$obj->printHello(); // Affiche Public, Protected et Private


/**
 * Définition de MyClass2
 */
class MyClass2 extends MyClass
{
    // On peut redéclarer les propriétés publiques ou protégées, mais pas celles privées
    public $public = 'Public2';
    protected $protected = 'Protected2';

    function printHello()
    {
      echo $this->public;
      echo $this->protected;
      echo $this->private;
   }
}

$obj2 = new MyClass2();
echo $obj2->public; // Fonctionne
echo $obj2->protected; // Erreur fatale
echo $obj2->private; // Indéfini
$obj2->printHello(); // Affiche Public2, Protected2 et Undefined (Indéfini)

?>

Visibilité Asymétrique des Propriétés

À partir de PHP 8.4, les propriétés peuvent également avoir leur visibilité définie de manière asymétrique, avec un champ différent pour la lecture (get) et l'écriture (set). Plus précisément, la visibilité set peut être spécifiée séparément, à condition qu'elle ne soit pas plus permissive que la visibilité par défaut.

Exemple #2 Visibilité Asymétrique des Propriétés

<?php
class Book
{
    public function __construct(
        public private(set) string $title,
        public protected(set) string $author,
        protected private(set) int $pubYear,
    ) {}
}

class SpecialBook extends Book
{
    public function update(string $author, int $year): void
    {
        $this->author = $author; // OK
        $this->pubYear = $year; // Erreur Fatale
    }
}

$b = new Book('Comment utiliser PHP', 'Peter H. Peterson', 2024);

echo $b->title; // Fonctionne
echo $b->author; // Fonctionne
echo $b->pubYear; // Erreur Fatale

$b->title = 'Comment ne pas utiliser PHP'; // Erreur Fatale
$b->author = 'Pedro H. Peterson'; // Erreur Fatale
$b->pubYear = 2023; // Erreur Fatale
?>

À partir de PHP 8.5, la visibilité set peut également être appliquée aux propriétés statiques des classes.

Exemple #3 Visibilité Asymétrique des Propriétés Statiques

<?php
class Manager
{
    public private(set) static int $calls = 0;

    public function doAThing(): string
    {
        self::$calls++;
        // Effectue d'autres opérations.
        return "une chaîne";
    }
}

$m = new Manager();

$m->doAThing(); // Fonctionne
echo Manager::$calls; // Fonctionne
Manager::$calls = 5; // Erreur fatale
?>

L'exemple ci-dessus va afficher :

1
Fatal error: Uncaught Error: Cannot modify private(set) property Manager::$calls from global scope in /some/file.php

Il y a quelques réserves concernant la visibilité asymétrique :

Seules les propriétés typées peuvent avoir une visibilité set séparée.
La visibilité set doit être la même que get ou plus restrictive. C'est-à-dire, public protected(set) et protected protected(set) sont autorisés, mais protected public(set) provoquera une erreur de syntaxe.
Si une propriété est public, alors la visibilité principale peut être omise. C'est-à-dire que public private(set) et private(set) auront le même résultat.
Une propriété avec une visibilité private(set) est automatiquement final, et ne peut pas être redéfinie dans une classe enfant.
Obtenir une référence à une propriété suit la visibilité set, pas get. Cela est dû au fait qu'une référence peut être utilisée pour modifier la valeur de la propriété.
De même, essayer d'écrire dans une propriété de tableau implique à la fois une opération get et une opération set en interne, et suivra donc la visibilité set, car c'est toujours la plus restrictive.

Note: Les espaces ne sont pas autorisés dans la déclaration de visibilité pour la modification. private(set) est correct. private( set ) n'est pas correct et entraînera une erreur d'analyse.

Lorsqu'une classe étend une autre, la classe enfant peut redéfinir toute propriété qui n'est pas final. En le faisant, elle peut élargir soit la visibilité principale, soit la visibilité set, à condition que la nouvelle visibilité soit la même ou plus large que celle de la classe parente. Cependant, il faut savoir que si une propriété private est remplacée, cela ne change pas réellement la propriété de la classe parente, mais crée une nouvelle propriété avec un nom interne différent.

Exemple #4 Héritage des Propriétés Asymétriques

<?php
class Book
{
    protected string $title;
    public protected(set) string $author;
    protected private(set) int $pubYear;
}

class SpecialBook extends Book
{
    public protected(set) string $title; // OK, car la lecture est plus large et l'écriture est la même.
    public string $author; // OK, car la lecture est la même et l'écriture est plus large.
    public protected(set) int $pubYear; // Erreur Fatale. Les propriétés private(set) sont finales.
}
?>

Visibilité des méthodes

Les méthodes des classes peuvent être définies comme publiques, privées ou protégées. Les méthodes déclarées sans explicitement utiliser un mot-clef de visibilité seront automatiquement définies comme publiques.

Exemple #5 Déclaration de méthodes

<?php
/**
 * Définition de MyClass
 */
class MyClass
{
    // Déclare un constructeur public
    public function __construct() { }

    // Déclare une méthode publique
    public function MyPublic() { }

    // Déclare une méthode protégée
    protected function MyProtected() { }

    // Déclare une méthode privée
    private function MyPrivate() { }

    // Celle-ci sera publique
    function Foo()
    {
        $this->MyPublic();
        $this->MyProtected();
        $this->MyPrivate();
    }
}

$myclass = new MyClass;
$myclass->MyPublic(); // Fonctionne
$myclass->MyProtected(); // Erreur fatale
$myclass->MyPrivate(); // Erreur fatale
$myclass->Foo(); // Public, Protected et Private fonctionnent


/**
 * Définition de MyClass2
 */
class MyClass2 extends MyClass
{
    // Celle-ci sera publique
    function Foo2()
    {
        $this->MyPublic();
        $this->MyProtected();
        $this->MyPrivate(); // Erreur fatale
    }
}

$myclass2 = new MyClass2;
$myclass2->MyPublic(); // Fonctionne
$myclass2->Foo2(); // Public et Protected fonctionnent, non Private

class Bar
{
    public function test() {
        $this->testPrivate();
        $this->testPublic();
    }

    public function testPublic() {
        echo "Bar::testPublic\n";
    }

    private function testPrivate() {
        echo "Bar::testPrivate\n";
    }
}

class Foo extends Bar
{
    public function testPublic() {
        echo "Foo::testPublic\n";
    }

    private function testPrivate() {
        echo "Foo::testPrivate\n";
    }
}

$myFoo = new Foo();
$myFoo->test(); // Bar::testPrivate
                // Foo::testPublic
?>

Visibilité des constantes

À partir de PHP 7.1.0, les constantes de classes peuvent être définies comme publiques, privées ou protégées. Les constantes déclarées sans mot clé de visibilité explicite sont définies en tant que public.

Exemple #6 Déclaration de constantes à partir de PHP 7.1.0

<?php
/**
 * Déclarons MyClass
 */
class MyClass
{
    // Déclarons une constante public
    public const MY_PUBLIC = 'public';

    // Déclarons une constante protégée
    protected const MY_PROTECTED = 'protected';

    // Déclarons une constante privée
    private const MY_PRIVATE = 'private';

    public function foo()
    {
        echo self::MY_PUBLIC;
        echo self::MY_PROTECTED;
        echo self::MY_PRIVATE;
    }
}

$myclass = new MyClass();
MyClass::MY_PUBLIC; // Fonctionne
MyClass::MY_PROTECTED; // Erreur fatale
MyClass::MY_PRIVATE; // Erreur fatale
$myclass->foo(); // Public, Protégée et Privée fonctionne


/**
 * Déclarons MyClass2
 */
class MyClass2 extends MyClass
{
    // Celle-ci sera publique
    function foo2()
    {
        echo self::MY_PUBLIC;
        echo self::MY_PROTECTED;
        echo self::MY_PRIVATE; // Erreur fatale
    }
}

$myclass2 = new MyClass2;
echo MyClass2::MY_PUBLIC; // Fonctionne
$myclass2->foo2(); // Public et Protégée fonctionne, mais pas Privée
?>

Visibilité depuis d'autres objets

Les objets de mêmes types ont accès aux membres privés et protégés les uns des autres, même s'ils ne sont pas la même instance. Ceci est dû au fait que les détails spécifiques de l'implémentation sont déjà connus en interne par ces objets.

Exemple #7 Accès aux membres privés d'un objet du même type

<?php
class Test
{
    private $foo;

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

    private function bar()
    {
        echo 'Accès à la méthode privée.';
    }

    public function baz(Test $other)
    {
        // Nous pouvons modifier la propriété privée :
        $other->foo = 'Bonjour';
        var_dump($other->foo);

        // Nous pouvons également appeler la méthode privée :
        $other->bar();
    }
}

$test = new Test('test');

$test->baz(new Test('other'));
?>

L'exemple ci-dessus va afficher :

string(7) "Bonjour"
Accès à la méthode privée.