表单（Forms）

表单（Forms）

Phalcon中提供了 Phalcon\Forms 组件以方便开发者创建和维护应用中的表单。

下面的例子中展示了基本的使用方法：

<?php
 
use Phalcon\Forms\Form;
use Phalcon\Forms\Element\Text;
use Phalcon\Forms\Element\Select;
 
$form = new Form();
 
$form->add(new Text("name"));
 
$form->add(new Text("telephone"));
 
$form->add(
    new Select(
        "telephoneType",
        array(
            'H' => 'Home',
            'C' => 'Cell'
        )
    )
);

可在表单定义时穿插使用表单元素的字义：

<h1>Contacts</h1>
 
<form method="post">
 
    <p>
        <label>Name</label>
        <?php echo $form->render("name"); ?>
    </p>
 
    <p>
        <label>Telephone</label>
        <?php echo $form->render("telephone"); ?>
    </p>
 
    <p>
        <label>Type</label>
        <?php echo $form->render("telephoneType"); ?>
    </p>
 
    <p>
        <input type="submit" value="Save" />
    </p>
 
</form>

开发者可根据需要渲染HTML组件。当使用render()函数时， phalcon内部会使用 Phalcon\Tag 生成相应的html项，第二个参数中可以对一些属性进行设置。

<p>
    <label>Name</label>
    <?php echo $form->render("name", array('maxlength' => 30, 'placeholder' => 'Type your name')); ?>
</p>

HTML的属性也可以在创建时指定：

<?php
 
$form->add(
    new Text(
        "name",
        array(
            'maxlength'   => 30,
            'placeholder' => 'Type your name'
        )
    )
);

表单元素（Forms Elements）

所有 Phalcon\Tag 支持的 HTML 元素，都可以作为表单元素来使用。例如，Phalcon 内置不存在 PhalconFormsElementTel 元素类，但 Phalcon\Tag 中存在 tel 方法，我们仍然可以用下面的方式创建表单元素：

<?php
 
$element = new Phalcon\Forms\Element('mytel', NULL, NULL, NULL, 'tel');

构造函数的第一个参数是元素名称（name），第二个参数是元素属性，第三个参数是用户选项值（自定义数据），第四个参数是选项值（比如下拉列表的值）。

渲染表单元素

<?php
 
echo $element->render();

初始化表单（Initializing forms）

从上面的例子我们可以看到表单项也可以在form对象初始化后进行添加。当然开发者也可以对原有的Form类进行扩展：

<?php
 
use Phalcon\Forms\Form;
use Phalcon\Forms\Element\Text;
use Phalcon\Forms\Element\Select;
 
class ContactForm extends Form
{
    public function initialize()
    {
        $this->add(new Text("name"));
 
        $this->add(new Text("telephone"));
 
        $this->add(
            new Select(
                "telephoneType",
                TelephoneTypes::find(),
                array(
                    'using' => array(
                        'id',
                        'name'
                    )
                )
            )
        );
    }
}

由于 Phalcon\Forms\Form 实现了 Phalcon\Di\Injectable 接口，所以开发者可以根据自己的需要访问应用中的服务。

<?php
 
use Phalcon\Forms\Form;
use Phalcon\Forms\Element\Text;
use Phalcon\Forms\Element\Hidden;
 
class ContactForm extends Form
{
    /**
     * This method returns the default value for field 'csrf'
     */
    public function getCsrf()
    {
        return $this->security->getToken();
    }
 
    public function initialize()
    {
        // Set the same form as entity
        $this->setEntity($this);
 
        // Add a text element to capture the 'email'
        $this->add(new Text("email"));
 
        // Add a text element to put a hidden CSRF
        $this->add(new Hidden("csrf"));
    }
}

相关的实体在初始化时添加到表单，自定义的选项通过构造器传送：

<?php
 
use Phalcon\Forms\Form;
use Phalcon\Forms\Element\Text;
use Phalcon\Forms\Element\Hidden;
 
class UsersForm extends Form
{
    /**
     * Forms initializer
     *
     * @param Users $user
     * @param array $options
     */
    public function initialize(Users $user, $options)
    {
        if ($options['edit']) {
            $this->add(new Hidden('id'));
        } else {
            $this->add(new Text('id'));
        }
 
        $this->add(new Text('name'));
    }
}

在表单实例中必须要这样使用：

