Yii でモデルを作成して使用する方法

この記事では、例を通して Yii でのモデルの作成と使用法を分析します。参考のために皆さんと共有してください。詳細は次のとおりです。

YII は、フォーム モデル (CFormModel クラス) とアクティブ レコード モデル (CAtiveRecord クラス) の 2 つのモデルを実装しており、どちらも CModel クラスを継承しています。 CFormModel で表されるデータ モデルは、HTML フォームから収集された入力であり、すべてのロジック (フォーム フィールドに適用されるフォーム検証やその他のビジネス ロジックなど) をカプセル化します。データはメモリに保存することも、アクティブ レコードを利用してデータベースに保存することもできます。

データベース接続操作

config/main.php内

'db'=>array(
  'connectionString' => 'mysql:host=localhost;dbname=oss',
  'emulatePrepare' => true,
  'username' => 'root',
  'password' => 'hahaha',
  'charset' => 'utf8',
  //表前缀
  'tablePrefix'=>"oss_"
),

コメントを開く、phpはpdoをサポートする必要があります

操作ログを表示します

//显示日志信息,包括sql的查询信息
array(
  'class'=>'CWebLogRoute',
),

コメントを開きます

1. CActiveRecordに基づくモデル

Active Record (AR) は、オブジェクト指向のアプローチを使用してデータに抽象的にアクセスする設計パターンです。Yii では、AR オブジェクトの各インスタンスは CActiveRecord クラスまたはそのサブクラスになります。これは、データベース テーブルまたはビュー内のレコードの行をラップし、このモデルを使用して使用する必要があるほとんどのビジネス ロジックを含むデータベースのすべてのロジックと詳細をカプセル化します。データベース テーブルの行の各列フィールドの値は、AR オブジェクトの属性に対応します。テーブルをクラスに、行をオブジェクトに、列をオブジェクトのデータにマップします。つまり、Active Record クラスの各インスタンスは、データベース内のテーブルの行を表します。ただし、Active Record クラスは、データベース テーブル内のフィールドとクラス内の属性間の単なるマッピング関係ではありません。また、このデータに対していくつかのビジネス ロジックを処理し、データベース上のすべての読み取りおよび書き込み操作を定義する必要もあります。

1) CActiveRecord クラスに基づいてモデルを宣言します

class Post extends CActiveRecord
{
public static function model($className=__CLASS__)
{
return parent::model($className);
}
public function tableName()
{
return '{{post}}';
}
public function primaryKey()
{
return 'id';
// return array('pk1', 'pk2');
}
}

2) 親クラスのメソッドを使用してデータベース操作を完了します

(1) 挿入:

$post=new Post;
$post->title='sample post';
$post->content='content for the sample post';
$post->create_time=time();
$post->save();

(2) 選択: よく使用されるいくつかメソッド

// find the first row satisfying the specified condition
$post=Post::model()->find($condition,$params);
// find the row with the specified primary key
$post=Post::model()->findByPk($postID,$condition,$params);
// find the row with the specified attribute values
$post=Post::model()->findByAttributes($attributes,$condition,$params);
// find the first row using the specified SQL statement
$post=Post::model()->findBySql($sql,$params);
$criteria=new CDbCriteria;
$criteria->select='title'; // only select the 'title' column
$criteria->condition='postID=:postID';
$criteria->params=array(':postID'=>10);
$post=Post::model()->find($criteria);
$post=Post::model()->find(array(
'select'=>'title',
'condition'=>'postID=:postID',
'params'=>array(':postID'=>10),
));
// find all rows satisfying the specified condition
$posts=Post::model()->findAll($condition,$params);
// find all rows with the specified primary keys
$posts=Post::model()->findAllByPk($postIDs,$condition,$params);
// find all rows with the specified attribute values
$posts=Post::model()->findAllByAttributes($attributes,$condition,$params);
// find all rows using the specified SQL statement
$posts=Post::model()->findAllBySql($sql,$params);
// get the number of rows satisfying the specified condition
$n=Post::model()->count($condition,$params);
// get the number of rows using the specified SQL statement
$n=Post::model()->countBySql($sql,$params);
// check if there is at least a row satisfying the specified condition
$exists=Post::model()->exists($condition,$params);

(3) Update

// update the rows matching the specified condition
Post::model()->updateAll($attributes,$condition,$params);
// update the rows matching the specified condition and primary key(s)
Post::model()->updateByPk($pk,$attributes,$condition,$params);
// update counter columns in the rows satisfying the specified conditions
Post::model()->updateCounters($counters,$condition,$params);

(4) Delete

