class LogCommentForm in Commerce Core 8.2
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\commerce_log\Form\LogCommentForm
Expanded class hierarchy of LogCommentForm
1 file declares its use of LogCommentForm
- AdminCommentForm.php in modules/
log/ src/ Plugin/ views/ area/ AdminCommentForm.php
File
- modules/
log/ src/ Form/ LogCommentForm.php, line 15
Namespace
Drupal\commerce_log\FormView source
class LogCommentForm extends FormBase {
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The log template manager.
*
* @var \Drupal\commerce_log\LogTemplateManagerInterface
*/
protected $logTemplateManager;
/**
* Constructs a new LogCommentForm object.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\commerce_log\LogTemplateManagerInterface $log_template_manager
* The log template manager.
*/
public function __construct(EntityTypeManagerInterface $entity_type_manager, LogTemplateManagerInterface $log_template_manager) {
$this->entityTypeManager = $entity_type_manager;
$this->logTemplateManager = $log_template_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'), $container
->get('plugin.manager.commerce_log_template'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'log_comment_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $source_entity_type = NULL, $source_entity_id = NULL, $log_template_id = NULL) {
if ($source_entity_type === NULL || $source_entity_id === NULL || $log_template_id === NULL) {
return [];
}
if (!$this->logTemplateManager
->hasDefinition($log_template_id)) {
return [];
}
$entity_type = $this->entityTypeManager
->getDefinition($source_entity_type);
assert($entity_type !== NULL);
$form['log_comment'] = [
'#type' => 'details',
'#title' => $this
->t('Comment on this @label', [
'@label' => $entity_type
->getSingularLabel(),
]),
'#open' => FALSE,
];
$form['log_comment']['source_entity_id'] = [
'#type' => 'hidden',
'#value' => $source_entity_id,
];
$form['log_comment']['source_entity_type'] = [
'#type' => 'hidden',
'#value' => $source_entity_type,
];
$form['log_comment']['log_template_id'] = [
'#type' => 'hidden',
'#value' => $log_template_id,
];
$form['log_comment']['comment'] = [
'#type' => 'textarea',
'#title' => $this
->t('Comment'),
'#title_display' => 'invisible',
'#required' => TRUE,
];
$form['log_comment']['actions']['#type'] = 'actions';
$form['log_comment']['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Add comment'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$log_storage = $this->entityTypeManager
->getStorage('commerce_log');
assert($log_storage instanceof LogStorageInterface);
$storage = $this->entityTypeManager
->getStorage($form_state
->getValue('source_entity_type'));
assert($storage instanceof EntityStorageInterface);
$entity = $storage
->load($form_state
->getValue('source_entity_id'));
assert($entity instanceof ContentEntityInterface);
$comment = nl2br(Html::escape($form_state
->getValue('comment')));
$log_storage
->generate($entity, $form_state
->getValue('log_template_id'), [
'comment' => $comment,
])
->save();
$this
->messenger()
->addStatus($this
->t('Comment saved'));
}
}
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 |
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. | |
LogCommentForm:: |
protected | property | The entity type manager. | |
LogCommentForm:: |
protected | property | The log template manager. | |
LogCommentForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
LogCommentForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
LogCommentForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
LogCommentForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
LogCommentForm:: |
public | function | Constructs a new LogCommentForm object. | |
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. |