検索

ホームページ >バックエンド開発 >PHPチュートリアル >PHP の Yii フレームワークの Model モデルの学習チュートリアル、yiimodel_PHP チュートリアル

PHP の Yii フレームワークの Model モデルの学習チュートリアル、yiimodel_PHP チュートリアル

WBOY
WBOYオリジナル
2016-07-12 08:55:16860ブラウズ

PHP の Yii フレームワークの Model モデルの学習チュートリアル yiimodel

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

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

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

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

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

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

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

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

プロパティ

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

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

リーリー

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

属性を定義する

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

リーリー

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

属性タグ

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

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

リーリー

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

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

リーリー

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

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

補足: 属性ラベルはビューの一部ですが、モデル内でラベルを宣言すると通常は非常に便利で、コードが非常に簡潔で再利用可能になります。

シーン


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

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

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

namespace app\models;

use yii\db\ActiveRecord;

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

补充：在上述和下述的例子中，模型类都是继承yii\db\ActiveRecord， 因为多场景的使用通常发生在Active Record 类中.
scenarios() 方法返回一个数组，数组的键为场景名，值为对应的 active attributes活动属性。 活动属性可被 块赋值 并遵循验证规则在上述例子中，username 和 password 在login场景中启用，在 register 场景中, 除了 username and password 外 email也被启用。

scenarios() 方法默认实现会返回所有yii\base\Model::rules()方法申明的验证规则中的场景， 当覆盖scenarios()时，如果你想在默认场景外使用新场景，可以编写类似如下代码：

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;
  }
}

场景特性主要在验证 和 属性块赋值 中使用。 你也可以用于其他目的，例如可基于不同的场景定义不同的 属性标签。

验证规则

当模型接收到终端用户输入的数据，数据应当满足某种规则(称为 验证规则, 也称为 业务规则)。 例如假定ContactForm模型，你可能想确保所有属性不为空且 email 属性包含一个有效的邮箱地址， 如果某个属性的值不满足对应的业务规则，相应的错误信息应显示，以帮助用户修正错误。

可调用 yii\base\Model::validate() 来验证接收到的数据， 该方法使用yii\base\Model::rules()申明的验证规则来验证每个相关属性， 如果没有找到错误，会返回 true，否则它会将错误保存在 yii\base\Model::errors 属性中并返回false，例如：

$model = new \app\models\ContactForm;

// 用户输入数据赋值到模型属性
$model->attributes = \Yii::$app->request->post('ContactForm');

if ($model->validate()) {
  // 所有输入数据都有效 all inputs are valid
} else {
  // 验证失败：$errors 是一个包含错误信息的数组
  $errors = $model->errors;
}

通过覆盖 yii\base\Model::rules() 方法指定模型属性应该满足的规则来申明模型相关验证规则。 下述例子显示ContactForm模型申明的验证规则:

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

    // email 属性必须是一个有效的电子邮箱地址
    ['email', 'email'],
  ];
}

一条规则可用来验证一个或多个属性，一个属性可对应一条或多条规则。 更多关于如何申明验证规则的详情请参考 验证输入 一节.

有时你想一条规则只在某个 场景 下应用，为此你可以指定规则的 on 属性，如下所示:

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

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

如果没有指定 on 属性，规则会在所有场景下应用， 在当前yii\base\Model::scenario 下应用的规则称之为 active rule活动规则。

一个属性只会属于scenarios()中定义的活动属性且在rules()申明对应一条或多条活动规则的情况下被验证。

块赋值

块赋值只用一行代码将用户所有输入填充到一个模型，非常方便， 它直接将输入数据对应填充到 yii\base\Model::attributes 属性。 以下两段代码效果是相同的，都是将终端用户输入的表单数据赋值到 ContactForm 模型的属性， 明显地前一段块赋值的代码比后一段代码简洁且不易出错。

$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;

安全属性

块赋值只应用在模型当前yii\base\Model::scenario场景yii\base\Model::scenarios()方法 列出的称之为 安全属性 的属性上，例如，如果User模型申明以下场景， 当当前场景为login时候，只有username and password 可被块赋值，其他属性不会被赋值。

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

补充: 块赋值只应用在安全属性上，因为你想控制哪些属性会被终端用户输入数据所修改， 例如，如果 User 模型有一个permission属性对应用户的权限， 你可能只想让这个属性在后台界面被管理员修改。
由于默认yii\base\Model::scenarios()的实现会返回yii\base\Model::rules()所有属性和数据， 如果不覆盖这个方法，表示所有只要出现在活动验证规则中的属性都是安全的。

为此，提供一个特别的别名为 safe 的验证器来申明哪些属性是安全的不需要被验证， 如下示例的规则申明 title 和 description都为安全属性。

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

非安全属性

如上所述，yii\base\Model::scenarios() 方法提供两个用处：定义哪些属性应被验证，定义哪些属性安全。 在某些情况下，你可能想验证一个属性但不想让他是安全的，可在scenarios()方法中属性名加一个惊叹号 !。 例如像如下的secret属性。

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

当模型在 login 场景下，三个属性都会被验证，但只有 username和 password 属性会被块赋值， 要对secret属性赋值，必须像如下例子明确对它赋值。

$model->secret = $secret;

数据导出

