class SocialCommentAdminOverview in Open Social 8.8
Same name and namespace in other branches
- 8.9 modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 8.3 modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 8.4 modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 8.5 modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 8.6 modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 8.7 modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 10.3.x modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 10.0.x modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 10.1.x modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
- 10.2.x modules/social_features/social_comment/src/Form/SocialCommentAdminOverview.php \Drupal\social_comment\Form\SocialCommentAdminOverview
Provides the comments overview administration form.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\social_comment\Form\SocialCommentAdminOverview
Expanded class hierarchy of SocialCommentAdminOverview
File
- modules/
social_features/ social_comment/ src/ Form/ SocialCommentAdminOverview.php, line 20
Namespace
Drupal\social_comment\FormView source
class SocialCommentAdminOverview extends FormBase {
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The comment storage.
*
* @var \Drupal\comment\CommentStorageInterface
*/
protected $commentStorage;
/**
* The date formatter service.
*
* @var \Drupal\Core\Datetime\DateFormatterInterface
*/
protected $dateFormatter;
/**
* The module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The tempstore factory.
*
* @var \Drupal\Core\TempStore\PrivateTempStoreFactory
*/
protected $tempStoreFactory;
/**
* The renderer.
*
* @var \Drupal\Core\Render\Renderer
*/
protected $renderer;
/**
* Creates a CommentAdminOverview form.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity manager service.
* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
* The date formatter service.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
* The tempstore factory.
* @param \Drupal\Core\Render\Renderer $renderer
* The renderer.
*/
public function __construct(EntityTypeManagerInterface $entity_type_manager, DateFormatterInterface $date_formatter, ModuleHandlerInterface $module_handler, PrivateTempStoreFactory $temp_store_factory, Renderer $renderer) {
$this->entityTypeManager = $entity_type_manager;
$this->commentStorage = $entity_type_manager
->getStorage('comment');
$this->dateFormatter = $date_formatter;
$this->moduleHandler = $module_handler;
$this->tempStoreFactory = $temp_store_factory;
$this->renderer = $renderer;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'), $container
->get('date.formatter'), $container
->get('module_handler'), $container
->get('tempstore.private'), $container
->get('renderer'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'comment_admin_overview';
}
/**
* Form constructor for the comment overview administration form.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param string $type
* The type of the overview form ('approval' or 'new').
*
* @return array
* The form structure.
*/
public function buildForm(array $form, FormStateInterface $form_state, $type = 'new') {
// Build an 'Update options' form.
$form['options'] = [
'#type' => 'details',
'#title' => $this
->t('Update options'),
'#open' => TRUE,
'#attributes' => [
'class' => [
'container-inline',
],
],
];
if ($type == 'approval') {
$options['publish'] = $this
->t('Publish the selected comments');
}
else {
$options['unpublish'] = $this
->t('Unpublish the selected comments');
}
$options['delete'] = $this
->t('Delete the selected comments');
$form['options']['operation'] = [
'#type' => 'select',
'#title' => $this
->t('Action'),
'#title_display' => 'invisible',
'#options' => $options,
'#default_value' => 'publish',
];
$form['options']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Update'),
];
// Load the comments that need to be displayed.
$status = $type == 'approval' ? CommentInterface::NOT_PUBLISHED : CommentInterface::PUBLISHED;
$header = [
'author' => [
'data' => $this
->t('Author'),
'specifier' => 'name',
'class' => [
RESPONSIVE_PRIORITY_MEDIUM,
],
],
'comment' => [
'data' => $this
->t('Comment'),
'specifier' => 'comment_body',
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
],
'changed' => [
'data' => $this
->t('Updated'),
'specifier' => 'changed',
'sort' => 'desc',
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
],
'operations' => $this
->t('Operations'),
];
$cids = $this->commentStorage
->getQuery()
->condition('status', $status)
->tableSort($header)
->pager(50)
->execute();
/* @var $comments \Drupal\comment\CommentInterface[] */
$comments = $this->commentStorage
->loadMultiple($cids);
// Build a table listing the appropriate comments.
$options = [];
$destination = $this
->getDestinationArray();
foreach ($comments as $comment) {
// Get a render array for the comment body field. We'll render it in the
// table.
$comment_body = $comment->field_comment_body
->view('full');
$options[$comment
->id()] = [
'title' => [
'data' => [
'#title' => $comment
->getSubject() ?: $comment
->id(),
],
],
'author' => [
'data' => [
'#theme' => 'username',
'#account' => $comment
->getOwner(),
],
],
'comment' => [
'data' => [
'#markup' => $this->renderer
->renderRoot($comment_body),
],
],
'changed' => $this->dateFormatter
->format($comment
->getChangedTimeAcrossTranslations(), 'short'),
];
// Create a list of operations.
$comment_uri_options = $comment
->toUrl()
->getOptions() + [
'query' => $destination,
];
$links['view'] = [
'title' => $this
->t('View'),
'url' => $comment
->toUrl(),
];
$links['edit'] = [
'title' => $this
->t('Edit'),
'url' => $comment
->toUrl('edit-form', $comment_uri_options),
];
$links['delete'] = [
'title' => $this
->t('Delete'),
'url' => $comment
->toUrl('delete-form', $comment_uri_options),
];
// Add a 'Translate' operations link if the comment is translatable.
if ($this->moduleHandler
->moduleExists('content_translation') && $comment
->getCommentedEntity() instanceof ContentEntityInterface && $this->moduleHandler
->invoke('content_translation', 'translate_access', [
$comment,
])
->isAllowed()) {
$links['translate'] = [
'title' => $this
->t('Translate'),
'url' => $comment
->toUrl('drupal:content-translation-overview', $comment_uri_options),
];
}
$options[$comment
->id()]['operations']['data'] = [
'#type' => 'operations',
'#links' => $links,
];
}
$form['comments'] = [
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
'#empty' => $this
->t('No comments available.'),
];
$form['pager'] = [
'#type' => 'pager',
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
$form_state
->setValue('comments', array_diff($form_state
->getValue('comments'), [
0,
]));
// We can't execute any 'Update options' if no comments were selected.
if (count($form_state
->getValue('comments')) == 0) {
$form_state
->setErrorByName('', $this
->t('Select one or more comments to perform the update on.'));
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$operation = $form_state
->getValue('operation');
$cids = $form_state
->getValue('comments');
/** @var \Drupal\comment\CommentInterface[] $comments */
$comments = $this->commentStorage
->loadMultiple($cids);
if ($operation != 'delete') {
foreach ($comments as $comment) {
if ($operation == 'unpublish') {
$comment
->setUnpublished();
}
elseif ($operation == 'publish') {
$comment
->setPublished();
}
$comment
->save();
}
drupal_set_message($this
->t('The update has been performed.'));
$form_state
->setRedirect('comment.admin');
}
else {
$info = [];
/** @var \Drupal\comment\CommentInterface $comment */
foreach ($comments as $comment) {
$langcode = $comment
->language()
->getId();
$info[$comment
->id()][$langcode] = $langcode;
}
$this->tempStoreFactory
->get('comment_multiple_delete_confirm')
->set($this
->currentUser()
->id(), $info);
$form_state
->setRedirect('comment.multiple_delete_confirm');
}
}
}
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. | |
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. | |
SocialCommentAdminOverview:: |
protected | property | The comment storage. | |
SocialCommentAdminOverview:: |
protected | property | The date formatter service. | |
SocialCommentAdminOverview:: |
protected | property | The entity type manager. | |
SocialCommentAdminOverview:: |
protected | property | The module handler. | |
SocialCommentAdminOverview:: |
protected | property | The renderer. | |
SocialCommentAdminOverview:: |
protected | property | The tempstore factory. | |
SocialCommentAdminOverview:: |
public | function |
Form constructor for the comment overview administration form. Overrides FormInterface:: |
|
SocialCommentAdminOverview:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
SocialCommentAdminOverview:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
SocialCommentAdminOverview:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
SocialCommentAdminOverview:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
SocialCommentAdminOverview:: |
public | function | Creates a CommentAdminOverview form. | |
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. |