Yii Framework Official Guide Series 17 - Utilisation de formulaires : création de modèles

Avant d'écrire le code HTML requis pour le formulaire, nous devons d'abord déterminer le type de données provenant de l'entrée de l'utilisateur final et quelles données doivent se conformer à ces règles. Les classes modèles peuvent être utilisées pour enregistrer ces informations. Comme défini dans le chapitre Modèles, un modèle est l'emplacement central pour stocker les entrées utilisateur et valider ces entrées.

En fonction de la manière dont les données saisies par l'utilisateur sont utilisées, nous pouvons créer deux types de modèles. Si les entrées de l'utilisateur sont collectées, utilisées puis supprimées, nous devons créer un modèle de formulaire ; si les entrées de l'utilisateur sont collectées puis enregistrées dans une base de données, nous devons utiliser un enregistrement actif. Les deux types de modèles partagent la même classe de base CModel , qui définit l'interface commune requise par le formulaire.

Remarque : Nous utilisons principalement le modèle de formulaire dans les exemples de cette section. Cependant, la même opération peut également être appliquée aux modèles Active Record.

1. Définissez la classe de modèle

Ci-dessous, nous créons une classe de modèle LoginForm pour collecter les entrées de l'utilisateur dans une page de connexion. Étant donné que les informations de connexion ne sont utilisées que pour authentifier l'utilisateur et n'ont pas besoin d'être enregistrées, nous créerons LoginForm comme modèle de formulaire.

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

LoginForm définit trois attributs : $username, $password et $rememberMe. Ils sont utilisés pour enregistrer le nom d'utilisateur et le mot de passe saisis par l'utilisateur, ainsi que la possibilité de savoir si l'utilisateur souhaite mémoriser son identifiant. Puisque $rememberMe a une valeur par défaut de false, l'option correspondante sera décochée lors de son affichage initial dans le formulaire de connexion.

Information : Nous appelons ces variables membres attributs au lieu de propriétés pour les distinguer des propriétés ordinaires . Un attribut est une propriété principalement utilisée pour stocker des données provenant d'une entrée utilisateur ou d'une base de données.

2. Déclarer les règles de validation

Une fois que l'utilisateur soumet sa saisie et que le modèle est rempli, nous devons nous assurer que la saisie de l'utilisateur est valide avant utilisation. Ceci est réalisé en validant la saisie de l'utilisateur par rapport à une série de règles. Nous spécifions ces règles de validation dans la méthode rules(), qui doit renvoyer un tableau de configurations de règles.

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','错误的用户名或密码。');
    }
}

Le code ci-dessus précise : username et password sont obligatoires, password doit être être authentifié, rememberMe doit être un booléen.

rules() Chaque règle renvoyée doit être au format suivant :

array('AttributeList', 'Validator', 'on'=>'ScenarioList', ...附加选项)

où AttributeList（特性列表） est une chaîne de liste de fonctionnalités qui doivent être vérifiées par cette règle. Chaque nom de fonctionnalité est séparé par des virgules ; Validator（验证器） précise le type de vérification à effectuer ; le paramètre on est facultatif et précise que cette règle ; doit être appliqué à Une liste de scénarios ; les options supplémentaires sont un tableau de paires nom-valeur utilisées pour initialiser les valeurs de propriété du validateur correspondant.

Il existe trois façons de spécifier Validator dans les règles de validation.

Premièrement, Validator peut être le nom d'une méthode dans la classe modèle , tout comme authenticate dans l'exemple ci-dessus. La méthode de vérification doit être de la structure suivante :

/**
 * @param string 所要验证的特性的名字
 * @param array 验证规则中指定的选项
 */
public function ValidatorName($attribute,$params) { ... }

Deuxièmement, Validator peut être a Le nom de la classe validateur Lorsque cette règle est appliquée, une instance de la classe validateur sera créée pour effectuer la validation proprement dite. Des options supplémentaires dans les règles sont utilisées pour initialiser les valeurs des propriétés de l'instance. Les classes Validator doivent hériter de CValidator.

Troisièmement, Validator peut être un alias d'une classe de validateur prédéfinie . Dans l'exemple ci-dessus, le nom required est un alias pour CRequiredValidator, qui est utilisé pour garantir que la valeur de la propriété en cours de validation n'est pas vide. Voici la liste complète des alias de validateur prédéfinis :

• boolean : Alias ​​​​pour CBooleanValidator , en vous assurant que l'attribut a une valeur CBooleanValidator::trueValue ou CBooleanValidator::falseValue.

• captcha : Alias ​​​​pour CCaptchaValidator, garantissant que la valeur de l'attribut est égale au code de vérification affiché dans le CAPTCHA.

• compare : Alias ​​​​pour CCompareValidator, garantissant qu'une propriété est égale à une autre propriété ou constante.

• email : Alias ​​​​pour CEmailValidator, garantissant que l'attribut est une adresse e-mail valide.

• default : Alias ​​de CDefaultValueValidator, précisant la valeur par défaut de l'attribut.

• exist: CExistValidator 的别名，确保特性值可以在指定表的列中可以找到。

• file: CFileValidator 的别名，确保特性含有一个上传文件的名字。

