abstract class MultistepFormBase in GatherContent 8.3
Class MultistepFormBase.
@package Drupal\gathercontent\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\gathercontent\Form\MultistepFormBase
Expanded class hierarchy of MultistepFormBase
File
- src/
Form/ MultistepFormBase.php, line 18
Namespace
Drupal\gathercontent\FormView source
abstract class MultistepFormBase extends FormBase {
/**
* Drupal\Core\Entity\EntityManager definition.
*
* @var \Drupal\Core\Entity\EntityManager
*/
protected $entityManager;
/**
* Drupal\Core\Datetime\DateFormatter definition.
*
* @var \Drupal\Core\Datetime\DateFormatter
*/
protected $dateFormatter;
/**
* Drupal\user\PrivateTempStoreFactory definition.
*
* @var \Drupal\user\PrivateTempStoreFactory
*/
protected $tempStoreFactory;
/**
* Drupal\Core\Entity\Query\QueryFactory definition.
*
* @var \Drupal\Core\Entity\Query\QueryFactory
*/
protected $entityQuery;
/**
* Drupal\user\PrivateTempStore definition.
*
* @var \Drupal\user\PrivateTempStore
*/
protected $store;
/**
* Constructor for class.
*
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* EntityManagerInterface object.
* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
* DateFormatterInterface object.
* @param \Drupal\user\PrivateTempStoreFactory $temp_store_factory
* PrivateTempStoreFactory object.
* @param \Drupal\Core\Entity\Query\QueryFactory $entityQuery
* QueryFactory object.
*/
public function __construct(EntityManagerInterface $entity_manager, DateFormatterInterface $date_formatter, PrivateTempStoreFactory $temp_store_factory, QueryFactory $entityQuery) {
$this->entityManager = $entity_manager;
$this->dateFormatter = $date_formatter;
$this->tempStoreFactory = $temp_store_factory;
$this->entityQuery = $entityQuery;
$this->store = $this->tempStoreFactory
->get('gathercontent_multistep_data');
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity.manager'), $container
->get('date.formatter'), $container
->get('user.private_tempstore'), $container
->get('entity.query'));
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form = [];
$form['actions']['#type'] = 'actions';
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Submit'),
'#button_type' => 'primary',
'#weight' => 10,
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
}
/**
* Helper removing all keys from the store collection used for multistep form.
*
* @param array $keys
* Array of keys to delete.
*/
protected function deleteStore(array $keys) {
foreach ($keys as $key) {
$this->store
->delete($key);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
FormInterface:: |
public | function | Returns a unique string identifying the form. | 236 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
MultistepFormBase:: |
protected | property | Drupal\Core\Datetime\DateFormatter definition. | |
MultistepFormBase:: |
protected | property | Drupal\Core\Entity\EntityManager definition. | |
MultistepFormBase:: |
protected | property | Drupal\Core\Entity\Query\QueryFactory definition. | |
MultistepFormBase:: |
protected | property | Drupal\user\PrivateTempStore definition. | |
MultistepFormBase:: |
protected | property | Drupal\user\PrivateTempStoreFactory definition. | |
MultistepFormBase:: |
public | function |
Form constructor. Overrides FormInterface:: |
1 |
MultistepFormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
MultistepFormBase:: |
protected | function | Helper removing all keys from the store collection used for multistep form. | |
MultistepFormBase:: |
public | function |
Form submission handler. Overrides FormInterface:: |
1 |
MultistepFormBase:: |
public | function | Constructor for class. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |