class SimpleForm
Same name in other branches
- 3.x modules/form_api_example/src/Form/SimpleForm.php \Drupal\form_api_example\Form\SimpleForm
- 4.0.x modules/form_api_example/src/Form/SimpleForm.php \Drupal\form_api_example\Form\SimpleForm
Implements the SimpleForm form controller.
This example demonstrates a simple form with a single text input element. We extend FormBase which is the simplest form base class used in Drupal.
Hierarchy
- class \Drupal\form_api_example\Form\SimpleForm extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of SimpleForm
See also
\Drupal\Core\Form\FormBase
1 file declares its use of SimpleForm
- SimpleFormBlock.php in form_api_example/
src/ Plugin/ Block/ SimpleFormBlock.php
1 string reference to 'SimpleForm'
- form_api_example.routing.yml in form_api_example/
form_api_example.routing.yml - form_api_example/form_api_example.routing.yml
File
-
form_api_example/
src/ Form/ SimpleForm.php, line 16
Namespace
Drupal\form_api_example\FormView source
class SimpleForm extends FormBase {
/**
* Build the simple form.
*
* A build form method constructs an array that defines how markup and
* other form elements are included in an HTML form.
*
* @param array $form
* Default form array structure.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* Object containing current form state.
*
* @return array
* The render array defining the elements of the form.
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['description'] = [
'#type' => 'item',
'#markup' => $this->t('This basic example shows a single text input element and a submit button'),
];
$form['title'] = [
'#type' => 'textfield',
'#title' => $this->t('Title'),
'#description' => $this->t('Title must be at least 5 characters in length.'),
'#required' => TRUE,
];
// Group submit handlers in an actions element with a key of "actions" so
// that it gets styled correctly, and so that other modules may add actions
// to the form. This is not required, but is convention.
$form['actions'] = [
'#type' => 'actions',
];
// Add a submit button that handles the submission of the form.
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Submit'),
];
return $form;
}
/**
* Getter method for Form ID.
*
* The form ID is used in implementations of hook_form_alter() to allow other
* modules to alter the render array built by this form controller. It must be
* unique site wide. It normally starts with the providing module's name.
*
* @return string
* The unique ID of the form defined by this class.
*/
public function getFormId() {
return 'form_api_example_simple_form';
}
/**
* Implements form validation.
*
* The validateForm method is the default method called to validate input on
* a form.
*
* @param array $form
* The render array of the currently built form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* Object describing the current state of the form.
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
$title = $form_state->getValue('title');
if (strlen($title) < 5) {
// Set an error for the form element with a key of "title".
$form_state->setErrorByName('title', $this->t('The title must be at least 5 characters long.'));
}
}
/**
* Implements a form submit handler.
*
* The submitForm method is the default method called for any submit elements.
*
* @param array $form
* The render array of the currently built form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* Object describing the current state of the form.
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
/*
* This would normally be replaced by code that actually does something
* with the title.
*/
$title = $form_state->getValue('title');
$this->messenger()
->addMessage($this->t('You specified a title of %title.', [
'%title' => $title,
]));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
SimpleForm::buildForm | public | function | Build the simple form. |
SimpleForm::getFormId | public | function | Getter method for Form ID. |
SimpleForm::submitForm | public | function | Implements a form submit handler. |
SimpleForm::validateForm | public | function | Implements form validation. |