PHP中如何实现只读成员变量？

Question

当尝试更改它时，抛出异常。

Answer 1

我想对于类属性，一个解决方案是：

• 不定义一个您感兴趣的名称的属性，
• 使用神奇的 __get 方法来访问该属性，使用“假”名称
• 定义 __set 方法，因此在尝试设置该属性时会引发异常。
• 有关魔术方法的更多信息，请参阅重载。

对于变量，我认为不可能有一个只读变量，当您尝试写入它时 PHP 会抛出异常。

例如，考虑这个小类：

class MyClass {
    protected $_data = array(
        'myVar' => 'test'
    );

    public function __get($name) {
        if (isset($this->_data[$name])) {
            return $this->_data[$name];
        } else {
            // non-existant property
            // => up to you to decide what to do
        }
    }

    public function __set($name, $value) {
        if ($name === 'myVar') {
            throw new Exception("not allowed : $name");
        } else {
            // => up to you to decide what to do
        }
    }
}

实例化该类并尝试读取属性：

$a = new MyClass();
echo $a->myVar . '<br />';

将为您提供预期的输出：

test

在尝试写入属性时：

$a->myVar = 10;

将为您提供异常：

Exception: not allowed : myVar in /.../temp.php on line 19

Answer 2

class test {
   const CANT_CHANGE_ME = 1;
}

您将其称为 test::CANT_CHANGE_ME

Answer 3

使用常数。关键字const

Answer 4

简而言之，您无法在 PHP 中创建只读对象成员变量。

事实上，大多数面向对象的语言都认为公开公开成员变量是一种糟糕的形式......（C# 是一个巨大而丑陋的例外，其属性构造）。

如果您想要一个类变量，请使用 const 关键字：

class MyClass {
    public const myVariable = 'x';
}

可以访问该变量：

echo MyClass::myVariable;

无论您有多少个 MyClass 类型的不同对象，该变量都将仅存在于一个版本中create，在大多数面向对象的场景中它几乎没有用处。

但是，如果您想要一个每个对象可以有不同值的只读变量，则应该使用私有成员变量和访问器方法（也称为 getter）：

class MyClass {
    private $myVariable;
    public function getMyVariable() {
        return $this->myVariable;
    }
    public function __construct($myVar) {
        $this->myVariable = $myVar;
    }
}

该变量在构造函数中设置，并将其设置为只读由于没有二传手。但是 MyClass 的每个实例都可以有自己的 myVariable 值。

$a = new MyClass(1);
$b = new MyClass(2);

echo $a->getMyVariable(); // 1
echo $b->getMyVariable(); // 2

$a->setMyVariable(3); // causes an error - the method doesn't exist
$a->myVariable = 3; // also error - the variable is private

Answer 5

我制作了另一个版本，在文档块中使用 @readonly 而不是 private $r_propname。这仍然不会阻止声明类设置属性，但适用于公共只读访问。

示例类：

class Person {
    use Readonly;

    /**
     * @readonly
     */
    protected $name;

    protected $phoneNumber;

    public function __construct($name){
        $this->name = $name;
        $this->phoneNumber = '123-555-1234';
    }
}

ReadOnly 特征

trait Readonly {

    public function readonly_getProperty($prop){
        if (!property_exists($this,$prop)){
            //pretty close to the standard error if a protected property is accessed from a public scope
            trigger_error('Undefined property: '.get_class($this).'::\
请参阅源代码&在 我的 gitlab 上进行测试
.$prop,E_USER_NOTICE);
        }
        
        $refProp = new \ReflectionProperty($this, $prop);
        $docblock = $refProp->getDocComment();
        // a * followed by any number of spaces, followed by @readonly
        $allow_read = preg_match('/\*\s*\@readonly/', $docblock);

        if ($allow_read){
            $actual = $this->$prop;
            return $actual;
        }
        
        throw new \Error("Cannot access non-public property '{$prop}' of class '".get_class($this)."'");
    }

    public function __get($prop){
        return $this->readonly_getProperty($prop);
    }
    
}

请参阅源代码&在 我的 gitlab 上进行测试

Answer 6

我也使用一个特征编写了一个版本。

尽管在这种情况下，该属性仍然可以通过其声明类来设置。

声明一个类，如下所示：

class Person {
    use Readonly;

    protected $name;
    //simply declaring this means "the 'name' property can be read by anyone"
    private $r_name;
}

这是我所做的特征：

trait Readonly {

    public function readonly_getProperty($prop){
        if (!property_exists($this,$prop)){
            //pretty close to the standard error if a protected property is accessed from a public scope
            // throw new \Error("Property '{$prop}' on class '".get_class($this)."' does not exist");
            trigger_error('Undefined property: '.get_class($this).'::\
请参阅源代码&在 我的 gitlab 上进行测试
.$prop,E_USER_NOTICE);
        }
        
        $allow_read = property_exists($this, 'r_'.$prop );

        if ($allow_read){
            $actual = $this->$prop;
            return $actual;
        }
        
        throw new \Error("Cannot access non-public property '{$prop}' of class '".get_class($this)."'");
    }

    public function __get($prop){
        return $this->readonly_getProperty($prop);
    }
    
}

请参阅源代码&在 我的 gitlab 上进行测试

Answer 7

我知道这是一个老问题，但帕斯卡的回答确实对我有帮助，我想补充一点。

__get() 不仅会在不存在的属性上触发，还会在“无法访问”的属性上触发，例如受保护的属性。这使得创建只读属性变得很容易！

class MyClass {
    protected $this;
    protected $that;
    protected $theOther;

    public function __get( $name ) {
        if ( isset( $this->$name ) ) {
            return $this->$name;
        } else {
            throw new Exception( "Call to nonexistent '$name' property of MyClass class" );
            return false;
        }
    }

    public function __set( $name ) {
        if ( isset( $this->$name ) ) {
            throw new Exception( "Tried to set nonexistent '$name' property of MyClass class" );
            return false;
        } else {
            throw new Exception( "Tried to set read-only '$name' property of MyClass class" );
            return false;
        }
    }
}