class ContentTranslationRedirectForm in Content Translation Redirect 8
Form handler for the Content Translation Redirect add and edit 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\content_translation_redirect\Form\ContentTranslationRedirectForm uses ContentTranslationRedirectFormTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of ContentTranslationRedirectForm
File
- src/
Form/ ContentTranslationRedirectForm.php, line 15
Namespace
Drupal\content_translation_redirect\FormView source
class ContentTranslationRedirectForm extends EntityForm {
use ContentTranslationRedirectFormTrait;
/**
* The entity type bundle info.
*
* @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
*/
protected $entityTypeBundleInfo;
/**
* ContentTranslationRedirectForm constructor.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entityTypeManager.
* @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
* The entity type bundle info.
*/
public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
$this->entityTypeManager = $entity_type_manager;
$this->entityTypeBundleInfo = $entity_type_bundle_info;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'), $container
->get('entity_type.bundle.info'));
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
/** @var \Drupal\content_translation_redirect\ContentTranslationRedirectInterface $entity */
$entity = $this->entity;
// If this is a new entity, then list available bundles.
if ($entity
->isNew()) {
$form['id'] = [
'#type' => 'select',
'#title' => $this
->t('Type'),
'#description' => $this
->t('Select the entity type for which you want to add a redirect.'),
'#options' => $this
->getAvailableBundles(),
'#required' => TRUE,
];
}
$settings = [
'code' => $entity
->getStatusCode(),
'message' => $entity
->getMessage(),
];
$form += $this
->redirectSettingsForm($settings);
return $form;
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
/** @var \Drupal\content_translation_redirect\ContentTranslationRedirectInterface $entity */
$entity = $this->entity;
// Set the label on new entity.
if ($entity
->isNew()) {
$entity_id = $form_state
->getValue('id');
list($entity_type_id, $bundle_id) = explode('__', $entity_id);
// Get the entity label.
$entity_label = (string) $this->entityTypeManager
->getDefinition($entity_type_id)
->getLabel();
// Get the bundle label.
$bundle_info = $this->entityTypeBundleInfo
->getBundleInfo($entity_type_id);
$entity_label .= ': ' . $bundle_info[$bundle_id]['label'];
// Set the label to the config entity.
$entity
->set('label', $entity_label);
}
// Set code and message.
$entity
->setStatusCode($form_state
->getValue('code'));
$entity
->setMessage($form_state
->getValue('message'));
// Save the entity.
$status = $entity
->save();
if ($status == SAVED_NEW) {
$this
->messenger()
->addMessage($this
->t('Created the %label Content Translation Redirect.', [
'%label' => $entity
->label(),
]));
}
else {
$this
->messenger()
->addMessage($this
->t('Saved the %label Content Translation Redirect.', [
'%label' => $entity
->label(),
]));
}
$form_state
->setRedirect('entity.content_translation_redirect.collection');
}
/**
* Returns an array of available content entity bundles.
*
* @return array
* A list of available content entity bundles as $id => $label.
*/
protected function getAvailableBundles() {
$options = [];
// Get entity type definitions with bundles.
$entity_types = $this->entityTypeManager
->getDefinitions();
$bundles = $this->entityTypeBundleInfo
->getAllBundleInfo();
// Get entity types labels.
$labels = [];
foreach ($entity_types as $entity_type_id => $entity_type) {
// Check content entity type.
if (!$entity_type instanceof ContentEntityTypeInterface) {
continue;
}
// Check unsupported entity types.
if (in_array($entity_type_id, $this
->getUnsupportedEntityTypes())) {
continue;
}
// Check translatable entity type with bundles and canonical link.
if (!$entity_type
->isTranslatable() || !$entity_type
->hasLinkTemplate('canonical') || !isset($bundles[$entity_type_id])) {
continue;
}
// Get entity type label.
$labels[$entity_type_id] = (string) $entity_type
->getLabel() ?: $entity_type_id;
}
// Iterate content entity types.
$storage = $this->entityTypeManager
->getStorage('content_translation_redirect');
foreach ($labels as $entity_type_id => $label) {
foreach ($bundles[$entity_type_id] as $bundle_id => $bundle_info) {
$entity_id = $entity_type_id . '__' . $bundle_id;
if (!$storage
->load($entity_id)) {
$options[$label][$entity_id] = $bundle_info['label'];
}
}
}
return $options;
}
/**
* Returns a list of entity types that are not supported.
*
* @return array
* A list of entity types that are not supported.
*/
protected function getUnsupportedEntityTypes() {
return [
// Custom blocks.
'block_content',
// Comments.
'comment',
// Menu items.
'menu_link_content',
// Shortcut items.
'shortcut',
];
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContentTranslationRedirectForm:: |
protected | property | The entity type bundle info. | |
ContentTranslationRedirectForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ContentTranslationRedirectForm:: |
public | function |
Gets the actual form array to be built. Overrides EntityForm:: |
|
ContentTranslationRedirectForm:: |
protected | function | Returns an array of available content entity bundles. | |
ContentTranslationRedirectForm:: |
protected | function | Returns a list of entity types that are not supported. | |
ContentTranslationRedirectForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
ContentTranslationRedirectForm:: |
public | function | ContentTranslationRedirectForm constructor. | |
ContentTranslationRedirectFormTrait:: |
protected | function | Redirect status codes. | |
ContentTranslationRedirectFormTrait:: |
protected | function | Form elements for redirect settings. | |
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:: |
public | function |
Form constructor. Overrides FormInterface:: |
10 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties | 7 |
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 |
Sets the form entity. Overrides EntityFormInterface:: |
|
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. |