Through the previous study, we have understood the basic components of Yii Web applications, and can also write simple applications like the Hangman word guessing game. In the first example Yii Framework development concise tutorial (1) the first application Hello World we introduced the MVC model adopted by Yii Web application, and also explained that the purpose of this tutorial is through different perspectives (mainly through the development of Windows applications C++, C# Programmer's perspective) helps Windows desktop application or ASP.Net programmers quickly master the PHP Yii Framework application framework.

Earlier we introduced creating View (page view Form) through CHtml and handling user submission events through CController. By analogy with Windows desktop applications or ASP.Net, Yii mid-view View (HTML Form) is similar to WinForm or Asp.Net Page. Control class Controller is similar to the event processing (Code-Behind) class of Windows desktop applications or Asp.Net. The difference is that Asp.Net and Windows desktop applications can define IDs for each UI component in the UI, such as text boxes and buttons, and then add event processing for different UI components. There is no corresponding mechanism for PHP applications or Yii applications to define an Id for UI components defined in HTML Form and define event handling for UI components. However, the Yii framework provides CFormModel to support similar functions. Simply put, through CFormModel, variables can be defined for UI widgets in HTML Form, and these variables can be accessed in its control class Controller. Each Yii View (Form) generally provides a "Submit Button". The user clicks this "Submit Button" to trigger the actionXXX method corresponding to the CController object. In the actionXXX method, the UI components of the HTML Form can be accessed through CFormModel. value.

As mentioned in the previous tutorial, the model in Yii is an instance of CModel or its subclass. Models are used to maintain data and related business logic.

Yii implements two types of models: form models and Active Record. Both inherit from the same base class CModel.

The form model is an instance of CFormModel. The form model is used to hold data obtained from the user's input. This data is often acquired, used, and then discarded. For example, in a login page, we can use the form model to represent the username and password information provided by the end user. For more details, please refer to the usage form. This article introduces the usage of CFormModel.

Active Record (AR) is a design pattern used to abstract database access through an object-oriented style. Each AR object is an instance of CActiveRecord or one of its subclasses. Represents a row in the data table. The fields in the row correspond to properties in the AR object. For more details about AR, please read Active Record. We will introduce it later when we introduce the use of databases.

This article uses a simple login interface to introduce the usage of FormModel. Download this example.

1. Define the model class

Below we create a LoginForm (protected/models/LoginForm.php) model class for collecting user input in a login page. Since the login information is only used to authenticate the user and does not need to be saved, we create LoginForm as a form model.

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

2. Declare validation rules
Once the user submits his input and the model is populated, we need to ensure that the user's input is valid before use. This is achieved by validating the user's input against a series of rules. We specify these validation rules in the rules() method, which should return an array of rule configurations.

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)    
    {    
        $this->_identity=new UserIdentity($this->username,    
              $this->password);    
        if(!$this->_identity->authenticate())    
            $this->addError('password','錯誤的用戶名或密碼。');    
    }    
}

The above code specifies: username and password are required, password should be authenticated, and rememberMe should be a Boolean value.

rules() Each rule returned must be in the following format:

array('AttributeList', 'Validator',
'on'=>'ScenarioList', ...附加選項)

where AttributeList (attribute list) is the attribute list string that needs to be verified by this rule, Each attribute name is separated by commas; Validator (validator) specifies the type of validation to be performed; the on parameter is optional and specifies the list of scenarios to which this rule should be applied; additional options are an array of name-value pairs for Initializes the property values ??of the corresponding validator.

There are three ways to specify Validator in validation rules. First, Validator can be the name of a method in the model class, like authenticate in the example above. The verification method must be of the following structure:

/**   
 * @param string 所要驗證的特性的名字   
 * @param array 驗證規(guī)則中指定的選項   
 */
public function ValidatorName($attribute,$params) { ... }

第二，Validator 可以是一個驗證器類的名字，當此規(guī)則被應用時， 一個驗證器類的實例將被創(chuàng)建以執(zhí)行實際驗證。規(guī)則中的附加選項用于初始化實例的屬性值。 驗證器類必須繼 承自 CValidator。

