abstract class ComponentFormBase in Module Builder 8.3
Base class for Module Builder component forms.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\module_builder\Form\ComponentFormBase
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of ComponentFormBase
File
- src/
Form/ ComponentFormBase.php, line 22
Namespace
Drupal\module_builder\FormView source
abstract class ComponentFormBase extends EntityForm {
/**
* The Drupal Code Builder wrapping service.
*
* @var \Drupal\module_builder\DrupalCodeBuilder
*/
protected $codeBuilder;
/**
* The DCB Generate Task handler.
*/
protected $codeBuilderTaskHandlerGenerate;
/**
* The exception thrown by DCB when initialized, if any.
*
* @var \DrupalCodeBuilder\Exception\SanityException
*/
protected $sanityException;
/**
* Construct a new form object
*
* @param \Drupal\module_builder\DrupalCodeBuilder $code_builder
* The Drupal Code Builder service.
* This needs to be injected so that submissions after an AJAX operation
* work (plus it's good for testing too).
*/
function __construct(DrupalCodeBuilder $code_builder) {
$this->codeBuilder = $code_builder;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('module_builder.drupal_code_builder'));
}
/**
* {@inheritdoc}
*/
public function setEntity(EntityInterface $entity) {
parent::setEntity($entity);
// Get the component data info based on the entity type. This is the
// earliest we can do this, as entity forms don't know the entity type they
// are for when constructed.
$component_type = $entity
->getComponentType();
try {
$generate_task = $this->codeBuilder
->getTask('Generate', $component_type);
} catch (SanityException $e) {
$this->sanityException = $e;
return $this;
}
$this
->setGenerateTask($generate_task);
return $this;
}
/**
* Sets the generate task.
*
* @param \DrupalCodeBuilder\Task\Generate $generate_task
*/
public function setGenerateTask(Generate $generate_task) {
$this->codeBuilderTaskHandlerGenerate = $generate_task;
}
/**
* Gets the data object for the entity in the form.
*
* @return \MutableTypedData\Data\DataItem
* The data item object loaded with entity data.
*/
protected function getComponentDataObject() : DataItem {
$component_data = $this->codeBuilderTaskHandlerGenerate
->getRootComponentData();
$entity_component_data = $this->entity
->get('data');
// Add in the component root name and readable name, because these are saved
// as top-level properties in the entity config, and so aren't in the
// component data.
$entity_component_data['root_name'] = $this->entity
->id();
$entity_component_data['readable_name'] = $this->entity
->label();
if ($entity_component_data) {
// Use import() to allow for changes in DCB's data structure and an older
// data structure in the saved module entiy.
$component_data
->import($entity_component_data);
}
return $component_data;
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
// Do this here, as the parent method adds the actions to the form, so doing
// this in the form() method would show those.
if ($this->sanityException) {
// Pass the DCB exception to the handler, which outputs the error message.
ExceptionHandler::handleSanityException($this->sanityException);
return $form;
}
return parent::buildForm($form, $form_state);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComponentFormBase:: |
protected | property | The Drupal Code Builder wrapping service. | |
ComponentFormBase:: |
protected | property | The DCB Generate Task handler. | |
ComponentFormBase:: |
protected | property | The exception thrown by DCB when initialized, if any. | |
ComponentFormBase:: |
public | function |
Form constructor. Overrides EntityForm:: |
|
ComponentFormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ComponentFormBase:: |
protected | function | Gets the data object for the entity in the form. | |
ComponentFormBase:: |
public | function |
Sets the form entity. Overrides EntityForm:: |
|
ComponentFormBase:: |
public | function | Sets the generate task. | |
ComponentFormBase:: |
function | Construct a new form object | ||
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 | |
EntityForm:: |
protected | property | The entity being used by this form. | 7 |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
private | property | The entity manager. | |
EntityForm:: |
protected | function | Returns an array of supported actions for the current entity form. | 29 |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
2 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties | 7 |
EntityForm:: |
public | function | Gets the actual form array to be built. | 30 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
5 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
1 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityFormInterface:: |
41 |
EntityForm:: |
public | function |
Sets the entity manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… Overrides FormInterface:: |
17 |
EntityForm:: |
public | function | ||
EntityForm:: |
public | function | ||
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 |
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. | |
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. |