PHP の Yii フレームワークの Model モデルの學(xué)習(xí)チュートリアル yiimodel

モデルは MVC パターンの一部であり、ビジネス データ、ルール、ロジックを表すオブジェクトです。

モデルは CModel またはそのサブクラスのインスタンスです。モデルは、データとそれに関連付けられたビジネス ロジックを保持するために使用されます。

モデルは別個(gè)のデータオブジェクトです。データ テーブル內(nèi)の行、またはユーザーが入力したフォームにすることができます。 データ オブジェクトの各フィールドは、モデル內(nèi)の屬性に対応します。各屬性にはラベルがあり、一連のルールを通じて検証できます。

Yii はフォームモデルとアクティブレコードの 2 種類のモデルを?qū)g裝します。どちらも同じ基本クラス CModel を継承しています。

フォーム モデルは CFormModel のインスタンスです。フォーム モデルは、ユーザーの入力から取得したデータを保持するために使用されます。 このデータは多くの場合、取得、使用され、その後破棄されます。たとえば、ログイン ページでは、フォーム モデルを使用して、エンド ユーザーが提供したユーザー名とパスワードの情報(bào)を表すことができます。

アクティブ レコード (AR) は、オブジェクト指向スタイルでデータベース アクセスを抽象化するための設(shè)計(jì)パターンです。 各 AR オブジェクトは、CActiveRecord のインスタンスまたはそのサブクラスの 1 つです。データテーブル內(nèi)の行を表します。 行內(nèi)のフィールドは、AR オブジェクトのプロパティに対応します。

Model クラスは、yiibaseModel またはそのサブクラスを継承することで定義できます。基本クラス yiibaseModel は、多くの実用的な機(jī)能をサポートします。

屬性: 通常のクラス屬性または配列のようにアクセスできるビジネス データを表します。
屬性ラベル: 指定された屬性によって表示されるラベル;
ブロック割り當(dāng)て: 1 つのステップで多くの屬性への値の割り當(dāng)てをサポートします;
検証ルール: 入力データが宣言された検証ルールに準(zhǔn)拠していることを確認(rèn)します。
データ エクスポート: モデル データをカスタム形式の配列としてエクスポートできます。

プロパティ

モデルは屬性を通じてビジネス データを表します。各屬性は、モデルのパブリックにアクセス可能な屬性のようなものです。 yiibaseModel::attributes() は、モデルが所有する屬性を指定します。

モデルのプロパティには、オブジェクトのプロパティと同じようにアクセスできます:

リーリー

yiibaseModel の ArrayAccess および ArrayIterator のサポートのおかげで、プロパティには配列セル項(xiàng)目と同様にアクセスすることもできます。 リーリー

屬性を定義する

デフォルトでは、モデルクラスは yiibaseModel から直接継承し、すべての非靜的パブリックメンバー変數(shù)はプロパティです。 たとえば、次の ContactForm モデル クラスには、名前、電子メール、件名、本文の 4 つの屬性があります。ContactForm モデルは、HTML フォームから取得した入力データを表すために使用されます。

リーリー

もう 1 つの方法は、yiibaseModel::attributes() をオーバーライドして屬性を定義することです。このメソッドはモデルの屬性名を返します。 たとえば、yiidbActiveRecord は、対応するデータ テーブルの列名をその屬性名として返します。屬性に通常のオブジェクト屬性のようにアクセスできるようにするには、__get()、__set() などのマジック メソッドをオーバーライドする必要がある場合があることに注意してください。

屬性タグ

屬性が表示されるとき、または入力が取得されるときに、屬性に関連するラベルを表示する必要があることがよくあります。たとえば、屬性の名前が firstName であるとすると、フォーム入力やエラー メッセージなどの場所で、First Name を表示することができます。 、エンドユーザーにとってよりフレンドリーなラベルです。

yiibaseModel::getAttributeLabel() を呼び出して屬性のラベルを取得できます。例:

リーリー

デフォルトでは、屬性ラベルは yiibaseModel::generateAttributeLabel() メソッドを通じて屬性名から自動(dòng)的に生成され、キャメルケースの変數(shù)名を最初の文字を大文字にした複數(shù)の単語に自動(dòng)的に変換されます。たとえば、username は Username に、firstName は に変換されます。名に変換されました。