第三，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 的別名，確保數(shù)據(jù)在一個預先指定的值的范圍之內。

length: CStringValidator 的別名，確保數(shù)據(jù)的長度在一個指定的范圍之內。

match: CRegularExpressionValidator 的別名，確保 數(shù)據(jù)可以匹配一個正則表達式。

numerical: CNumberValidator 的別名，確保數(shù)據(jù)是一個有效的數(shù)字。

required: CRequiredValidator 的別名，確保特性不為空。

type: CTypeValidator 的別名，確保特性是指定的數(shù)據(jù)類型。

unique: CUniqueValidator 的別名，確保數(shù)據(jù)在數(shù)據(jù)表的列中是唯一的。

url: CUrlValidator 的別名，確保數(shù)據(jù)是一個有效的 URL 。

下面我們列出了幾個只用這些預定義驗證器的示例：

// 用戶名為必填項    
array('username', 'required'),    
// 用戶名必須在 3 到 12 個字符之間    
array('username', 'length', 'min'=>3, 'max'=>12),    
// 在注冊場景中，密碼password必須和password2一致。    
array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'),    
// 在登錄場景中，密碼必須接受驗證。    
array('password', 'authenticate', 'on'=>'login'),

3. 安全的特性賦值

在一個類的實例被創(chuàng)建后，我 們通常需要用最終用戶提交的數(shù)據(jù)填充它的特性。 這可以通過如下塊賦值（massive assignment）方式輕松實現(xiàn)：

$model=new LoginForm;
if(isset($_POST['LoginForm']))
$model->attributes=$_POST['LoginForm'];最后的表達式被稱作 塊賦值（massive assignment） ，它將 $_POST['LoginForm'] 中的每一項復制到相應的模型特性中。這相當于如下賦值方法：

foreach($_POST
['LoginForm'] as $name=>$value)    
{    
    if($name 是一個安全的特性)    
        $model->$name=$value;    
}

檢測特性的安全非常重要，例如，如果我們以為一個表的主鍵是安全的而暴露了它，那么攻擊者可能就獲得了一個修 改記錄的主鍵的機會， 從而篡改未授權給他的內容。

檢測特性安全的策略在版本 1.0 和 1.1 中是不同的，下面我們將 分別講解：

1.1 中的安全特性

在版本 1.1 中，特性如果出現(xiàn)在相應場景的一個驗證規(guī)則中，即被認為是安全的 。 例如：

array('username, password', 'required', 'on'=>'login, register'),
array('email', 'required', 'on'=>'register'),如上所示， username 和 password 特性在 login 場景中是必 填項。而 username, password 和 email 特性在register 場景中是必填項。 于是，如果我們在 login 場景中執(zhí)行塊賦值，就 只有 username 和 password 會被塊賦值。 因為只有它們出現(xiàn)在 login 的驗證規(guī)則中。 另一方面，如果場景是 register ， 這三個特性就都可以被塊賦值。

// 在登錄場景中    
$model=new User('login');    
if(isset($_POST['User']))    
    $model->attributes=$_POST['User'];    
        
// 在注冊場景中    
$model=new User('register');    
if(isset($_POST['User']))    
    $model->attributes=$_POST['User'];

那么為什么我們使用這樣一種策略來檢測特性是否安全呢？ 背后的基 本原理就是：如果一個特性已經(jīng)有了一個或多個可檢測有效性的驗證規(guī)則，那我們還擔心什么呢？

請記住，驗證規(guī)則是 用于檢查用戶輸入的數(shù)據(jù)，而不是檢查我們在代碼中生成的數(shù)據(jù)（例如時間戳，自動產生的主鍵）。 因此，不要 為那些不接受 最終用戶輸入的特性添加驗證規(guī)則。

有時候，我們想聲明一個特性是安全的，即使我們沒有為它指定任何規(guī)則。 例如， 一篇文章的內容可以接受用戶的任何輸入。我們可以使用特殊的 safe 規(guī)則實現(xiàn)此目的：

