Form API – часть 2. Функции валидации и обработки формы.

27.11.2014

Сегодня продолжим изучение Form API Drupal, как вы наверное помните из прошлого урока, мы с вами научились создавать простейшую форму, а именно создали два текстовых поля и кнопку отправки формы, но как вы могли заметить после нажатия на кнопку никаких действий у нас не происходит, все дело в том, что мы с вами не написали функцию обработки данной формы, так что давайте это дело исправлять.

Функция обработки формы

Функция обработки формы – это функция, которая будет вызываться после нажатия на кнопку отправки формы. Данная функция, как правило, принимает введенные пользователем значения в поля формы и производит с ними какие – либо действия.

Для того, что бы наша кнопка заработала необходимо изменить callback нашей страницы на функцию:

drupal_get_form

а функцию

myform_form

передать странице в качестве аргумента, т.е функция

myform_menu

должна принять следующий вид

<?php
function myform_menu(){
    $items = array();
    $items['myform'] = array(
      'title' => 'Form API',
      'page callback' => 'drupal_get_form',
      'page arguments' => array('myform_form'),
      'access callback' => TRUE
    );
    return $items;
}

Чистим кеш Drupal, и видим, что после нажатия на кнопку отправки формы у нас перезагружается страница.

Теперь напишем функцию, которая будет обрабатывать введенные пользователем данные, за это отвечает хук:

hook_form_submit

В нашем случае, данная функция будет выглядеть так:

<?php
/**
 * Callback submit
 * Implements hook_form_submit
 */
function myform_form_submit(){
  drupal_set_message('Hi people');
}

Опять же чистим кеш Drupal, и жмем на кнопку отправить

Получили сообщение после нажатия на кнопку отправки формы

Видим, что после нажатия у нас появилось сообщение, значит функция обработки формы у нас работает.

Теперь, через данную функцию мы может обрабатывать значения, которые будет вводить пользователь. Для того, что бы принимать вводимые значения пользователей, нам необходимо передать 2 параметра (переменные $form, $form_state) в функцию формы и функцию обработки формы, в результате функции формы и обработки примут следующий вид:

<?php
/**
 * Callback myform
 */
function myform_form($form, &$form_state) {
    // Описали первое текстовое поле
    $form['onetextfield'] = array(
      '#type' => 'textfield',                   // тип поля
      '#title' => t('первое текстовое поле'),   // заголовок поля
    );
 
    // Описали второе текстовое поле
    $form['twotextfield'] = array(
      '#type' => 'textfield',                   // тип поля
      '#title' => t('второе текстовое поле'),   // заголовок поля
    );
 
    // Описали кнопку отправки форму
    $form['submit'] = array(
      '#type' => 'submit',                      // тип поля
      '#value' => t('отправить форму'),         // текст кнопки формы
    );
    return $form;
}
 
/**
 * Callback submit
 * Implements hook_form_submit
 */
function myform_form_submit($form, &$form_state){
  $output = 'Первое текстовое поле - ' .$form_state['values']['onetextfield'] .'<br>';
  $output .= 'Второе текстовое поле - ' .$form_state['values']['twotextfield'];
  drupal_set_message($output);
}

После чего заполняем поля формы, жмем кнопку отправки формы и смотрим результат

Обработали значения введенные пользователем и показали его значения в сообщении сайта

Видим, что в сообщении мы получили введенные значения, как вы видите введенные пользователем значения сохраняются в

$form_state['values']

Которую мы указывали в качестве второго параметра для функций формы и обработки формы. Думаю теперь вы поняли, как можно обработать данные.

Функция валидации формы

Функция валидации формы отвечает за корректность введенных пользователем значений. Например, давайте для первого текстового поля разрешим ввод только числовых значений.

За функцию валидации отвечает хук:

hook_form_validate

В нашем случае функция валидации будет выглядеть следующим образом:

<?php
/**
 * Implements hook_form_validate
 */
function myform_form_validate($form, &$form_state){
  if(!is_numeric($form_state['values']['onetextfield'])){
      form_set_error('onetextfield', t('Для данного поля возможно, только числовые значения'));
  }
}

После чего чистим кеш, заполняем поля текстом и жмем на отправку

Видим, что у нас сработала функция валидации на первое поле формы, а если мы введем числовое значение, то форма успешно отправиться.

Полный код файла myform.module

<?php
/**
 * implements hook_menu()
 */
function myform_menu(){
    $items = array();
    $items['myform'] = array(
      'title' => 'Form API',
      'page callback' => 'drupal_get_form',
      'page arguments' => array('myform_form'),
      'access callback' => TRUE
    );
 
    return $items;
}
 
/**
 * Callback myform
 */
function myform_form($form, &$form_state) {
    // Описали первое текстовое поле
    $form['onetextfield'] = array(
      '#type' => 'textfield',                   // тип поля
      '#title' => t('первое текстовое поле'),   // заголовок поля
    );
 
    // Описали второе текстовое поле
    $form['twotextfield'] = array(
      '#type' => 'textfield',                   // тип поля
      '#title' => t('второе текстовое поле'),   // заголовок поля
    );
 
    // Описали кнопку отправки форму
    $form['submit'] = array(
      '#type' => 'submit',                      // тип поля
      '#value' => t('отправить форму'),         // текст кнопки формы
    );
    return $form;
}
 
/**
 * Callback submit
 * Implements hook_form_submit
 */
function myform_form_submit($form, &$form_state){
  $output = 'Первое текстовое поле - ' .$form_state['values']['onetextfield'] .'<br>';
  $output .= 'Второе текстовое поле - ' .$form_state['values']['twotextfield'];
  drupal_set_message($output);
}
 
/**
 * Implements hook_form_validate
 */
function myform_form_validate($form, &$form_state){
  if(!is_numeric($form_state['values']['onetextfield'])){
      form_set_error('onetextfield', t('Для данного поля возможно, только числовые значения'));
  }
}

На этом думаю можно закончить, сегодня вы должны понять как написать функции обработки формы и валидации. В следующих уроках мы продолжим изучение Form API.

Form api

Form API – часть 2. Функции валидации и обработки формы.

Похожие статьи

Список переменных для создания region.tpl.php

Создаем табы для административных страниц своего модуля в Drupal 7

Перекрытие главной страницы в Drupal на свою

Подробнее о функциях theme_* в Drupal 7

Переносим сайт с denwer на хостинг

Список переменных для создания comment.tpl.php

Drupal 8 – подключение CSS и JS

Темизация веб-формы в Drupal 7. Файл webform-tpl.php

Обновляем версию Drupal

Пишем свой модуль для Drupal 8. Создание страницы и пункта меню.

Создание каталога в Drupal 7. Часть 2

Файл html.tpl.php в Drupal 7

Комментарии (2)