マジックメソッド __set

マジックメソッド __set は、存在しない、または現在のコンテキストでアクセスできないプロパティに値を代入しようとしたときに自動的に呼び出されます。このメソッドは2つのパラメータを受け取ります:プロパティ名と、代入しようとしている値です。

構文

phppublic function __set(string $name, mixed $value): void

例

存在しないプロパティの設定をインターセプトするために __set を使用するクラスを作成します:

php<?php
  class User {
    private $data = [];
    
    public function __set($name, $value) {
      $this->data[$name] = $value;
    }
    
    public function getData() {
      return $this->data;
    }
  }
  
  $user = new User();
  $user->email = 'test@example.com';
  $user->age = 25;
  print_r($user->getData());
?>

コード実行結果:

phpArray
(
  [email] => test@example.com
  [age] => 25
)

例

設定前のデータ検証に __set を使用する例:

php<?php
  class Product {
    private $price;
    
    public function __set($name, $value) {
      if ($name === 'price') {
        if (!is_numeric($value) || $value < 0) {
          throw new Exception('無効な価格の値です');
        }
        $this->price = $value;
      }
    }
    
    public function getPrice() {
      return $this->price;
    }
  }
  
  $product = new Product();
  $product->price = 100;
  echo $product->getPrice();
?>

コード実行結果:

php100

関連項目

  • アクセス不可能なプロパティの読み取りをインターセプトするマジックメソッド __get
  • プロパティの存在チェックをインターセプトするマジックメソッド __isset