array('content', 'safe')

為了完成起見，還有一個用于聲明一個屬性為不安全的 unsafe 規(guī)則：

array ('permission', 'unsafe')

unsafe 規(guī)則并不常用，它是我們之前定義的安全特性的一個例外 。

1.0 中的安全特性

在版本1.0中,決定一個數(shù)據(jù)項是否是安全的,基于一個名為 safeAttributes 方法的返回值 和數(shù)據(jù)項被指定的場景. 默認的,這個方法返回所有公共成員變量作為 CFormModel 的安全特性,而它也返回了除了主鍵外, 表中 所有字段名作為 CActiveRecord的安全特性.我們可以根據(jù)場景重寫這個方法來限制安全特性 .例如, 一個用戶模型可以包含很 多特性,但是在 login 場景.里,我們只能使用 username 和 password 特性.我們可以按照如下來指定這一限制 :

public function safeAttributes()    
{    
    return array(    
        parent::safeAttributes(),    
        'login' => 'username, password',    
    );    
}safeAttributes 方法更準確的返回值應該是如下結構的 :
array(    
   // these attributes can be massively assigned in any scenario    
   // that is not explicitly specified below    
   'attr1, attr2, ...',    
     *    
   // these attributes can be massively assigned only in scenario 1    
   'scenario1' => 'attr2, attr3, ...',    
     *    
   // these attributes can be massively assigned only in scenario 2    
   'scenario2' => 'attr1, attr3, ...',    
)

如果模型不是場景敏感的(比如,它只在一個場景中使用,或者所有場景共享了一套同樣的安全特性),返 回值可以是如 下那樣簡單的字符串.

'attr1, attr2, ...'

而那些不安全的數(shù)據(jù)項,我們需要使用獨立的賦值語句來分 配它們到相應的特性.如下所示:

$model->permission='admin';    
$model->id=1;4. 觸發(fā)驗證

一旦模型被用戶提交的數(shù)據(jù)填充，我們就可以調用 CModel::validate() 出發(fā) 數(shù)據(jù)驗證進程。此方法返回一個指示驗證是否成功的值。 對 CActiveRecord 模型來說，驗證也可以在我們調用其 CActiveRecord::save() 方法時自動觸發(fā)。

我們可以使用 scenario 設置場景屬性，這樣，相應場景的驗證規(guī)則就會被 應用。

驗證是基于場景執(zhí)行的。 scenario 屬性指定了模型當前用于的場景和當前使用的驗證規(guī)則集。 例如，在 login 場景中，我們只想驗證用戶模型中的 username 和 password 輸入； 而在 register 場景中，我們需要驗證更多的輸入，例如 email, address, 等。 下面的例子演示了如何在 register 場景中執(zhí)行驗證：

// 在注冊場景中創(chuàng)建一個  User 模型
。等價于：    
// $model=new User;    
// $model->scenario='register';    
$model=new User('register');    
        
// 將輸入的值填充到模型    
$model->attributes=$_POST['User'];    
        
// 執(zhí)行驗證    
if($model->validate())   // if the inputs are valid    
    ...    
else
    ...規(guī)則關聯(lián)的場景可以通過規(guī)則中的 on 選項指定。如果 on 選項未設置，則此規(guī)則會應用于所有場景。例如：
public function rules()    
{    
    return array(    
        array('username, password', 'required'),    
        array('password_repeat', 'required', 'on'=>'register'),    
        array('password', 'compare', 'on'=>'register'),    
    );    
}

第一個規(guī)則將應用于所有場景，而第二個將只會應用于 register 場景。

5. 提取驗證錯誤

驗證完成 后，任何可能產生的錯誤將被存儲在模型對象中。 我們可以通過調用 CModel::getErrors()和CModel::getError() 提取這些錯 誤信息。 這兩個方法的不同點在于第一個方法將返回 所有 模型特性的錯誤信息，而第二個將只返回 第一個 錯誤信息。

6. 特性標簽