<?php
 
$form = new UsersForm(
    new Users(),
    array(
        'edit' => true
    )
);

验证（Validation）

Phalcon表单组件可以和 validation 集成，以提供验证。开发者要单独为每个html元素提供内置或自定义的验证器。

<?php
 
use Phalcon\Forms\Element\Text;
use Phalcon\Validation\Validator\PresenceOf;
use Phalcon\Validation\Validator\StringLength;
 
$name = new Text("name");
 
$name->addValidator(
    new PresenceOf(
        array(
            'message' => 'The name is required'
        )
    )
);
 
$name->addValidator(
    new StringLength(
        array(
            'min'            => 10,
            'messageMinimum' => 'The name is too short'
        )
    )
);
 
$form->add($name);

然后，开发者可以根据用户的输入进行验证：

<?php
 
if (!$form->isValid($_POST)) {
    foreach ($form->getMessages() as $message) {
        echo $message, '<br>';
    }
}

验证器执行的顺序和注册的顺序一致。

默认情况下，所有的元素产生的消息是放在一起的，所以开发者可以使用简单的foreach来遍历消息，开发者可以按照自己的意愿组织输出：

<?php
 
foreach ($form->getMessages(false) as $attribute => $messages) {
    echo 'Messages generated by ', $attribute, ':', "\n";
 
    foreach ($messages as $message) {
        echo $message, '<br>';
    }
}

或获取指定元素的消息：

<?php
 
foreach ($form->getMessagesFor('name') as $message) {
    echo $message, '<br>';
}

过滤（Filtering）

表单元素可以在进行验证前先进行过滤，开发者可以为每个元素设置过滤器：

设置用户选项（Setting User Options）

表单与实体（Forms + Entities）

我们可以把 model/collection/plain 设置到表单对象中，这样 phalcon 会自动的设置表单元素的值：

<?php
 
$robot = Robots::findFirst();
 
$form = new Form($robot);
 
$form->add(new Text("name"));
 
$form->add(new Text("year"));

在表单渲染时如果表单项未设置默认值， phalcon会使用对象实体值作为默认值：

<?php echo $form->render('name'); ?>

开发者可以使用下面的方式验证表单及利用用户的输入来设置值：

<?php
 
$form->bind($_POST, $robot);
 
// Check if the form is valid
if ($form->isValid()) {
 
    // Save the entity
    $robot->save();
}

也可以使用一个简单的类做为对象实体进行参数传递：

<?php
 
class Preferences
{
    public $timezone = 'Europe/Amsterdam';
 
    public $receiveEmails = 'No';
}

使用此类做为对象实体，这样可以使用此类中的值作为表单的默认值：

<?php
 
$form = new Form(new Preferences());
 
$form->add(
    new Select(
        "timezone",
        array(
            'America/New_York'  => 'New York',
            'Europe/Amsterdam'  => 'Amsterdam',
            'America/Sao_Paulo' => 'Sao Paulo',
            'Asia/Tokyo'        => 'Tokyo'
        )
    )
);
 
$form->add(
    new Select(
        "receiveEmails",
        array(
            'Yes' => 'Yes, please!',
            'No'  => 'No, thanks'
        )
    )
);

实体中也可以使用getters, 这样可以给开发者更多的自由，当然也会洽使开发稍麻烦一些，不过这是值得的：

<?php
 
class Preferences
{
    public $timezone;
 
    public $receiveEmails;
 
    public function getTimezone()
    {
        return 'Europe/Amsterdam';
    }
 
    public function getReceiveEmails()
    {
        return 'No';
    }
}

表单控件（Form Elements）

Phalcon提供了一些内置的html元素类，所有这些元素类仅位于 Phalcon\Forms\Element 命名空间下：

名称	描述	示例
Text	产生 INPUT[type=text] 项	Example
Password	产生 INPUT[type=password] 项	Example
Select	产生 SELECT tag (combo lists) 项	Example
Check	产生 INPUT[type=check] 项	Example
Textarea	产生 TEXTAREA 项	Example
Hidden	产生 INPUT[type=hidden] 项	Example
File	产生 INPUT[type=file] 项	Example
Date	产生 INPUT[type=date] 项	Example
Numeric	产生 INPUT[type=number] 项	Example
Submit	产生 INPUT[type=submit] 项	Example

事件回调（Event Callbacks）

