web-dev-qa-db-ja.com

PHP __getおよび__setマジックメソッド

誤解がない限り、__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で実行されています。

phpmagic-methods
81
airbear

__get、__set、__call、および__callStaticは、メソッドまたはプロパティにアクセスできないときに呼び出されます。 $barは公開されているため、アクセスできません。

マニュアルのプロパティのオーバーロードに関するセクション： を参照してください

  • __set()は、アクセスできないプロパティにデータを書き込むときに実行されます。
  • __get()は、アクセスできないプロパティからデータを読み取るために利用されます。

魔法のメソッドはゲッターとセッターの代わりではありません。それらは、エラーが発生するメソッド呼び出しまたはプロパティアクセスを処理できるようにするだけです。そのため、エラー処理に関連するものがはるかに多くあります。また、適切なgetterおよびsetterまたは直接メソッド呼び出しを使用するよりもかなり遅いことに注意してください。

150
Gordon

__set()を介してすべての値を保存するために配列を使用することをお勧めします。

class foo {

    protected $values = array();

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

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

}

このようにして、衝突を避けるために、別の方法で変数にアクセスできないようにします（$valuesが保護されていることに注意してください）。

31
Alex Sawallich

PHPマニュアル から：

  • __set（）は、アクセスできないプロパティにデータを書き込むときに実行されます。
  • __get（）は、アクセスできないプロパティからデータを読み取るために使用されます。

これは、読み取り/書き込みinaccessibleプロパティでのみ呼び出されます。ただし、あなたの財産は公開されているため、アクセス可能です。アクセス修飾子を保護に変更すると、問題が解決します。

18
Berry Langerak

Berryの答えを拡張するには、アクセスレベルをprotectedに設定すると、__ getおよび__setを明示的に宣言されたプロパティ（少なくともクラスの外部からアクセスされる場合）で使用でき、速度がかなり遅くなるので、別の質問からコメントを引用しますこのトピックで、とにかくそれを使用するケースを作ります：

__ getはカスタムget関数よりも遅い（同じことをする）ことに同意します、これは__get（）の時間の0.0124455であり、この0.0024445は10000ループ後のカスタムget（）の時間です。 -Melsi 12年11月23日22:32 ベストプラクティス：PHP Magicメソッド__setおよび__get

Melsiのテストによると、かなり遅くなると約5倍遅くなります。これは間違いなくかなり遅いですが、テストでは、このメソッドでプロパティに10,000回アクセスでき、ループ反復の時間を約1/100秒でカウントできることも示されています。定義された実際のgetメソッドおよびsetメソッドと比較するとかなり遅くなりますが、それは控えめですが、物事の大まかなスキームでは、5倍遅くても実際に遅くなることはありません。

操作の計算時間は依然として無視でき、現実のアプリケーションの99％で考慮する価値はありません。実際に回避する必要があるのは、1回のリクエストで10,000回以上プロパティに実際にアクセスするときだけです。トラフィックの多いサイトは、アプリケーションを実行し続けるためにさらに数台のサーバーを投入する余裕がない場合、本当に間違ったことをしています。アクセス率が問題となる、トラフィックの多いサイトのフッターに表示される単一行のテキスト広告は、おそらくその行のテキストを含む1,000台のサーバーのファームに料金を支払う可能性があります。アプリケーションのプロパティへのアクセスには100万分の1秒かかるため、エンドユーザーは、ページの読み込みにこれほど時間がかかっているのではないかと考えて指をたたくことはありません。

これは、.NETのバックグラウンドから来た開発者として言えますが、コンシューマへの非表示のgetおよびsetメソッドは.NETの発明ではありません。それらは単にそれらなしのプロパティではありません。これらの魔法のメソッドは、プロパティのバージョンを「プロパティ」と呼んでも、PHPの開発者にとっての恵みです。また、PHPのVisual Studio拡張機能は、保護されたプロパティでインテリセンスをサポートしますが、そのトリックを念頭に置いて考えています。このように魔法の__getメソッドと__setメソッドを使用する十分な開発者であれば、PHP開発者は開発者コミュニティに対応するために実行時間を調整すると思います。

編集：理論的には、保護されたプロパティはほとんどの状況で機能すると思われました。実際には、クラス定義および拡張クラス内のプロパティにアクセスするときに、ゲッターとセッターを使用したい場合が多いことがわかります。より良い解決策は、他のクラスを拡張するための基本クラスとインターフェイスです。そのため、基本クラスから実装クラスに数行のコードをコピーするだけです。私は自分のプロジェクトの基本クラスでもう少しやっているので、現在提供するインターフェースはありませんが、ここでは、プロパティを削除および移動するためにリフレクションを使用してマジックプロパティを取得および設定する、テストされていないクラスダウン定義があります保護された配列：

/** 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;
    }
}

コードにバグがある場合はおMyび申し上げます。

6
Jason Ensinger

$ barはパブリックプロパティであるためです。

$foo->bar = 'test';

上記を実行するときにマジックメソッドを呼び出す必要はありません。

クラスからpublic $bar;を削除すると、これが修正されます。

5
Matt Lowden

以下の例のように、定義済みのカスタムset/getメソッドを使用して、マジックset/getメソッドを最適に使用します。この方法で、2つの世界のベストを組み合わせることができます。速度に関しては、少し遅いですが、違いさえ感じられます。以下の例では、定義済みのセッターに対してデータ配列を検証しています。

「魔法のメソッドはゲッターとセッターの代替ではありません。そうしないとエラーが発生するメソッド呼び出しやプロパティアクセスを処理することができます。」

そのため、両方を使用する必要があります。

クラスアイテムの例

    /*
    * 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);
    }
}

INDEX.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
1
DevWL

public $bar;宣言を削除すると、期待どおりに機能するはずです。

0
Alix Axel