自動(dòng)生成されたラベルを使用したくない場合は、 yiibaseModel::attributeLabels() メソッドをオーバーライドして、屬性ラベルを明示的に指定できます。例:

リーリー

アプリケーションが複數(shù)の言語をサポートしている場合、以下に示すように、翻訳可能な屬性ラベルを yiibaseModel::attributeLabels() メソッドで定義できます。 リーリー

たとえばモデルのシナリオを使用して同じ屬性に対して異なるラベルを返すなど、條件に基づいてラベルを定義することもできます。

補(bǔ)足: 屬性ラベルはビューの一部ですが、モデル內(nèi)でラベルを宣言すると通常は非常に便利で、コードが非常に簡潔で再利用可能になります。

シーン

モデルは複數(shù)のシナリオで使用できます。たとえば、ユーザー モジュールはユーザーのログイン入力を収集したり、ユーザーの登録時(shí)に使用したりできます。 異なるシナリオでは、モデルは異なるビジネス ルールとロジックを使用する場合があります。たとえば、電子メール屬性は登録時(shí)には必須ですが、ログイン時(shí)には必須ではありません。

モデルは yiibaseModel::scenario 屬性を使用して、使用シナリオを追跡します。デフォルトでは、モデルは、default という名前のシナリオをサポートします。以下に、シナリオを設(shè)定する 2 つの方法を示します。 リーリー

デフォルトでは、モデルでサポートされるシナリオはモデルで宣言された検証ルールによって決定されますが、以下に示すように yiibaseModel::scenarios() メソッドをオーバーライドすることで動(dòng)作をカスタマイズできます。

namespace app\models;

use yii\db\ActiveRecord;

class User extends ActiveRecord
{
  public function scenarios()
  {
    return [
      'login' => ['username', 'password'],
      'register' => ['username', 'email', 'password'],
    ];
  }
}

補(bǔ)充：在上述和下述的例子中，模型類都是繼承yii\db\ActiveRecord， 因?yàn)槎鄨鼍暗氖褂猛ǔ０l(fā)生在Active Record 類中.
scenarios() 方法返回一個(gè)數(shù)組，數(shù)組的鍵為場景名，值為對應(yīng)的 active attributes活動(dòng)屬性。 活動(dòng)屬性可被 塊賦值 并遵循驗(yàn)證規(guī)則在上述例子中，username 和 password 在login場景中啟用，在 register 場景中, 除了 username and password 外 email也被啟用。

scenarios() 方法默認(rèn)實(shí)現(xiàn)會(huì)返回所有yii\base\Model::rules()方法申明的驗(yàn)證規(guī)則中的場景， 當(dāng)覆蓋scenarios()時(shí)，如果你想在默認(rèn)場景外使用新場景，可以編寫類似如下代碼：

namespace app\models;

use yii\db\ActiveRecord;

class User extends ActiveRecord
{
  public function scenarios()
  {
    $scenarios = parent::scenarios();
    $scenarios['login'] = ['username', 'password'];
    $scenarios['register'] = ['username', 'email', 'password'];
    return $scenarios;
  }
}

場景特性主要在驗(yàn)證 和 屬性塊賦值 中使用。 你也可以用于其他目的，例如可基于不同的場景定義不同的 屬性標(biāo)簽。

驗(yàn)證規(guī)則

當(dāng)模型接收到終端用戶輸入的數(shù)據(jù)，數(shù)據(jù)應(yīng)當(dāng)滿足某種規(guī)則(稱為 驗(yàn)證規(guī)則, 也稱為 業(yè)務(wù)規(guī)則)。 例如假定ContactForm模型，你可能想確保所有屬性不為空且 email 屬性包含一個(gè)有效的郵箱地址， 如果某個(gè)屬性的值不滿足對應(yīng)的業(yè)務(wù)規(guī)則，相應(yīng)的錯(cuò)誤信息應(yīng)顯示，以幫助用戶修正錯(cuò)誤。