$post=Post::model()->findByPk(10); // assuming there is a post whose ID is 10
$post->delete();
// delete the rows matching the specified condition
Post::model()->deleteAll($condition,$params);
// delete the rows matching the specified condition and primary key(s)
Post::model()->deleteByPk($pk,$condition,$params);

(5) トランザクションの使用

$model=Post::model();
$transaction=$model->dbConnection->beginTransaction();
try
{
// find and save are two steps which may be intervened by another request
// we therefore use a transaction to ensure consistency and integrity
$post=$model->findByPk(10);
$post->title='new post title';
$post->save();
$transaction->commit();
}
catch(Exception $e)
{
$transaction->rollBack();
}

2. CFormModelに基づいたモデル

フォームに必要なHTMLを記述する前に、ユーザーがどのようなデータを入力し、どのようなルールに従う必要があるのか​​を決定する必要があります。モデル クラスを使用して、この情報を記録できます。モデルは、ユーザー入力の維持と検証の中核であり、ユーザー入力の使用方法に応じて 2 種類のモデルを作成できます。ユーザーが入力したデータが収集、使用され、その後破棄される場合はフォーム モデルが作成され、ユーザーが入力したデータがデータベースに保存される場合はアクティブ レコードが使用されます。どちらのモデルも、基本クラス CModel で定義されたフォームの共通インターフェイスを継承します。

1) モデルクラスの定義

次の例では、ログインページでユーザー入力を収集する LoginForm モデルを作成します。ログイン情報はユーザー認証にのみ使用され、保存する必要がないため、フォームモデルを使用して

class LoginForm extends CFormModel
{
public $username;
public $password;
public $rememberMe=false;
}

LoginFormを作成し、$username、$password、$rememberMeの合計3つの属性(属性)を宣言します。

はユーザーを記録するために使用されます。ユーザー名、パスワード、ログイン オプションを記憶するかどうかを入力します。 $rememberMe のデフォルト値は false であるため、フォームが表示されるときに対応するチェック ボックスはチェックされません。

ヒント: 通常のプロパティと区別するために、「プロパティ」ではなく「属性」という名前を使用します。

2) 検証ルールを宣言します

ユーザーが送信したデータがモデルに入力されたら、使用する前にそれらが合法であるかどうかをチェックする必要があります。これは、一連のルールを使用して入力を検証することによって実現されます。 rulesers() メソッドで配列を構成することで検証ルールを定義します

class LoginForm extends CFormModel
{
public $username;
public $password;
public $rememberMe=false;
private $_identity;
public function rules()
{
return array(
array('username, password','required'),
array('rememberMe', 'boolean'),
array('password', 'authenticate'),
);
}
public function authenticate($attribute,$params)
{
if(!$this->hasErrors()) // we only want to authenticate when no input errors
{
$this->_identity=new UserIdentity($this->username,$this->password);
if(!$this->_identity->authenticate())
$this->addError('password','Incorrect password.');
}
}
}

上記のコードは、ユーザー名とパスワードが必須であること、パスワードを検証する必要があること、rememberMe が rules() で返されるブール型である必要があることを示しています。ルールは次の形式にする必要があります

array('AttributeList', 'Validator', 'on'=>'ScenarioList', ...追加オプション)

AttributeList は要件のカンマ区切りのリストです プロパティ名のリスト検証します。バリデータは、どのような検証を行う必要があるかを示します。オプションの on パラメーターは、ルールが適用されるシナリオのリスト (追加オプション) を示します。これは、バリデーターの関連属性に最初に対応するために使用されます。まず、上の例の認証など、このクラスのメソッドを使用できます。 Validator メソッドは次の形式で宣言する必要があります

public function ValidatorName($attribute,$params) { ... }

次に、Validator はバリデーターのクラス名にすることができます。ルールが適用される場合、バリデーター クラスのインスタンスが作成され、実際の検証が実行されます。ルール内の追加属性。最初のインスタンスの関連属性に使用されます。バリデーター クラスは CValidator から継承する必要があります

ヒント: アクティブ レコード モデルのルールを指定する場合、特別なパラメーター 'on' を使用できます

このパラメーターは 'insert' または 'update' にすることができます。このルールは、挿入時または更新時にそれぞれ適用されます。ライフがない場合、save() が呼び出されるたびにこのルールが適用されます。

第三、Validator 可以使验证器类预先定义的别名。在上面的例子中，“required”便是CRequiredValidator的别名，用来验证属性不能为空。下面是预定义的验证器类别名的列表

