PHP __get 和 __set 魔术方法

Question

除非我完全错误，否则 __get 和 __set 方法应该允许重载 → get 和 set >。

例如，以下语句应调用 __get 方法：

echo $foo->bar;
$var = $foo->bar;

以下语句应使用 __set 方法：

$foo->bar = 'test';

这在我的代码中不起作用，但可以通过这个简单的示例重现：

class foo {

    public $bar;
    public function __get($name) {

        echo "Get:$name";
        return $this->$name;
    }

    public function __set($name, $value) {

        echo "Set:$name to $value";
        $this->$name = $value;
    }
}


$foo = new foo();

echo $foo->bar;
$foo->bar = 'test';

echo "[$foo->bar]";

这只会导致：

[test]

将一些 die() 调用放在那里表明它根本没有命中它。

现在，我只是说搞砸了，并且在目前需要的地方手动使用 __get ，但这不是很动态，并且需要知道“重载”代码实际上不会被调用，除非专门调用。我想知道这是否不应该按照我理解的方式发挥作用，或者为什么这不起作用。

它在 php 5.3.3 上运行。

Answer 1

当方法或属性不可访问时，将调用 __get、__set、__call 和 __callStatic。您的 $bar 是公开的，因此并非不可访问。

请参阅手册中有关属性重载的部分：

• __set() 在将数据写入不可访问的属性时运行。
• __get() 用于从不可访问的属性中读取数据。

魔术方法不能替代 getter 和 setter。它们只允许您处理方法调用或属性访问，否则会导致错误。因此，还有更多与错误处理相关的内容。另请注意，它们比使用正确的 getter 和 setter 或直接方法调用要慢得多。

Answer 2

我建议使用数组通过 __set() 存储所有值。

class foo {

    protected $values = array();

    public function __get( $key )
    {
        return $this->values[ $key ];
    }

    public function __set( $key, $value )
    {
        $this->values[ $key ] = $value;
    }

}

这样您就可以确保无法以其他方式访问变量（请注意，$values 受到保护），以避免冲突。

Answer 3

从 PHP 手册来看：

• __set() 在将数据写入不可访问的属性时运行。
• __get() 用于从不可访问的属性中读取数据。

仅在读取/写入不可访问属性时调用此方法。然而，您的财产是公共的，这意味着它是可以访问的。将访问修饰符更改为 protected 可以解决该问题。

Answer 4

为了扩展 Berry 的答案，将访问级别设置为 protected 允许 __get 和 __set 与显式声明的属性一起使用（至少在类外部访问时），并且速度要慢得多，我将引用另一个问题的评论关于这个主题并提出使用它的理由：

我同意 __get 对于自定义 get 函数（做同样的事情）来说更慢，这是 __get() 的时间 0.0124455，这个 0.0024445 用于自定义 get () 10000 次循环后。 – 梅尔西，2012 年 11 月 23 日 22:32 最佳实践：PHP 魔术方法 __set 和 __get

根据 Melsi 的测试，相当慢大约慢 5 倍。这肯定要慢得多，但还要注意，测试表明您仍然可以使用此方法访问属性 10,000 次（计算循环迭代的时间），大约需要 1/100 秒。与实际定义的 get 和 set 方法相比，它要慢得多，这是轻描淡写的说法，但从总体上看，即使慢 5 倍实际上也不会慢。

在 99% 的现实应用中，该操作的计算时间仍然可以忽略不计，不值得考虑。唯一真正应该避免的情况是当您实际上要在单个请求中访问属性超过 10,000 次时。如果高流量站点无法承担更多服务器来保持应用程序运行的费用，那么它们确实在做错事。在访问率成为问题的高流量网站的页脚上放置单行文本广告可能可以支付包含该行文本的 1,000 台服务器的费用。最终用户永远不会敲击手指，想知道是什么导致页面加载时间这么长，因为应用程序的属性访问需要百万分之一秒。

我是作为一名具有 .NET 背景的开发人员这么说的，但对消费者不可见的 get 和 set 方法并不是 .NET 的发明。没有它们，它们根本就不是属性，这些神奇的方法是 PHP 开发人员的可取之处，甚至可以将其版本的属性称为“属性”。另外，我认为，PHP 的 Visual Studio 扩展确实支持具有受保护属性的智能感知，考虑到这一技巧。我认为，如果有足够多的开发人员以这种方式使用神奇的 __get 和 __set 方法，PHP 开发人员就会调整执行时间来迎合开发人员社区。

编辑：理论上，受保护的属性似乎在大多数情况下都有效。在实践中，事实证明，在访问类定义和扩展类中的属性时，很多时候您会想要使用 getter 和 setter。更好的解决方案是在扩展其他类时使用基类和接口，因此您只需将几行代码从基类复制到实现类中即可。我正在对我的项目的基类做更多的事情，所以我现在没有可以提供的接口，但这里是未经测试的精简类定义，其中具有神奇的属性获取和设置，使用反射来删除和移动属性受保护的数组：

/** Base class with magic property __get() and __set() support for defined properties. */
class Component {
    /** Gets the properties of the class stored after removing the original
     * definitions to trigger magic __get() and __set() methods when accessed. */
    protected $properties = array();

    /** Provides property get support. Add a case for the property name to
     * expand (no break;) or replace (break;) the default get method. When
     * overriding, call parent::__get($name) first and return if not null,
     * then be sure to check that the property is in the overriding class
     * before doing anything, and to implement the default get routine. */
    public function __get($name) {
        $caller = array_shift(debug_backtrace());
        $max_access = ReflectionProperty::IS_PUBLIC;
        if (is_subclass_of($caller['class'], get_class($this)))
            $max_access = ReflectionProperty::IS_PROTECTED;
        if ($caller['class'] == get_class($this))
            $max_access = ReflectionProperty::IS_PRIVATE;
        if (!empty($this->properties[$name])
            && $this->properties[$name]->class == get_class()
            && $this->properties[$name]->access <= $max_access)
            switch ($name) {
                default:
                    return $this->properties[$name]->value;
            }
    }