可調(diào)用 yii\base\Model::validate() 來驗(yàn)證接收到的數(shù)據(jù)， 該方法使用yii\base\Model::rules()申明的驗(yàn)證規(guī)則來驗(yàn)證每個(gè)相關(guān)屬性， 如果沒有找到錯(cuò)誤，會(huì)返回 true，否則它會(huì)將錯(cuò)誤保存在 yii\base\Model::errors 屬性中并返回false，例如：

$model = new \app\models\ContactForm;

// 用戶輸入數(shù)據(jù)賦值到模型屬性
$model->attributes = \Yii::$app->request->post('ContactForm');

if ($model->validate()) {
  // 所有輸入數(shù)據(jù)都有效 all inputs are valid
} else {
  // 驗(yàn)證失?。?errors 是一個(gè)包含錯(cuò)誤信息的數(shù)組
  $errors = $model->errors;
}

通過覆蓋 yii\base\Model::rules() 方法指定模型屬性應(yīng)該滿足的規(guī)則來申明模型相關(guān)驗(yàn)證規(guī)則。 下述例子顯示ContactForm模型申明的驗(yàn)證規(guī)則:

public function rules()
{
  return [
    // name, email, subject 和 body 屬性必須有值
    [['name', 'email', 'subject', 'body'], 'required'],

    // email 屬性必須是一個(gè)有效的電子郵箱地址
    ['email', 'email'],
  ];
}

一條規(guī)則可用來驗(yàn)證一個(gè)或多個(gè)屬性，一個(gè)屬性可對應(yīng)一條或多條規(guī)則。 更多關(guān)于如何申明驗(yàn)證規(guī)則的詳情請參考 驗(yàn)證輸入 一節(jié).

有時(shí)你想一條規(guī)則只在某個(gè) 場景 下應(yīng)用，為此你可以指定規(guī)則的 on 屬性，如下所示:

public function rules()
{
  return [
    // 在"register" 場景下 username, email 和 password 必須有值
    [['username', 'email', 'password'], 'required', 'on' => 'register'],

    // 在 "login" 場景下 username 和 password 必須有值
    [['username', 'password'], 'required', 'on' => 'login'],
  ];
}

如果沒有指定 on 屬性，規(guī)則會(huì)在所有場景下應(yīng)用， 在當(dāng)前yii\base\Model::scenario 下應(yīng)用的規(guī)則稱之為 active rule活動(dòng)規(guī)則。

一個(gè)屬性只會(huì)屬于scenarios()中定義的活動(dòng)屬性且在rules()申明對應(yīng)一條或多條活動(dòng)規(guī)則的情況下被驗(yàn)證。

塊賦值

塊賦值只用一行代碼將用戶所有輸入填充到一個(gè)模型，非常方便， 它直接將輸入數(shù)據(jù)對應(yīng)填充到 yii\base\Model::attributes 屬性。 以下兩段代碼效果是相同的，都是將終端用戶輸入的表單數(shù)據(jù)賦值到 ContactForm 模型的屬性， 明顯地前一段塊賦值的代碼比后一段代碼簡潔且不易出錯(cuò)。

$model = new \app\models\ContactForm;
$model->attributes = \Yii::$app->request->post('ContactForm');
$model = new \app\models\ContactForm;
$data = \Yii::$app->request->post('ContactForm', []);
$model->name = isset($data['name']) ? $data['name'] : null;
$model->email = isset($data['email']) ? $data['email'] : null;
$model->subject = isset($data['subject']) ? $data['subject'] : null;
$model->body = isset($data['body']) ? $data['body'] : null;

安全屬性

塊賦值只應(yīng)用在模型當(dāng)前yii\base\Model::scenario場景yii\base\Model::scenarios()方法 列出的稱之為 安全屬性 的屬性上，例如，如果User模型申明以下場景， 當(dāng)當(dāng)前場景為login時(shí)候，只有username and password 可被塊賦值，其他屬性不會(huì)被賦值。

public function scenarios()
{
  return [
    'login' => ['username', 'password'],
    'register' => ['username', 'email', 'password'],
  ];
}