当扩展表单时，我们可以在表单类中实现验证前操作及验证后操作：

<?php
 
use Phalcon\Mvc\Form;
 
class ContactForm extends Form
{
    public function beforeValidation()
    {
 
    }
}

渲染表单（Rendering Forms）

开发者对表单的渲染操作有完全的控制，下面的的例子展示了如何使用标准方法渲染html元素：

<?php
 
<form method="post">
    <?php
        // Traverse the form
        foreach ($form as $element) {
 
            // Get any generated messages for the current element
            $messages = $form->getMessagesFor($element->getName());
 
            if (count($messages)) {
                // Print each element
                echo '<div class="messages">';
                foreach ($messages as $message) {
                    echo $message;
                }
                echo '</div>';
            }
 
            echo '<p>';
            echo '<label for="', $element->getName(), '">', $element->getLabel(), '</label>';
            echo $element;
            echo '</p>';
 
        }
    ?>
    <input type="submit" value="Send"/>
</form>

或者可以使用更简单的方式：

<?php
 
echo $form->render();
// or
echo $form->render(NULL, NULL, '<label>:label:</label><p>:element:</p>');

方法 render 第一个参数用来指定渲染哪个表单元素：

<?php
 
echo $form->render('name');

方法 render 第二个参数用来设定表单元素属性：

<?php
 
echo $form->render('name', array('class' => 'form-control'));

方法 render 第三个参数可以设置元素模板：

<?php
 
echo $form->render(NULL, NULL, '<div class="form-group"><label>:label:</label><p>:element:</p></div>');

或是在登录表单中重用表单类：

<?php
 
use Phalcon\Forms\Form;
 
class ContactForm extends Form
{
    public function initialize()
    {
        // ...
    }
 
    public function renderDecorated($name)
    {
        $element  = $this->get($name);
 
        // Get any generated messages for the current element
        $messages = $this->getMessagesFor($element->getName());
 
        if (count($messages)) {
            // Print each element
            echo '<div class="messages">';
            foreach ($messages as $message) {
                echo $this->flash->error($message);
            }
            echo '</div>';
        }
 
        echo '<p>';
        echo '<label for="', $element->getName(), '">', $element->getLabel(), '</label>';
        echo $element;
        echo '</p>';
    }
}

视图中：

<?php
 
echo $element->renderDecorated('name');
 
echo $element->renderDecorated('telephone');

创建表单控件（Creating Form Elements）

除了可以使用phalcon提供的html元素以外，开发者还可以使用自定义的html元素：

<?php
 
use Phalcon\Forms\Element;
 
class MyElement extends Element
{
    public function render($attributes = null)
    {
        $html = // ... Produce some HTML
        return $html;
    }
}

表单元素转换为数组（Creating Form Elements）

<?php
 
$nameElement = new \Phalcon\Forms\Element("name", array('class' => 'big-input'), array('some' => 'value'), NULL, "text");
$versionElement = new \Phalcon\Forms\Element("version", NULL, NULL, array('phalcon' => 'Phalcon', 'phalcon7' => 'Phalcon7'), "select");
 
$form = new \Phalcon\Forms\Form();
$form->add($nameElement);
$form->add($versionElement);
$data = $form->toArray();

$data 值如下：

<?php
 
array(
     "name" => array(
          "name" => "name",
          "type" => "text",
          "attributes" => array(
               "class" => "big-input",
          ),
          "options" => array(
               "some" => "value",
          ),
     ),
     "version" => array(
          "name" => "version",
          "type" => "select",
          "optionsValues" => array(
               "phalcon" => "Phalcon",
               "phalcon7" => "Phalcon7",
          ),
     )
);

表单管理（Forms Manager）

此组件为开发者提供了一个表单管理器，可以用来注册表单，此组件可以使用服务容器来访问：

<?php
 
use Phalcon\Forms\Manager as FormsManager;
 
$di['forms'] = function () {
    return new FormsManager();
};

表单被添加到表单管理器，然后设置了唯一的名字：

<?php
 
$this->forms->set('login', new LoginForm());

使用唯一名，我们可以在应用的任何地方访问到表单：

<?php
 
echo $this->forms->get('login')->render();

外部资源（External Resources)

Vökuró 是一个使用表单构建器来创建和维护表单的示例 [Github]

原文: http://www.myleftstudio.com/reference/forms.html