當設計表單時，我們通常需要為每個表單域顯示一個標簽。 標簽告訴用戶他應該在此表單域中填寫 什么樣的信息。雖然我們可以在視圖中硬編碼一個標簽， 但如果我們在相應的模型中指定（標簽），則會更加靈活方便。

默認情況下 CModel 將簡單的返回特性的名字作為其標簽。這可以通過覆蓋 attributeLabels() 方法自定義。 正如在 接下來的小節(jié)中我們將看到的，在模型中指定標簽會使我們能夠更快的創(chuàng)建出更強大的表單。

7. 創(chuàng)建動作Action方法

創(chuàng)建好LoginForm 表單Model后，我們就可以為它編寫用戶提交后的處理代碼(對應到Controller中的某個Action方法） 。本例使用缺省的SiteController，對應的action為actionLogin.

public function actionLogin()    
{    
    $model=new LoginForm;    
    // collect user input data    
    if(isset($_POST['LoginForm']))    
    {    
        $model->attributes=$_POST['LoginForm'];    
        // validate user input and redirect to the previous page if valid    
        if($model->validate() && $model->login()){    
        
            $this->render('index');    
            return;    
        }    
    }    
    // display the login form    
    $this->render('login',array('model'=>$model));    
}

如上所示，我們首先創(chuàng)建了一個 LoginForm 模型示例； 如果請求是一個 POST 請求（意味著這個登錄表單被提交了 ），我們則使用提交的數(shù)據(jù) $_POST['LoginForm'] 填充 $model ；然后我們驗證此輸入，如果驗證成功，則顯示index 頁面。 如果驗證失敗，或者此動作被初次訪問，我們則渲染 login 視圖。
注意的我們修改了SiteController 的缺省 action為login.

/**   
 * @var string sets the default action to be 'login'   
 */
public $defaultAction='login';

因此用戶見到的第一個頁面為login頁面而非index頁面，只有在用戶輸入正確的用 戶名，本例使用固定的用戶名和密碼，參見UserIdentity類定義，實際應用可以讀取數(shù)據(jù)庫或是LDAP服務器。

/**   
 * UserIdentity represents the data needed to identity a user.   
 * It contains the authentication method that checks if the provided   
 * data can identity the user.   
 */
class UserIdentity extends CUserIdentity    
{    
    /**   
     * Authenticates a user.   
     * The example implementation makes sure if the username and password   
     * are both 'demo'.   
     * In practical applications, this should be changed to authenticate   
     * against some persistent user identity storage (e.g. database).   
     * @return boolean whether authentication succeeds.   
     */
    public function authenticate()    
    {    
        $users=array(    
            // username => password    
            'demo'=>'demo',    
            'admin'=>'admin',    
        );    
        if(!isset($users[$this->username]))    
            $this->errorCode=self::ERROR_USERNAME_INVALID;    
        else if($users[$this->username]!==$this->password)    
            $this->errorCode=self::ERROR_PASSWORD_INVALID;    
        else
            $this->errorCode=self::ERROR_NONE;    
        return !$this->errorCode;    
    }    
}

讓我們特別留意一下 login 動作中出現(xiàn)的下面的 PHP 語句：

$model->attributes=$_POST ['LoginForm'];

正如我們在 安全的特性賦值 中所講的， 這行代碼使用用戶提交的數(shù)據(jù)填充模型。 attributes 屬性由 CModel定義，它接受一個名值對數(shù)組并將其中的每個值賦給相應的模型特性。 因此如果 $_POST ['LoginForm'] 給了我們這樣的一個數(shù)組，上面的那段代碼也就等同于下面冗長的這段 (假設數(shù)組中存在所有所需的特 性):

$model->username=$_POST['LoginForm']['username'];
$model->password=$_POST ['LoginForm']['password'];
$model->rememberMe=$_POST['LoginForm'] ['rememberMe'];

8. 構建視圖

編寫 login 視圖是很簡單的，我們以一個 form 標記開始，它的 action 屬性應該是前面講述的 login 動作的URL。 然后我們需要為 LoginForm 類中聲明的屬性插入標簽和表單域。最后， 我們插入 一個可由用戶點擊提交此表單的提交按鈕。所有這些都可以用純HTML代碼完成。

Yii 提供了幾個助手（helper）類簡化 視圖編寫。例如， 要創(chuàng)建一個文本輸入域，我們可以調用 CHtml::textField()； 要創(chuàng)建一個下拉列表，則調用 CHtml::dropDownList()。

信息: 你可能想知道使用助手的好處，如果它們所需的代碼量和直接寫純HTML的代碼量相當?shù)?話。 答案就是助手可以提供比 HTML 代碼更多的功能。例如， 如下代碼將生成一個文本輸入域，它可以在用戶修改了其值時觸 發(fā)表單提交動作。