補(bǔ)充: 塊賦值只應(yīng)用在安全屬性上，因?yàn)槟阆肟刂颇男傩詴?huì)被終端用戶輸入數(shù)據(jù)所修改， 例如，如果 User 模型有一個(gè)permission屬性對應(yīng)用戶的權(quán)限， 你可能只想讓這個(gè)屬性在后臺界面被管理員修改。
由于默認(rèn)yii\base\Model::scenarios()的實(shí)現(xiàn)會(huì)返回yii\base\Model::rules()所有屬性和數(shù)據(jù)， 如果不覆蓋這個(gè)方法，表示所有只要出現(xiàn)在活動(dòng)驗(yàn)證規(guī)則中的屬性都是安全的。

為此，提供一個(gè)特別的別名為 safe 的驗(yàn)證器來申明哪些屬性是安全的不需要被驗(yàn)證， 如下示例的規(guī)則申明 title 和 description都為安全屬性。

public function rules()
{
  return [
    [['title', 'description'], 'safe'],
  ];
}

非安全屬性

如上所述，yii\base\Model::scenarios() 方法提供兩個(gè)用處：定義哪些屬性應(yīng)被驗(yàn)證，定義哪些屬性安全。 在某些情況下，你可能想驗(yàn)證一個(gè)屬性但不想讓他是安全的，可在scenarios()方法中屬性名加一個(gè)驚嘆號 !。 例如像如下的secret屬性。

public function scenarios()
{
  return [
    'login' => ['username', 'password', '!secret'],
  ];
}

當(dāng)模型在 login 場景下，三個(gè)屬性都會(huì)被驗(yàn)證，但只有 username和 password 屬性會(huì)被塊賦值， 要對secret屬性賦值，必須像如下例子明確對它賦值。

$model->secret = $secret;

數(shù)據(jù)導(dǎo)出

模型通常要導(dǎo)出成不同格式，例如，你可能想將模型的一個(gè)集合轉(zhuǎn)成JSON或Excel格式， 導(dǎo)出過程可分解為兩個(gè)步驟，第一步，模型轉(zhuǎn)換成數(shù)組；第二步，數(shù)組轉(zhuǎn)換成所需要的格式。 你只需要關(guān)注第一步，因?yàn)榈诙娇杀煌ㄓ玫臄?shù)據(jù)轉(zhuǎn)換器如yii\web\JsonResponseFormatter來完成。

將模型轉(zhuǎn)換為數(shù)組最簡單的方式是使用 yii\base\Model::attributes 屬性，例如：

$post = \app\models\Post::findOne(100);
$array = $post->attributes;

yii\base\Model::attributes 屬性會(huì)返回 所有 yii\base\Model::attributes() 申明的屬性的值。

更靈活和強(qiáng)大的將模型轉(zhuǎn)換為數(shù)組的方式是使用 yii\base\Model::toArray() 方法， 它的行為默認(rèn)和 yii\base\Model::attributes 相同， 但是它允許你選擇哪些稱之為字段的數(shù)據(jù)項(xiàng)放入到結(jié)果數(shù)組中并同時(shí)被格式化。 實(shí)際上，它是導(dǎo)出模型到 RESTful 網(wǎng)頁服務(wù)開發(fā)的默認(rèn)方法，詳情請參閱響應(yīng)格式.

字段

字段是模型通過調(diào)用yii\base\Model::toArray()生成的數(shù)組的單元名。

默認(rèn)情況下，字段名對應(yīng)屬性名，但是你可以通過覆蓋 yii\base\Model::fields() 和/或 yii\base\Model::extraFields() 方法來改變這種行為， 兩個(gè)方法都返回一個(gè)字段定義列表，fields() 方法定義的字段是默認(rèn)字段，表示toArray()方法默認(rèn)會(huì)返回這些字段。extraFields()方法定義額外可用字段，通過toArray()方法指定$expand參數(shù)來返回這些額外可用字段。 例如如下代碼會(huì)返回fields()方法定義的所有字段和extraFields()方法定義的prettyName and fullAddress字段。

$array = $model->toArray([], ['prettyName', 'fullAddress']);
可通過覆蓋 fields() 來增加、刪除、重命名和重定義字段，fields() 方法返回值應(yīng)為數(shù)組， 數(shù)組的鍵為字段名，數(shù)組的值為對應(yīng)的可為屬性名或匿名函數(shù)返回的字段定義對應(yīng)的值。 特使情況下，如果字段名和屬性定義名相同，可以省略數(shù)組鍵，例如：

