PHP: Propriétés

Propriétés

Les variables au sein d'une classe sont appelées propriétés. On peut également les retrouver sous les dénominations attributs, ou champs, mais nous conservons l'appellation propriété pour cette documentation. Elles sont définies en utilisant un des mots-clés public, protected, ou private, suivi optionellement d'une déclaration de type, suivi d'une déclaration classique de variable. Cette déclaration peut comprendre une initialisation, mais celle-ci doit être une valeur constante, c'est à dire qu'elle doit pouvoir être évaluée pendant la compilation du code, et qu'elle ne peut pas dépendre d'informations déterminées lors de l'exécution de celui-ci pour pouvoir être évaluée.

Référez-vous à Visibilité pour plus d'informations sur la signification de public, protected, et private.

Note:
Afin de maintenir la rétrocompatibilité avec PHP 4, PHP 5 continue d'accepter l'usage du mot-clé var pour la déclaration de propriétés en remplacement de (ou en plus de) public, protected, et private. Cependant, var n'est plus requis par le modèle objet de PHP 5. Pour les versions allant de PHP 5.0 à 5.1.3, l'usage de var était considéré comme obsolète et déclenchait un avertissement de niveau E_STRICT, mais depuis PHP 5.1.3, l'usage n'est plus obsolète et ne déclenche plus d'avertissement.

Si vous déclarez une propriété en utilisant var au lieu de public, protected, ou private, alors PHP 5 traitera la propriété comme si elle avait été déclarée comme public.