? boolean：CBooleanValidator的别名，验证属性的值是否是CBooleanValidator::trueValue 或者 CBooleanValidator::falseValue
? captcha：CCaptchaValidator的别名，验证属性的值是否和CAPTCHA中显示的验证码的值相等
? compare：CCompareValidator的别名，验证属性的值是否等于另一个属性或者一个常量
? email：CEmailValidator的别名，验证属性的值是否是个合法的email地址
? default：CDefaultValueValidator的别名，为属性指派一个默认值
? exist：CExistValidator的别名，验证属性的值是否能在表的列里面找到
? file: CFileValidator 的别名, 验证属性是否包含上传文件的名字
? filter：CFilterValidator的别名，使用一个过滤器转换属性的形式
? in: CRangeValidator 的别名, 验证属性值是否在一个预订的值列表里面
? length: CStringValidator 的别名, 确保了属性值的长度在指定的范围内.
? match: CRegularExpressionValidator 的别名, 验证属性是否匹配一个正则表达式.
? numerical: CNumberValidator 的别名, 验证属性是否是一个有效的数字.
? required: CRequiredValidator 的别名, 验证属性的值是否为空.
? type: CTypeValidator 的别名, 验证属性是否是指定的数据类型.
? unique: CUniqueValidator 的别名, 验证属性在数据表字段中是否是唯一的.
? url: CUrlValidator 的别名, 验证属性是否是一个有效的URL路径.

下面我们给出一些使用预定义验证器的例子。

// username is required
array('username', 'required'),
// username must be between 3 and 12 characters
array('username', 'length', 'min'=>3, 'max'=>12),
// when in register scenario, password must match password2
array('password', 'compare', 'compareAttribute'=>'password2',
'on'=>'register'),
// when in login scenario, password must be authenticated
array('password', 'authenticate', 'on'=>'login'),

3) 安全属性的设置

当一个模型创建之后，我们往往需要根据用户的输入，为它填充属性。这可以方便的通过下面批量赋值的方式来实现

$model=new LoginForm;
if(isset($_POST['LoginForm']))
$model->attributes=$_POST['LoginForm'];

最后那条语句便是批量赋值，把$_POST['LoginForm']中每个属性都赋值到对应的模型属性中，它等价于下面的语句

foreach($_POST['LoginForm'] as $name=>$value)
{
if($name is a safe attribute)
$model->$name=$value;
}

声明属性是否是安全属性是个至关重要的工作。例如，如果我把把数据表的主键暴露为安全属性，那么便可以通过修改主键的值，来管理本没有权限管理的数据，进行攻击。

4) 1.1版中的安全属性

在1.1版中，如果属性在适用的规则中指定了验证器，则认为是安全的。例如

array('username, password', 'required', 'on'=>'login, register'),
array('email', 'required', 'on'=>'register'),

上面的代码中用户名和密码属性在login的场景下不允许为空。用户名、密码邮箱在register的场景下不允许为空。因此如果在login的场景下 进 行批量赋值，仅仅用户名和密码会被赋值，因为login场景下验证规则里仅出现了这两个属性，但是如果是在register场景下，那么这三个属性都 会被 赋值。

// in login scenario
$model=new User('login');
if(isset($_POST['User']))
$model->attributes=$_POST['User'];
// in register scenario
$model=new User('register');
if(isset($_POST['User']))
$model->attributes=$_POST['User'];

那么为什么我们使用如此的策略来决定一个属性是否是安全属性呢？因为一个属性，已经有了一个或者多个对个进行校验的规则，那么我还需要担心吗？

需要记住的是，验证器是用来检测用户输入的数据，而不是我们用代码产生的数据（例如 时间戳，自增的主键等）。因此不要给那些不需要用户输入的属性添加验证器。

有时候我们想声明一些属性为安全属性，但是又不必给指定一个验证规则。例如文章的正文属性，我们可以允许用户的任何输入。为了实现这个目标，我们可以用safe规则。

array('content', 'safe')

对应的也有一个unsafe规则，来指定哪些属性是不安全的

array('permission', 'unsafe')

unsafe并不常用，对你以前定义的安全属性来说，这是个例外
5) 获取验证错误
当验证结束后，任何可能的错误都存储在模型的实例中。我们可以通过调用CModel::getErrors() 和 CModel::getError()重新获取到。这两个方法的区别在于，第一个可以返回指定模型属性的所有错误，而第二个方法只返回了第一条错误。

6) 属性标签

设计表单的时候，我们需要为用户的输入框显示一个标签，来提示用户输入。尽管我们可以再form中写死，但是如果我们在相应的模型中指定的话会更加方便和灵活

默认情况下，CModel 会简单的返回属性的名字作为标签。这可以通过重写attributeLabels() 方法来自定义。在接下来章节中我们将看到,在模型中指定标签可以让我们更快更强大的创建一个form表单

希望本文所述对大家基于yii框架的php程序设计有所帮助。

更多Yii中Model(模型)的创建及使用方法相关文章请关注PHP中文网！