• filter: CFilterValidator 的别名，通过一个过滤器改变此特性。

• in: CRangeValidator 的别名，确保数据在一个预先指定的值的范围之内。

• length: CStringValidator 的别名，确保数据的长度在一个指定的范围之内。

• match: CRegularExpressionValidator 的别名，确保数据可以匹配一个正则表达式。

• numerical: CNumberValidator 的别名，确保数据是一个有效的数字。

• required: CRequiredValidator 的别名，确保特性不为空。

• type: CTypeValidator 的别名，确保特性是指定的数据类型。

• unique: CUniqueValidator 的别名，确保数据在数据表的列中是唯一的。

• url: CUrlValidator 的别名，确保数据是一个有效的 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. 安全的特性赋值

在一个类的实例被创建后，我们通常需要用最终用户提交的数据填充它的特性。 这可以通过如下块赋值（massive assignment）方式轻松实现：

$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 中，特性如果出现在相应场景的一个验证规则中，即被认为是安全的。 例如：

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

如上所示， username 和 password 特性在 login 场景中是必填项。而 username, password 和 email 特性在register 场景中是必填项。 于是，如果我们在 login 场景中执行块赋值，就只有 username 和 password 会被块赋值。 因为只有它们出现在 login 的验证规则中。 另一方面，如果场景是 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'];

那么为什么我们使用这样一种策略来检测特性是否安全呢？ 背后的基本原理就是：如果一个特性已经有了一个或多个可检测有效性的验证规则，那我们还担心什么呢？

请记住，验证规则是用于检查用户输入的数据，而不是检查我们在代码中生成的数据（例如时间戳，自动产生的主键）。 因此，不要 为那些不接受最终用户输入的特性添加验证规则。

有时候，我们想声明一个特性是安全的，即使我们没有为它指定任何规则。 例如，一篇文章的内容可以接受用户的任何输入。我们可以使用特殊的 safe 规则实现此目的：

array('content', 'safe')

为了完成起见，还有一个用于声明一个属性为不安全的 unsafe 规则：

array('permission', 'unsafe')

unsafe 规则并不常用，它是我们之前定义的安全特性的一个例外。

1.0 中的安全特性

在版本1.0中,决定一个数据项是否是安全的,基于一个名为 safeAttributes 方法的返回值和数据项被指定的场景. 默认的,这个方法返回所有公共成员变量作为 CFormModel 的安全特性,而它也返回了除了主键外, 表中所有字段名作为 CActiveRecord的安全特性.我们可以根据场景重写这个方法来限制安全特性 .例如, 一个用户模型可以包含很多特性,但是在 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, ...'

而那些不安全的数据项,我们需要使用独立的赋值语句来分配它们到相应的特性.如下所示:

$model->permission='admin';
$model->id=1;

4. 触发验证

一旦模型被用户提交的数据填充，我们就可以调用 CModel::validate() 出发数据验证进程。此方法返回一个指示验证是否成功的值。 对 CActiveRecord 模型来说，验证也可以在我们调用其 CActiveRecord::save() 方法时自动触发。

我们可以使用 scenario 设置场景属性，这样，相应场景的验证规则就会被应用。

验证是基于场景执行的。 scenario 属性指定了模型当前用于的场景和当前使用的验证规则集。 例如，在 login场景中，我们只想验证用户模型中的 username 和 password 输入； 而在 register 场景中，我们需要验证更多的输入，例如 email, address, 等。 下面的例子演示了如何在 register 场景中执行验证：

// 在注册场景中创建一个  User 模型。等价于：
// $model=new User;
// $model->scenario='register';
$model=new User('register');

// 将输入的值填充到模型
$model->attributes=$_POST['User'];

// 执行验证
if($model->validate())   // if the inputs are valid
    ...
else
    ...

规则关联的场景可以通过规则中的 on 选项指定。如果 on 选项未设置，则此规则会应用于所有场景。例如：

public function rules()
{
    return array(
        array('username, password', 'required'),
        array('password_repeat', 'required', 'on'=>'register'),
        array('password', 'compare', 'on'=>'register'),
    );
}

第一个规则将应用于所有场景，而第二个将只会应用于 register 场景。

5. 提取验证错误

验证完成后，任何可能产生的错误将被存储在模型对象中。 我们可以通过调用 CModel::getErrors() 和CModel::getError() 提取这些错误信息。 这两个方法的不同点在于第一个方法将返回 所有 模型特性的错误信息，而第二个将只返回 第一个 错误信息。

6. 特性标签

当设计表单时，我们通常需要为每个表单域显示一个标签。 标签告诉用户他应该在此表单域中填写什么样的信息。虽然我们可以在视图中硬编码一个标签， 但如果我们在相应的模型中指定（标签），则会更加灵活方便。

默认情况下 CModel 将简单的返回特性的名字作为其标签。这可以通过覆盖 attributeLabels() 方法自定义。 正如在接下来的小节中我们将看到的，在模型中指定标签会使我们能够更快的创建出更强大的表单。

以上就是Yii框架官方指南系列17——使用表单：创建模型的内容，更多相关内容请关注PHP中文网（www.php.cn）！