Au sein des méthodes de classes, les propriétés non statiques peuvent être appelées en utilisant la syntaxe -> (opérateur de l'objet) : $this->property (où property est le nom de la propriété). Les propriétés statiques peuvent être appelées en utilisant la syntaxe :: (deux doubles points) : self::$property. Reportez-vous à la documentation sur le mot clé statique pour plus d'informations sur la différence entre les propriétés statiques et non statiques.

La pseudo-variable $this est disponible au sein de n'importe quelle méthode, lorsque cette méthode est appelée depuis un objet. $this est une référence à l'objet appelant (en général l'objet auquel la méthode appartient, mais il peut s'agir d'un autre objet si la méthode est appelée de façon statique depuis le contexte d'un second objet).

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


<?php
class SimpleClass
{
   // À partir de PHP 5.6.0:
   public $var1 = 'hello ' . 'world';
   // Depuis PHP 5.3.0:
   public $var2 = <<<EOD
hello world
EOD;
   // À partir de PHP 5.6.0:
   public $var3 = 1+2;
   // déclaration de propriété invalide :
   public $var4 = self::myStaticMethod();
   public $var5 = $myVar;

   // Déclarations valides de propriétés :
   public $var6 = myConstant;
   public $var7 = array(true, false);

   // À partir de PHP 5.3.0 :
   public $var8 = <<<'EOD'
hello world
EOD;
}
?>

Note:
Il existe des fonctions qui permettent de gérer des classes et des objets. Vous voudrez peut-être jeter un coup d'oeil à Fonctions Classes/Objets.

Heredoc et Nowdoc

Depuis PHP 5.3.0 heredoc et nowdoc peuvent être utilisées dans n'importe quel contexte de données statiques, y compris la déclaration de propriétés.

Exemple #2 Exemple d'utilisation de la syntaxe nowdoc pour initialiser une propriété


<?php
class foo {
   // Depuis PHP 5.3.0
   public $bar = <<<'EOT'
bar
EOT;
   public $baz = <<<EOT
baz
EOT;
}
?>

Note:
Le support de la syntaxe Nowdoc et Heredoc a été ajouté en PHP 5.3.0.

Déclarations des types

À partir de PHP 7.4.0, les définitions de propriétés peuvent inclure une déclaration de type, avec l'exception du type callable.

Exemple #3 Exemple de propriétés typées


<?php

class User
{
    public int $id;
    public ?string $name;

    public function __construct(int $id, ?string $name)
    {
        $this->id = $id;
        $this->name = $name;
    }
}

$user = new User(1234, null);

var_dump($user->id);
var_dump($user->name);

?>

L'exemple ci-dessus va afficher :

int(1234)
NULL

Les propriétés typés doivent être initialisées avant d'y accéder, sinon, une Error sera émise.

Exemple #4 Accès aux propriétés


<?php

class Shape
{
    public int $numberOfSides;
    public string $name;

    public function setNumberOfSides(int $numberOfSides): void
    {
        $this->numberOfSides = $numberOfSides;
    }

    public function setName(string $name): void
    {
        $this->name = $name;
    }

    public function getNumberOfSides(): int
    {
        return $this->numberOfSides;
    }

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

$triangle = new Shape();
$triangle->setName("triangle");
$triangle->setNumberofSides(3);
var_dump($triangle->getName());
var_dump($triangle->getNumberOfSides());

$circle = new Shape();
$circle->setName("circle");
var_dump($circle->getName());
var_dump($circle->getNumberOfSides());
?>

L'exemple ci-dessus va afficher :

string(8) "triangle"
int(3)
string(6) "circle"

Fatal error: Uncaught Error: Typed property Shape::$numberOfSides must not be accessed before initialization

Types de propriété valides

Type	Description	version PHP minimale
bool	La propriété doit être une valeur booléen.	PHP 7.4.0
int	La propriété doit être une valeur integer.	PHP 7.4.0
float	La propriété doit être une nombre à virgule flottante.	PHP 7.4.0
string	La propriété doit être une string.	PHP 7.4.0
array	La propriété doit être un array.	PHP 7.4.0
`object`	La propriété doit être un object.	PHP 7.4.0
`iterable`	La propriété doit être soit un array ou un `instanceof` Traversable.	PHP 7.4.0
`self`	La propriété doit être un `instanceof` de la même classe dans laquelle la propriété a été définie.	PHP 7.4.0
`parent`	La propriété doit être un `instanceof` de la classe parent de la classe dans laquelle la propriété a été définie.	PHP 7.4.0
Nom de la classe/interface	La propriété doit être un `instanceof` de la classe ou de l'interface fournie.	PHP 7.4.0
?type	La propriété doit être du type spécifié, ou `NULL`.	PHP 7.4.0

add a note

User Contributed Notes 9 notes

down

304

Anonymous ¶

8 years ago


In case this saves anyone any time, I spent ages working out why the following didn't work:

class MyClass
{
    private $foo = FALSE;

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

        echo($this->$foo);
    }
}

$bar = new MyClass();

giving "Fatal error: Cannot access empty property in ...test_class.php on line 8"

The subtle change of removing the $ before accesses of $foo fixes this:

class MyClass
{
    private $foo = FALSE;

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

        echo($this->foo);
    }
}

$bar = new MyClass();

I guess because it's treating $foo like a variable in the first example, so trying to call $this->FALSE (or something along those lines) which makes no sense. It's obvious once you've realised, but there aren't any examples of accessing on this page that show that.

down

anca at techliminal dot com ¶

5 years ago


You can access property names with dashes in them (for example, because you converted an XML file to an object) in the following way:

<?php
$ref = new StdClass();
$ref->{'ref-type'} = 'Journal Article';
var_dump($ref);
?>

down

Anonymous ¶

9 years ago


$this can be cast to array.  But when doing so, it prefixes the property names/new array keys with certain data depending on the property classification.  Public property names are not changed.  Protected properties are prefixed with a space-padded '*'.  Private properties are prefixed with the space-padded class name...



<?php



class test

{

    public $var1 = 1;

    protected $var2 = 2;

    private $var3 = 3;

    static $var4 = 4;

    

    public function toArray()

    {

        return (array) $this;

    }

}



$t = new test;

print_r($t->toArray());



/* outputs:



Array

(

    [var1] => 1

    [ * var2] => 2

    [ test var3] => 3

)



*/

?>



