abstract class FormBase
Provides a base class for forms.
This class exists as a mid-point between dependency injection through ContainerInjectionInterface, and a less-structured use of traits which default to using the \Drupal accessor for service discovery.
To properly inject services, override create() and use the setters provided by the traits to inject the needed services.
public static function create($container) { $form = new static(); // In this example we only need string translation so we use the // setStringTranslation() method provided by StringTranslationTrait. $form->setStringTranslation($container->get('string_translation')); return $form; }
Alternately, do not use FormBase. A class can implement FormInterface, use the traits it needs, and inject services from the container as required.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
See also
\Drupal\Core\DependencyInjection\ContainerInjectionInterface
Related topics
- Form generation
- Describes how to generate and manipulate forms and process form submissions.
File
- core/lib/Drupal/Core/Form/FormBase.php, line 42
Namespace
Drupal\Core\FormMembers
Name | Modifiers | Type | Description |
---|---|---|---|
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
DependencySerializationTrait::__sleep | public | function | |
DependencySerializationTrait::__wakeup | public | function | |
FormBase::$configFactory | protected | property | The config factory. |
FormBase::$loggerFactory | protected | property | The logger factory. |
FormBase::$requestStack | protected | property | The request stack. |
FormBase::$routeMatch | protected | property | The route match. |
FormBase::config | protected | function | Retrieves a configuration object. |
FormBase::configFactory | protected | function | Gets the config factory for this form. |
FormBase::container | private | function | Returns the service container. |
FormBase::create | public static | function | Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create |
FormBase::currentUser | protected | function | Gets the current user. |
FormBase::getRequest | protected | function | Gets the request object. |
FormBase::getRouteMatch | protected | function | Gets the route match. |
FormBase::logger | protected | function | Gets the logger for a specific channel. |
FormBase::resetConfigFactory | public | function | Resets the configuration factory. |
FormBase::setConfigFactory | public | function | Sets the config factory for this form. |
FormBase::setRequestStack | public | function | Sets the request stack object to use. |
FormBase::validateForm | public | function | Form validation handler. Overrides FormInterface::validateForm |
FormInterface::buildForm | public | function | Form constructor. Overrides FormInterface::buildForm |
FormInterface::getFormId | public | function | Returns a unique string identifying the form. |
FormInterface::submitForm | public | function | Form submission handler. |
LinkGeneratorTrait::$linkGenerator | protected | property | The link generator. |
LinkGeneratorTrait::getLinkGenerator | protected | function | Returns the link generator. |
LinkGeneratorTrait::l Deprecated | protected | function | Renders a link to a route given a route name and its parameters. |
LinkGeneratorTrait::setLinkGenerator | public | function | Sets the link generator service. |
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. |
RedirectDestinationTrait::getDestinationArray | protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. |
RedirectDestinationTrait::getRedirectDestination | protected | function | Returns the redirect destination service. |
RedirectDestinationTrait::setRedirectDestination | public | function | Sets the redirect destination service. |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. |
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. |
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. |
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
UrlGeneratorTrait::$urlGenerator | protected | property | The url generator. |
UrlGeneratorTrait::getUrlGenerator | protected | function | Returns the URL generator service. |
UrlGeneratorTrait::redirect | protected | function | Returns a redirect response object for the specified route. |
UrlGeneratorTrait::setUrlGenerator | public | function | Sets the URL generator service. |
UrlGeneratorTrait::url Deprecated | protected | function | Generates a URL or path for a specific route based on the given parameters. |
© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Form!FormBase.php/class/FormBase/8.1.x