    /** Provides property set support. Add a case for the property name to
     * expand (no break;) or replace (break;) the default set method. When
     * overriding, call parent::__set($name, $value) first, then be sure to
     * check that the property is in the overriding class before doing anything,
     * and to implement the default set routine. */
    public function __set($name, $value) {
        $caller = array_shift(debug_backtrace());
        $max_access = ReflectionProperty::IS_PUBLIC;
        if (is_subclass_of($caller['class'], get_class($this)))
            $max_access = ReflectionProperty::IS_PROTECTED;
        if ($caller['class'] == get_class($this))
            $max_access = ReflectionProperty::IS_PRIVATE;
        if (!empty($this->properties[$name])
            && $this->properties[$name]->class == get_class()
            && $this->properties[$name]->access <= $max_access)
            switch ($name) {
                default:
                    $this->properties[$name]->value = $value;
            }
    }

    /** Constructor for the Component. Call first when overriding. */
    function __construct() {
        // Removing and moving properties to $properties property for magic
        // __get() and __set() support.
        $reflected_class = new ReflectionClass($this);
        $properties = array();
        foreach ($reflected_class->getProperties() as $property) {
            if ($property->isStatic()) { continue; }
            $properties[$property->name] = (object)array(
                'name' => $property->name, 'value' => $property->value
                , 'access' => $property->getModifier(), 'class' => get_class($this));
            unset($this->{$property->name}); }
        $this->properties = $properties;
    }
}

如果代码中有任何错误，我深表歉意。

Answer 5

这是因为 $bar 是公共财产。

$foo->bar = 'test';

运行上面的时候不需要调用魔术方法。

从你的类中删除 public $bar; 应该可以纠正这个问题。

Answer 6

最好将魔术设置/获取方法与预定义的自定义设置/获取方法一起使用，如下例所示。这样您就可以结合两个世界的优点。就速度而言，我同意它们慢一点，但你能感觉到差异吗？下面的示例还根据预定义的设置器验证数据数组。

“魔术方法不能替代 getter 和 setter。它们
只是允许您处理方法调用或属性访问
否则会导致错误。”

这就是为什么我们应该同时使用两者。

类项目示例

    /*
    * Item class
    */
class Item{
    private $data = array();

    function __construct($options=""){ //set default to none
        $this->setNewDataClass($options); //calling function
    }

    private function setNewDataClass($options){
        foreach ($options as $key => $value) {
            $method = 'set'.ucfirst($key); //capitalize first letter of the key to preserve camel case convention naming
            if(is_callable(array($this, $method))){  //use seters setMethod() to set value for this data[key];      
                $this->$method($value); //execute the setters function
            }else{
                $this->data[$key] = $value; //create new set data[key] = value without seeters;
            }   
        }
    }

    private function setNameOfTheItem($value){ // no filter
        $this->data['name'] = strtoupper($value); //assign the value
        return $this->data['name']; // return the value - optional
    }

    private function setWeight($value){ //use some kind of filter
        if($value >= "100"){ 
            $value = "this item is too heavy - sorry - exceeded weight of maximum 99 kg [setters filter]";
        }
        $this->data['weight'] = strtoupper($value); //asign the value
        return $this->data['weight']; // return the value - optional
    }

    function __set($key, $value){
        $method = 'set'.ucfirst($key); //capitalize first letter of the key to preserv camell case convention naming
        if(is_callable(array($this, $method))){  //use seters setMethod() to set value for this data[key];      
            $this->$method($value); //execute the seeter function
        }else{
            $this->data[$key] = $value; //create new set data[key] = value without seeters;
        }
    }

    function __get($key){
        return $this->data[$key];
    }

    function dump(){
        var_dump($this);
    }
}

索引.PHP

$data = array(
    'nameOfTheItem' => 'tv',
    'weight' => '1000',
    'size' => '10x20x30'
);

$item = new Item($data);
$item->dump();

$item->somethingThatDoNotExists = 0; // this key (key, value) will trigger magic function __set() without any control or check of the input,
$item->weight = 99; // this key will trigger predefined setter function of a class - setWeight($value) - value is valid,
$item->dump();

$item->weight = 111; // this key will trigger predefined setter function of a class - setWeight($value) - value invalid - will generate warning.
$item->dump(); // display object info

输出

object(Item)[1]
  private 'data' => 
    array (size=3)
      'name' => string 'TV' (length=2)
      'weight' => string 'THIS ITEM IS TOO HEAVY - SORRY - EXIDED WEIGHT OF MAXIMUM 99 KG [SETTERS FILTER]' (length=80)
      'size' => string '10x20x30' (length=8)
object(Item)[1]
  private 'data' => 
    array (size=4)
      'name' => string 'TV' (length=2)
      'weight' => string '99' (length=2)
      'size' => string '10x20x30' (length=8)
      'somethingThatDoNotExists' => int 0
object(Item)[1]
  private 'data' => 
    array (size=4)
      'name' => string 'TV' (length=2)
      'weight' => string 'THIS ITEM IS TOO HEAVY - SORRY - EXIDED WEIGHT OF MAXIMUM 99 KG [SETTERS FILTER]' (length=80)
      'size' => string '10x20x30' (length=8)
      'somethingThatDoNotExists' => int 0

Answer 7

删除 public $bar; 声明，它应该按预期工作。

Answer 8

意图：

__GET($k){
 return $this->$k;
}

_SET($k,$v){
 return $this->$k = $v;
}