This is documented behavior when converting any object to an array (see </language.types.array.php#language.types.array.casting> PHP manual page).  All properties regardless of visibility will be shown when casting an object to array (with exceptions of a few built-in objects).



To get an array with all property names unaltered, use the 'get_object_vars($this)' function in any method within class scope to retrieve an array of all properties regardless of external visibility, or 'get_object_vars($object)' outside class scope to retrieve an array of only public properties (see: </function.get-object-vars.php> PHP manual page).

down

php at webflips dot net ¶

6 years ago


Heredoc IS valid as of PHP 5.3 and this is documented in the manual at http://php.net/manual/en/language.types.string.php#language.types.string.syntax.heredoc

Only heredocs containing variables are invalid because then it becomes dynamic.

down

zzzzBov ¶

10 years ago


Do not confuse php's version of properties with properties in other languages (C++ for example).  In php, properties are the same as attributes, simple variables without functionality.  They should be called attributes, not properties.

Properties have implicit accessor and mutator functionality.  I've created an abstract class that allows implicit property functionality.

<?php

abstract class PropertyObject
{
  public function __get($name)
  {
    if (method_exists($this, ($method = 'get_'.$name)))
    {
      return $this->$method();
    }
    else return;
  }
  
  public function __isset($name)
  {
    if (method_exists($this, ($method = 'isset_'.$name)))
    {
      return $this->$method();
    }
    else return;
  }
  
  public function __set($name, $value)
  {
    if (method_exists($this, ($method = 'set_'.$name)))
    {
      $this->$method($value);
    }
  }
  
  public function __unset($name)
  {
    if (method_exists($this, ($method = 'unset_'.$name)))
    {
      $this->$method();
    }
  }
}

?>

after extending this class, you can create accessors and mutators that will be called automagically, using php's magic methods, when the corresponding property is accessed.

down

-9

Ashley Dambra ¶

6 years ago


Updated method objectThis() to transtypage class array properties or array to stdClass.

Hope it help you.

public function objectThis($array = null) {
    if (!$array) {
        foreach ($this as $property_name => $property_values) {
            if (is_array($property_values) && !empty($property_values)) {
                $this->{$property_name} = $this->objectThis($property_values);
            } else if (is_array($property_values) && empty($property_values)) {
                $this->{$property_name} = new stdClass();
            }
        }
    } else {
        $object = new stdClass();
        foreach ($array as $index => $values) {
            if (is_array($values) && empty($values)) {
                $object->{$index} = new stdClass();
            } else if (is_array($values)) {
                $object->{$index} = $this->objectThis($values);
            } else {
                $object->{$index} = $values;
            }
        }
        return $object;
    }
}

down

-8

Markus Zeller ¶

3 years ago


Accessing a property without any value initialized will give NULL.

class foo
{
  private $bar;

  public __construct()
  {
      var_dump($this->bar); // null
  }
}

down

-14

AshleyDambra at live dot com ¶

6 years ago


Add this method to you class in order to 'transtypage' all the array properties into stdClass();

Hope it help you.

public function objectThis($object = null) {
    if (!$object) {
        foreach ($this as $property_name => $property_values) {
            if (is_array($property_values)) {
                $this->{$property_name} = $this->objectThis($property_values);
            }
        }
    } else {
        $object2 = new stdClass();
        foreach ($object as $index => $values) {
            if (is_array($values)) {
                $object2->{$index} = $this->objectThis($values);
            } else {
                $object2->{$index} = $values;
            }
        }
        return $object2;
    }
}

down

-27

Anonymous ¶

5 years ago


In case this saves anyone any time, I spent ages working out why the following didn't work:



class MyClass

{

    private $foo = FALSE;



    public function __construct()

    {

        $this->$foo = TRUE;



        echo($this->$foo);

    }

}



$bar = new MyClass();



giving "Fatal error: Cannot access empty property in ...test_class.php on line 8"



The subtle change of removing the $ before accesses of $foo fixes this:



class MyClass

{

    private $foo = FALSE;



    public function __construct()

    {

        $this->foo = TRUE;



        echo($this->foo);

    }

}



$bar = new MyClass();



I guess because it's treating $foo like a variable in the first example, so trying to call $this->FALSE (or something along those lines) which makes no sense. It's obvious once you've realised, but there aren't any examples of accessing on this page that show that.



[Editor's note: Removed copy of note by zzzzBov]

add a note