模型通常要导出成不同格式，例如，你可能想将模型的一个集合转成JSON或Excel格式， 导出过程可分解为两个步骤，第一步，模型转换成数组；第二步，数组转换成所需要的格式。 你只需要关注第一步，因为第二步可被通用的数据转换器如yii\web\JsonResponseFormatter来完成。

将模型转换为数组最简单的方式是使用 yii\base\Model::attributes 属性，例如：

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

yii\base\Model::attributes 属性会返回 所有 yii\base\Model::attributes() 申明的属性的值。

更灵活和强大的将模型转换为数组的方式是使用 yii\base\Model::toArray() 方法， 它的行为默认和 yii\base\Model::attributes 相同， 但是它允许你选择哪些称之为字段的数据项放入到结果数组中并同时被格式化。 实际上，它是导出模型到 RESTful 网页服务开发的默认方法，详情请参阅响应格式.

字段

字段是模型通过调用yii\base\Model::toArray()生成的数组的单元名。

默认情况下，字段名对应属性名，但是你可以通过覆盖 yii\base\Model::fields() 和/或 yii\base\Model::extraFields() 方法来改变这种行为， 两个方法都返回一个字段定义列表，fields() 方法定义的字段是默认字段，表示toArray()方法默认会返回这些字段。extraFields()方法定义额外可用字段，通过toArray()方法指定$expand参数来返回这些额外可用字段。 例如如下代码会返回fields()方法定义的所有字段和extraFields()方法定义的prettyName and fullAddress字段。

$array = $model->toArray([], ['prettyName', 'fullAddress']);
可通过覆盖 fields() 来增加、删除、重命名和重定义字段，fields() 方法返回值应为数组， 数组的键为字段名，数组的值为对应的可为属性名或匿名函数返回的字段定义对应的值。 特使情况下，如果字段名和属性定义名相同，可以省略数组键，例如：

// 明确列出每个字段，特别用于你想确保数据表或模型属性改变不会导致你的字段改变(保证后端的API兼容).
public function fields()
{
  return [
    // 字段名和属性名相同
    'id',

    // 字段名为 "email"，对应属性名为 "email_address"
    'email' => 'email_address',

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

// 过滤掉一些字段，特别用于你想继承父类实现并不想用一些敏感字段
public function fields()
{
  $fields = parent::fields();

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

  return $fields;
}

警告：由于模型的所有属性会被包含在导出数组，最好检查数据确保没包含敏感数据， 如果有敏感数据，应覆盖 fields() 方法过滤掉，在上述列子中，我们选择过滤掉 auth_key, password_hash and password_reset_token。
最佳实践

模型是代表业务数据、规则和逻辑的中心地方，通常在很多地方重用， 在一个设计良好的应用中，模型通常比控制器代码多。

归纳起来，模型：

  • 可包含属性来展示业务数据;
  • 可包含验证规则确保数据有效和完整;
  • 可包含方法实现业务逻辑;
  • 不应直接访问请求，session和其他环境数据，这些数据应该由控制器传入到模型;
  • 应避免嵌入HTML或其他展示代码，这些代码最好在 视图中处理;
  • 单个模型中避免太多的场景.

在开发大型复杂系统时应经常考虑最后一条建议， 在这些系统中，模型会很大并在很多地方使用，因此会包含需要规则集和业务逻辑， 最后维护这些模型代码成为一个噩梦，因为一个简单修改会影响好多地方， 为确保模型好维护，最好使用以下策略：

定义可被多个 应用主体 或 模块 共享的模型基类集合。 这些模型类应包含通用的最小规则集合和逻辑。
在每个使用模型的 应用主体 或 模块中， 通过继承对应的模型基类来定义具体的模型类，具体模型类包含应用主体或模块指定的规则和逻辑。
例如，在高级应用模板，你可以定义一个模型基类common\models\Post， 然后在前台应用中，定义并使用一个继承common\models\Post的具体模型类frontend\models\Post， 在后台应用中可以类似地定义backend\models\Post。 通过这种策略，你清楚frontend\models\Post只对应前台应用，如果你修改它，就无需担忧修改会影响后台应用。

您可能感兴趣的文章:

  • 详解PHP的Yii框架中自带的前端资源包的使用
  • 简介PHP的Yii框架中缓存的一些高级用法
  • 深入解析PHP的Yii框架中的缓存功能
  • PHP的Yii框架中View视图的使用进阶
  • PHP的Yii框架中创建视图和渲染视图的方法详解
  • 详解PHP的Yii框架中的Controller控制器
  • PHP的Yii框架中移除组件所绑定的行为的方法
  • PHP的Yii框架中行为的定义与绑定方法讲解
  • 深入讲解PHP的Yii框架中的属性（Property）
  • 详解PHP的Yii框架中扩展的安装与使用

www.bkjia.comtruehttp://www.bkjia.com/PHPjc/1117073.htmlTechArticlePHP的Yii框架中Model模型的学习教程，yiimodel 模型是 MVC 模式中的一部分， 是代表业务数据、规则和逻辑的对象。 模型是 CModel 或其子类的实...
声明：
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
前の記事：YII Framework フィルターの使用状況分析、yiifilter_PHP チュートリアル次の記事：YII Framework フィルターの使用状況分析、yiifilter_PHP チュートリアル

関連記事

続きを見る