在 PHP 中,類的成員變數也被稱為屬性(properties)。它們是類定義的一部分,用來表現一個範例的狀態(也就是區分類的不同範例)。在具體實踐中,常常會想用一個稍微特殊些的方法實現屬性的讀寫。例如,要對label
屬性執行 trim 操作,可以用以下程式碼實現:
上述程式碼的缺點是只要修改 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
屬性,:
(詳細解釋:getter 和 setter 方法建立了一個名為 label
的屬性,在這個例子裡,它指向一個私有的內部屬性_label
。)
getter/setter 定義的屬性用法與類成員變數一樣。兩者主要的區別是:當這種屬性被讀取時,對應的 getter 方法將被呼叫;而當屬性被賦值時,對應的 setter 方法就呼叫。如:
只定義了 getter 沒有 setter 的屬性是唯讀屬性。嘗試賦值給這樣的屬性將導致 [[yii\base\InvalidCallException|InvalidCallException]] (無效呼叫)異常。類似的,只有 setter 方法而沒有 getter 方法定義的屬性是只寫屬性,嘗試讀取這種屬性也會觸發異常。使用只寫屬性的情況幾乎沒有。
通過 getter 和 setter 定義的屬性也有一些特殊規則和限制:
回到開頭提到的問題,與其處處要呼叫 trim()
函式,現在我們只需在 setter setLabel()
方法內呼叫一次。如果 label 首字母變成大寫的新要求來了,我們只需要修改setLabel()
方法,而無須接觸任何其它程式碼。