CHtml::textField($name,$value,array('submit'=>''));

不然的話你就 需要寫一大堆 JavaScript 。

下面，我們使用 CHtml 創(chuàng)建一個登錄表單。我們假設變量 $model 是 LoginForm 的實例 。

<center class="form">    
<?php echo CHtml::beginForm(); ?>    
    <?php echo CHtml::errorSummary($model); ?>
    <center class="row">
        <?php echo CHtml::activeLabel($model,&#39;username&#39;); ?>    
        <?php echo CHtml::activeTextField($model,&#39;username&#39;) ?>    
    </center>
    <center class="row">    
        <?php echo CHtml::activeLabel($model,&#39;password&#39;); ?>    
        <?php echo CHtml::activePasswordField($model,&#39;password&#39;) ?>    
    </center>
    <center class="row rememberMe">    
        <?php echo CHtml::activeCheckBox($model,&#39;rememberMe&#39;); ?>    
        <?php echo CHtml::activeLabel($model,&#39;rememberMe&#39;); ?>    
    </center>
    <center class="row submit">    
        <?php echo CHtml::submitButton(&#39;Login&#39;); ?>    
    </center>
<?php echo CHtml::endForm(); ?>    
</center><!-- form -->

上述代碼生成了一個更加動態(tài)的表單，例如， CHtml::activeLabel() 生成一個與 指定模型的特性相關的標簽。 如果此特性有一個輸入錯誤，此標簽的CSS class 將變?yōu)?error，通過 CSS 樣式改變了標簽的外 觀。 相似的，CHtml::activeTextField() 為指定模型的特性生成一個文本輸入域，并會在錯誤發(fā)生時改變它的 CSS class。

如果我們使用由 yiic 腳本生提供的 CSS 樣式文件，生成的表單就會像下面這樣：

CSS 樣式定義在css目錄下，本例使用的為Yii缺省的樣式。

從版本 1.1.1 開始，提供了一個新的小物件 CActiveForm 以簡化表單創(chuàng)建。 這個小物件可同時提供客戶端及服務器端無縫的、一致的驗證。使用 CActiveForm, 上面的代 碼可重寫為：

<center class="form">    
<?php $form=$this->beginWidget(&#39;CActiveForm&#39;); ?>    
         
    <?php echo $form->errorSummary($model); ?>    
         
    <center class="row">    
        <?php echo $form->label($model,&#39;username&#39;); ?>    
        <?php echo $form->textField($model,&#39;username&#39;) ?>    
    </center>    
         
    <center class="row">    
        <?php echo $form->label($model,&#39;password&#39;); ?>    
        <?php echo $form->passwordField($model,&#39;password&#39;) ?>    
    </center>    
         
    <center class="row rememberMe">    
        <?php echo $form->checkBox($model,&#39;rememberMe&#39;); ?>    
        <?php echo $form->label($model,&#39;rememberMe&#39;); ?>    
    </center>    
         
    <center class="row submit">    
        <?php echo CHtml::submitButton(&#39;Login&#39;); ?>    
    </center>    
         
<?php $this->endWidget(); ?>    
</center><!-- form -->

從下篇開始將逐個介紹Yii框架支持的UI組件包括CActiveForm的用法。

以上就是PHP開發(fā)框架Yii Framework教程(8) 使用FormModel的內容，更多相關內容請關注PHP中文網(wǎng)（ipnx.cn）！