# 屬性(Property)
在 PHP 中,類的成員變量也被稱為**屬性(properties)**。它們是類定義的一部分,用來表現一個實例的狀態(也就是區分類的不同實例)。在具體實踐中,常常會想用一個稍微特殊些的方法實現屬性的讀寫。例如,如果有需求每次都要對?`label`?屬性執行 trim 操作,就可以用以下代碼實現:
~~~
$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`?屬性,:
~~~
namespace app\components;
use yii\base\Object;
class Foo extend Object
{
private $_label;
public function getLabel()
{
return $this->_label;
}
public function setLabel($value)
{
$this->_label = trim($value);
}
}
~~~
(詳細解釋:getter 和 setter 方法創建了一個名為?`label`?的屬性,在這個例子里,它指向一個私有的內部屬性?`_label`。)
getter/setter 定義的屬性用法與類成員變量一樣。兩者主要的區別是:當這種屬性被讀取時,對應的 getter 方法將被調用;而當屬性被賦值時,對應的 setter 方法就調用。如:
~~~
// 等效于 $label = $object->getLabel();
$label = $object->label;
// 等效于 $object->setLabel('abc');
$object->label = 'abc';
~~~
只定義了 getter 沒有 setter 的屬性是**只讀屬性**。嘗試賦值給這樣的屬性將導致 yii\base\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()`?方法,而無須接觸任何其它代碼。
- 介紹(Introduction)
- 關于 Yii(About Yii)
- 從 Yii 1.1 升級(Upgrading from Version 1.1)
- 入門(Getting Started)
- 安裝 Yii(Installing Yii)
- 運行應用(Running Applications)
- 第一次問候(Saying Hello)
- 使用 Forms(Working with Forms)
- 玩轉 Databases(Working with Databases)
- 用 Gii 生成代碼(Generating Code with Gii)
- 更上一層樓(Looking Ahead)
- 應用結構(Application Structure)
- 結構概述(Overview)
- 入口腳本(Entry Scripts)
- 應用(Applications)
- 應用組件(Application Components)
- 控制器(Controllers)
- 模型(Models)
- 視圖(Views)
- 模塊(Modules)
- 過濾器(Filters)
- 小部件(Widgets)
- 前端資源(Assets)
- 擴展(Extensions)
- 請求處理(Handling Requests)
- 運行概述(Overview)
- 引導(Bootstrapping)
- 路由引導與創建 URL(Routing and URL Creation)
- 請求(Requests)
- 響應(Responses)
- Sessions and Cookies
- 錯誤處理(Handling Errors)
- 日志(Logging)
- 關鍵概念(Key Concepts)
- 組件(Components)
- 屬性(Properties)
- 事件(Events)
- 行為(Behaviors)
- 配置(Configurations)
- 別名(Aliases)
- 類自動加載(Class Autoloading)
- 服務定位器(Service Locator)
- 依賴注入容器(Dependency Injection Container)
- 配合數據庫工作(Working with Databases)
- 數據庫訪問(Data Access Objects): 數據庫連接、基本查詢、事務和模式操作
- 查詢生成器(Query Builder): 使用簡單抽象層查詢數據庫
- 活動記錄(Active Record): 活動記錄對象關系映射(ORM),檢索和操作記錄、定義關聯關系
- 數據庫遷移(Migrations): 在團體開發中對你的數據庫使用版本控制
- Sphinx
- Redis
- MongoDB
- ElasticSearch
- 接收用戶數據(Getting Data from Users)
- 創建表單(Creating Forms)
- 輸入驗證(Validating Input)
- 文件上傳(Uploading Files)
- 收集列表輸入(Collecting Tabular Input)
- 多模型同時輸入(Getting Data for Multiple Models)
- 顯示數據(Displaying Data)
- 格式化輸出數據(Data Formatting)
- 分頁(Pagination)
- 排序(Sorting)
- 數據提供器(Data Providers)
- 數據小部件(Data Widgets)
- 操作客戶端腳本(Working with Client Scripts)
- 主題(Theming)
- 安全(Security)
- 認證(Authentication)
- 授權(Authorization)
- 處理密碼(Working with Passwords)
- 客戶端認證(Auth Clients)
- 安全領域的最佳實踐(Best Practices)
- 緩存(Caching)
- 概述(Overview)
- 數據緩存(Data Caching)
- 片段緩存(Fragment Caching)
- 分頁緩存(Page Caching)
- HTTP 緩存(HTTP Caching)
- RESTful Web 服務
- 快速入門(Quick Start)
- 資源(Resources)
- 控制器(Controllers)
- 路由(Routing)
- 格式化響應(Response Formatting)
- 授權驗證(Authentication)
- 速率限制(Rate Limiting)
- 版本化(Versioning)
- 錯誤處理(Error Handling)
- 開發工具(Development Tools)
- 調試工具欄和調試器(Debug Toolbar and Debugger)
- 使用 Gii 生成代碼(Generating Code using Gii)
- TBD 生成 API 文檔(Generating API Documentation)
- 測試(Testing)
- 概述(Overview)
- 搭建測試環境(Testing environment setup)
- 單元測試(Unit Tests)
- 功能測試(Functional Tests)
- 驗收測試(Acceptance Tests)
- 測試夾具(Fixtures)
- 高級專題(Special Topics)
- 高級應用模版(Advanced Project Template)
- 從頭構建自定義模版(Building Application from Scratch)
- 控制臺命令(Console Commands)
- 核心驗證器(Core Validators)
- 國際化(Internationalization)
- 收發郵件(Mailing)
- 性能優化(Performance Tuning)
- 共享主機環境(Shared Hosting Environment)
- 模板引擎(Template Engines)
- 集成第三方代碼(Working with Third-Party Code)
- 小部件(Widgets)
- Bootstrap 小部件(Bootstrap Widgets)
- jQuery UI 小部件(jQuery UI Widgets)
- 助手類(Helpers)
- 助手一覽(Overview)
- Array 助手(ArrayHelper)
- Html 助手(Html)
- Url 助手(Url)