屬性(Property)


屬性(Property)

在 PHP 中,類的成員變量也被稱爲屬性(properties)。它們是類定義的一部分,用來表現一個實例的狀態(也就是區分類的不同實例)。在具體實踐中,常常會想用一個稍微特殊些的方法實現屬性的讀寫。例如,要對label 屬性執行 trim 操作,可以用以下代碼實現:

  1. $object->label = trim($label);

上述代碼的缺點是隻要修改 label 屬性就必須再次調用 trim() 函數。若將來需要用其它方式處理 label 屬性,比如首字母大寫,就不得不修改所有給 label 屬性賦值的代碼。這種代碼的重複會導致 bug,這種實踐顯然需要儘可能避免。

爲解決該問題,Yii 引入了一個名爲 [[yii\base\Object]] 的基類,它支持基於類內的 getter 和 setter(讀取器和設定器)方法來定義屬性。如果某類需要支持這個特性,只需要繼承 [[yii\base\Object]] 或其子類即可。

補充:幾乎每個 Yii 框架的核心類都繼承自 [[yii\base\Object]] 或其子類。這意味着只要在核心類中見到 getter 或 setter 方法,就可以像調用屬性一樣調用它。

getter 方法是名稱以 get 開頭的方法,而 setter 方法名以 set 開頭。方法名中 get 或 set 後面的部分就定義了該屬性的名字。如下面代碼所示,getter 方法 getLabel() 和 setter 方法 setLabel() 操作的是 label屬性,:

  1. namespace app\\components; 
  2.  
  3. use yii\\base\\Object; 
  4.  
  5. class Foo extend Object 
  6.     private $_label; 
  7.  
  8.     public function getLabel() 
  9.     { 
  10.         return $this->_label; 
  11.     } 
  12.  
  13.     public function setLabel($value) 
  14.     { 
  15.         $this->_label = trim($value); 
  16.     } 
  17. }

(詳細解釋:getter 和 setter 方法創建了一個名爲 label 的屬性,在這個例子裏,它指向一個私有的內部屬性_label。)

getter/setter 定義的屬性用法與類成員變量一樣。兩者主要的區別是:當這種屬性被讀取時,對應的 getter 方法將被調用;而當屬性被賦值時,對應的 setter 方法就調用。如:

  1. // 等效於 $label = $object->getLabel(); 
  2. $label = $object->label; 
  3.  
  4. // 等效於 $object->setLabel('abc'); 
  5. $object->label = 'abc';

只定義了 getter 沒有 setter 的屬性是只讀屬性。嘗試賦值給這樣的屬性將導致 [[yii\base\InvalidCallException|InvalidCallException]] (無效調用)異常。類似的,只有 setter 方法而沒有 getter 方法定義的屬性是只寫屬性,嘗試讀取這種屬性也會觸發異常。使用只寫屬性的情況幾乎沒有。

通過 getter 和 setter 定義的屬性也有一些特殊規則和限制:

  • 這類屬性的名字是不區分大小寫的。如,$object->label 和 $object->Label 是同一個屬性。因爲 PHP 方法名是不區分大小寫的。
  • 如果此類屬性名和類成員變量相同,以後者爲準。例如,假設以上 Foo 類有個 label 成員變量,然後給$object->label = 'abc' 賦值,將賦給成員變量而不是 setter setLabel() 方法。
  • 這類屬性不支持可見性(訪問限制)。定義屬性的 getter 和 setter 方法是 public、protected 還是 private 對屬性的可見性沒有任何影響。
  • 這類屬性的 getter 和 setter 方法只能定義爲非靜態的,若定義爲靜態方法(static)則不會以相同方式處理。

回到開頭提到的問題,與其處處要調用 trim() 函數,現在我們只需在 setter setLabel() 方法內調用一次。如果 label 首字母變成大寫的新要求來了,我們只需要修改setLabel() 方法,而無須接觸任何其它代碼。