PHP: Свойства

Свойства

Переменные, которые являются членами класса, называются свойства. Также их называют, используя другие термины, такие как атрибуты или поля, но в рамках этой документации, мы будем называть их свойствами. Они определяются с помощью ключевых слов public, protected или private, могут сопровождаться необязательным объявлением типа и следуют правилам правильного объявления переменных. Это объявление может содержать инициализацию, но эта инициализация должна быть постоянным значением, то есть значение должно быть вычислено во время компиляции и не должны зависеть от информации, полученной во время выполнения для их вычисления.

Смотрите Область видимости для получения информации о применении public, protected, и private.

Замечание:
Для того, чтобы поддерживать обратную совместимость с PHP 4, PHP 5 по-прежнему позволяет использовать ключевое слово var при определении свойств вместо (или в дополнении к) public, protected, или private. Однако var больше не требуется. В версиях PHP с 5.0 по 5.1.3 использование var считалось устаревшим и выдавало предупреждение E_STRICT, но с PHP 5.1.3 больше не считается устаревшим и не выдаёт предупреждения.

Если вы объявляете свойство с помощью var вместо public, protected или private, тогда PHP 5 будет рассматривать свойство так, как если оно было объявлено как public.

В пределах методов класса доступ к нестатическим свойствам может быть получен с помощью -> (объектного оператора): $this->property (где property - имя свойства). Доступ к статическим свойствам осуществляется с помощью :: (двойного двоеточия): self::$property. Дополнительную информацию о различии статических и нестатических свойств смотрите в разделе "Ключевое слово Static".

Псевдопеременная $this доступна внутри любого метода класса, когда этот метод вызывается из контекста объекта. $this - это ссылка на вызываемый объект (обычно это объект, к которому принадлежит метод, но возможно и другого объекта, если метод вызван статически из контекста второго объекта).

Пример #1 Определение свойств


<?php
class SimpleClass
{
   // правильное определение свойства с PHP 5.6.0:
   public $var1 = 'hello ' . 'world';
   // правильное определение свойства с PHP 5.3.0:
   public $var2 = <<<EOD
hello world
EOD;
   // правильное определение свойства с PHP 5.6.0:
   public $var3 = 1+2;
   // неправильное определение свойств:
   public $var4 = self::myStaticMethod();
   public $var5 = $myVar;

   // правильное определение свойств:
   public $var6 = myConstant;
   public $var7 = array(true, false);

   // правильное определение свойства с PHP 5.3.0:
   public $var8 = <<<'EOD'
hello world
EOD;
}
?>

Замечание:
Существуют несколько интересных функций для обработки классов и объектов. Вы можете их увидеть тут Функции для классов/объектов.

Heredoc и Nowdoc

Начиная с PHP 5.3.0 heredocs и nowdocs могут быть использованы в любом статическом контексте данных, включая определение свойств.

Пример #2 Пример использования nowdoc для инициализации свойств


<?php
class foo {
   // Начиная с PHP 5.3.0
   public $bar = <<<'EOT'
bar
EOT;
   public $baz = <<<EOT
baz
EOT;
}
?>

Замечание:
Поддержка Nowdoc и Heredoc была добавлена в PHP 5.3.0.

Объявления типов

Начиная с PHP 7.4.0, в определении свойств могут быть указаны типы.

Пример #3 Пример использования типизированных свойств


<?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);

?>

Результат выполнения данного примера:

int(1234)
NULL

Перед обращением к типизированному свойству у него должно быть задано значение, иначе будет выброшено исключение Error.

Пример #4 Обращение к свойствам


<?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());
?>

Результат выполнения данного примера:

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

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

Допустимые типы свойств

Тип	Описание	Минимальная версия PHP
bool	Свойство должно быть со значением типа bool.	PHP 7.4.0
int	Свойство должно быть со значением типа int.	PHP 7.4.0
float	Свойство должно быть со значением типа float.	PHP 7.4.0
string	Свойство должно быть со значением типа string.	PHP 7.4.0
array	Свойство должно быть со значением типа array.	PHP 7.4.0
`object`	Свойство должно быть со значением типа object.	PHP 7.4.0
`iterable`	Свойство должно быть со значением типа array или объектом интерфейса Traversable (используется `instanceof`).	PHP 7.4.0
`self`	Свойство должно иметь тот же самый класс, в котором оно определено (используется `instanceof`).	PHP 7.4.0
`parent`	Свойство должно иметь родительский класс объекта, в котором оно определено (используется `instanceof`).	PHP 7.4.0
Имя класса/интерфейса	Свойство должно иметь указанный класс или интерфейс (используется `instanceof`).	PHP 7.4.0
?type	Свойство должно быть со значением указанного типа, либо `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 ¶

6 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