哈希空间 Ctrl + F 进行搜索
首页 php手册中文版 CSS中文手册 哈希文档 Markdown在线工具

属性

类的变量成员叫做属性,或者叫字段,在本文档统一称为属性。 属性开头至少使用一个修饰符(比如 访问控制(可见性)静态(static)关键字, 或者自 PHP 8.1.0 起支持的 readonly), 除了 readonly 属性之外都是可选的,然后自 PHP 7.4 起可以跟一个类型声明,然后跟一个普通的变量声明来组成。属性中的变量可以初始化,但是初始化的值必须是 常量值。

注意:

另一种过时的声明类属性的方法是使用 var 关键字,而不是使用修饰符。

注意: 没有声明 访问控制(可见性) 修饰符的属性将默认声明为 public

在类的成员方法里面,可以用 ->(对象运算符):$this->property(其中 property 是该属性名)这种方式来访问非静态属性。静态属性则是用 ::(双冒号):self::$property 来访问。更多静态属性与非静态属性的区别参见 静态(static)关键字

当一个方法在类定义内部被调用时,有一个可用的伪变量 $this$this 是一个到主叫对象的引用(通常是该方法所从属的对象,但如果是从第二个对象静态调用时也可能是另一个对象)。

示例 #1 属性声明

<?php
class SimpleClass
{
   public 
$var1 'hello ' 'world';
   public 
$var2 = <<<EOD
hello world
EOD;
   public 
$var3 1+2;
   
// 正确的属性声明
   
public $var4 self::myStaticMethod();
   public 
$var5 $myVar;

   
// 正确的属性声明
   
public $var6 myConstant;
   public 
$var7 = array(truefalse);

   public 
$var8 = <<<'EOD'
hello world
EOD;

   
// 没有访问控制修饰符:
   
static $var9;
   
readonly int $var10;
}
?>

注意:

更多关于类/对象的处理函数,请查看类/对象函数

类型声明

从 PHP 7.4.0 开始,属性定义可以包含类型声明,但 callable 除外。

示例 #2 类型声明的示例

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

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

?>

以上例程会输出:

int(1234)
NULL

类型属性必须在访问前初始化,否则会抛出 Error

示例 #3 访问属性

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

Readonly properties

As of PHP 8.1.0, a property can be declared with the readonly modifier, which prevents modification of the property after initialization.

示例 #4 Example of readonly properties

<?php
class Test {
   public 
readonly string $prop;
   public function 
__construct(string $prop) {
       
// Legal initialization.
       
$this->prop $prop;
   }
}
$test = new Test("foobar");
// Legal read.
var_dump($test->prop); // string(6) "foobar"
// Illegal reassignment. It does not matter that the assigned value is the same.
$test->prop "foobar";
// Error: Cannot modify readonly property Test::$prop
?>

注意:

The readonly modifier can only be applied to typed properties. A readonly property without type constraints can be created using the mixed type.

注意:

Readonly static properties are not supported.

A readonly property can only be initialized once, and only from the scope where it has been declared. Any other assignment or modification of the property will result in an Error exception.

示例 #5 Illegal initialization of readonly properties

<?php
class Test1 {
    public 
readonly string $prop;
}
$test1 = new Test1;
// Illegal initialization outside of private scope.
$test1->prop "foobar";
// Error: Cannot initialize readonly property Test1::$prop from global scope
?>

注意:

Specifying an explicit default value on readonly properties is not allowed, because a readonly property with a default value is essentially the same as a constant, and thus not particularly useful.

<?php
class Test {
    
// Fatal error: Readonly property Test::$prop cannot have default value
    
public readonly int $prop 42;
}
?>

注意:

Readonly properties cannot be unset() once they are initialized. However, it is possible to unset a readonly property prior to initialization, from the scope where the property has been declared.

Modifications are not necessarily plain assignments, all of the following will also result in an Error exception:

<?php
class Test {
    public function 
__construct(
        public 
readonly int $i 0,
        public 
readonly array $ary = [],
    ) {}
}
$test = new Test;
$test->+= 1;
$test->i++;
++
$test->i;
$test->ary[] = 1;
$test->ary[0][] = 1;
$ref =& $test->i;
$test->=& $ref;
byRef($test->i);
foreach (
$test as &$prop);
?>

However, readonly properties do not preclude interior mutability. Objects (or resources) stored in readonly properties may still be modified internally:

<?php
class Test {
    public function 
__construct(public readonly object $obj) {}
}
$test = new Test(new stdClass);
// Legal interior mutation.
$test->obj->foo 1;
// Illegal reassignment.
$test->obj = new stdClass;
?>
打开 哈希空间 微信小程序中查看更佳