// 明確列出每個(gè)字段，特別用于你想確保數(shù)據(jù)表或模型屬性改變不會(huì)導(dǎo)致你的字段改變(保證后端的API兼容).
public function fields()
{
  return [
    // 字段名和屬性名相同
    'id',

    // 字段名為 "email"，對應(yīng)屬性名為 "email_address"
    'email' => 'email_address',

    // 字段名為 "name", 值通過PHP代碼返回
    'name' => function () {
      return $this->first_name . ' ' . $this->last_name;
    },
  ];
}

// 過濾掉一些字段，特別用于你想繼承父類實(shí)現(xiàn)并不想用一些敏感字段
public function fields()
{
  $fields = parent::fields();

  // 去掉一些包含敏感信息的字段
  unset($fields['auth_key'], $fields['password_hash'], $fields['password_reset_token']);

  return $fields;
}

警告：由于模型的所有屬性會(huì)被包含在導(dǎo)出數(shù)組，最好檢查數(shù)據(jù)確保沒包含敏感數(shù)據(jù)， 如果有敏感數(shù)據(jù)，應(yīng)覆蓋 fields() 方法過濾掉，在上述列子中，我們選擇過濾掉 auth_key, password_hash and password_reset_token。
最佳實(shí)踐

模型是代表業(yè)務(wù)數(shù)據(jù)、規(guī)則和邏輯的中心地方，通常在很多地方重用， 在一個(gè)設(shè)計(jì)良好的應(yīng)用中，模型通常比控制器代碼多。

歸納起來，模型：

• 可包含屬性來展示業(yè)務(wù)數(shù)據(jù);
• 可包含驗(yàn)證規(guī)則確保數(shù)據(jù)有效和完整;
• 可包含方法實(shí)現(xiàn)業(yè)務(wù)邏輯;
• 不應(yīng)直接訪問請求，session和其他環(huán)境數(shù)據(jù)，這些數(shù)據(jù)應(yīng)該由控制器傳入到模型;
• 應(yīng)避免嵌入HTML或其他展示代碼，這些代碼最好在 視圖中處理;
• 單個(gè)模型中避免太多的場景.

在開發(fā)大型復(fù)雜系統(tǒng)時(shí)應(yīng)經(jīng)?？紤]最后一條建議， 在這些系統(tǒng)中，模型會(huì)很大并在很多地方使用，因此會(huì)包含需要規(guī)則集和業(yè)務(wù)邏輯， 最后維護(hù)這些模型代碼成為一個(gè)噩夢，因?yàn)橐粋€(gè)簡單修改會(huì)影響好多地方， 為確保模型好維護(hù)，最好使用以下策略：

定義可被多個(gè) 應(yīng)用主體 或 模塊 共享的模型基類集合。 這些模型類應(yīng)包含通用的最小規(guī)則集合和邏輯。
在每個(gè)使用模型的 應(yīng)用主體 或 模塊中， 通過繼承對應(yīng)的模型基類來定義具體的模型類，具體模型類包含應(yīng)用主體或模塊指定的規(guī)則和邏輯。
例如，在高級應(yīng)用模板，你可以定義一個(gè)模型基類common\models\Post， 然后在前臺應(yīng)用中，定義并使用一個(gè)繼承common\models\Post的具體模型類frontend\models\Post， 在后臺應(yīng)用中可以類似地定義backend\models\Post。 通過這種策略，你清楚frontend\models\Post只對應(yīng)前臺應(yīng)用，如果你修改它，就無需擔(dān)憂修改會(huì)影響后臺應(yīng)用。

您可能感興趣的文章:

• 詳解PHP的Yii框架中自帶的前端資源包的使用
• 簡介PHP的Yii框架中緩存的一些高級用法
• 深入解析PHP的Yii框架中的緩存功能
• PHP的Yii框架中View視圖的使用進(jìn)階
• PHP的Yii框架中創(chuàng)建視圖和渲染視圖的方法詳解
• 詳解PHP的Yii框架中的Controller控制器
• PHP的Yii框架中移除組件所綁定的行為的方法
• PHP的Yii框架中行為的定義與綁定方法講解
• 深入講解PHP的Yii框架中的屬性（Property）
• 詳解PHP的Yii框架中擴(kuò)展的安裝與使用