class CommentAdminOverview in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/comment/src/Form/CommentAdminOverview.php \Drupal\comment\Form\CommentAdminOverview
Provides the comments overview administration form.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\comment\Form\CommentAdminOverview
Expanded class hierarchy of CommentAdminOverview
File
- core/
modules/ comment/ src/ Form/ CommentAdminOverview.php, line 23 - Contains \Drupal\comment\Form\CommentAdminOverview.
Namespace
Drupal\comment\FormView source
class CommentAdminOverview extends FormBase {
/**
* The entity storage.
*
* @var \Drupal\Core\Entity\EntityManagerInterface
*/
protected $entityManager;
/**
* 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;
/**
* Creates a CommentAdminOverview form.
*
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* The entity manager service.
* @param \Drupal\comment\CommentStorageInterface $comment_storage
* The comment storage.
* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
* The date formatter service.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
*/
public function __construct(EntityManagerInterface $entity_manager, CommentStorageInterface $comment_storage, DateFormatterInterface $date_formatter, ModuleHandlerInterface $module_handler) {
$this->entityManager = $entity_manager;
$this->commentStorage = $comment_storage;
$this->dateFormatter = $date_formatter;
$this->moduleHandler = $module_handler;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity.manager'), $container
->get('entity.manager')
->getStorage('comment'), $container
->get('date.formatter'), $container
->get('module_handler'));
}
/**
* {@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'] = array(
'#type' => 'details',
'#title' => $this
->t('Update options'),
'#open' => TRUE,
'#attributes' => array(
'class' => array(
'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'] = array(
'#type' => 'select',
'#title' => $this
->t('Action'),
'#title_display' => 'invisible',
'#options' => $options,
'#default_value' => 'publish',
);
$form['options']['submit'] = array(
'#type' => 'submit',
'#value' => $this
->t('Update'),
);
// Load the comments that need to be displayed.
$status = $type == 'approval' ? CommentInterface::NOT_PUBLISHED : CommentInterface::PUBLISHED;
$header = array(
'subject' => array(
'data' => $this
->t('Subject'),
'specifier' => 'subject',
),
'author' => array(
'data' => $this
->t('Author'),
'specifier' => 'name',
'class' => array(
RESPONSIVE_PRIORITY_MEDIUM,
),
),
'posted_in' => array(
'data' => $this
->t('Posted in'),
'class' => array(
RESPONSIVE_PRIORITY_LOW,
),
),
'changed' => array(
'data' => $this
->t('Updated'),
'specifier' => 'changed',
'sort' => 'desc',
'class' => array(
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 = array();
$destination = $this
->getDestinationArray();
$commented_entity_ids = array();
$commented_entities = array();
foreach ($comments as $comment) {
$commented_entity_ids[$comment
->getCommentedEntityTypeId()][] = $comment
->getCommentedEntityId();
}
foreach ($commented_entity_ids as $entity_type => $ids) {
$commented_entities[$entity_type] = $this->entityManager
->getStorage($entity_type)
->loadMultiple($ids);
}
foreach ($comments as $comment) {
/** @var $commented_entity \Drupal\Core\Entity\EntityInterface */
$commented_entity = $commented_entities[$comment
->getCommentedEntityTypeId()][$comment
->getCommentedEntityId()];
$comment_permalink = $comment
->permalink();
if ($comment
->hasField('comment_body') && ($body = $comment
->get('comment_body')->value)) {
$attributes = $comment_permalink
->getOption('attributes') ?: array();
$attributes += array(
'title' => Unicode::truncate($body, 128),
);
$comment_permalink
->setOption('attributes', $attributes);
}
$options[$comment
->id()] = array(
'title' => array(
'data' => array(
'#title' => $comment
->getSubject() ?: $comment
->id(),
),
),
'subject' => array(
'data' => array(
'#type' => 'link',
'#title' => $comment
->getSubject(),
'#url' => $comment_permalink,
),
),
'author' => array(
'data' => array(
'#theme' => 'username',
'#account' => $comment
->getOwner(),
),
),
'posted_in' => array(
'data' => array(
'#type' => 'link',
'#title' => $commented_entity
->label(),
'#access' => $commented_entity
->access('view'),
'#url' => $commented_entity
->urlInfo(),
),
),
'changed' => $this->dateFormatter
->format($comment
->getChangedTimeAcrossTranslations(), 'short'),
);
$comment_uri_options = $comment
->urlInfo()
->getOptions() + [
'query' => $destination,
];
$links = array();
$links['edit'] = array(
'title' => $this
->t('Edit'),
'url' => $comment
->urlInfo('edit-form', $comment_uri_options),
);
if ($this->moduleHandler
->moduleExists('content_translation') && $this->moduleHandler
->invoke('content_translation', 'translate_access', array(
$comment,
))
->isAllowed()) {
$links['translate'] = array(
'title' => $this
->t('Translate'),
'url' => $comment
->urlInfo('drupal:content-translation-overview', $comment_uri_options),
);
}
$options[$comment
->id()]['operations']['data'] = array(
'#type' => 'operations',
'#links' => $links,
);
}
$form['comments'] = array(
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
'#empty' => $this
->t('No comments available.'),
);
$form['pager'] = array(
'#type' => 'pager',
);
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
$form_state
->setValue('comments', array_diff($form_state
->getValue('comments'), array(
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');
foreach ($cids as $cid) {
// Delete operation handled in \Drupal\comment\Form\ConfirmDeleteMultiple
// see \Drupal\comment\Controller\AdminController::adminPage().
if ($operation == 'unpublish') {
$comment = $this->commentStorage
->load($cid);
$comment
->setPublished(FALSE);
$comment
->save();
}
elseif ($operation == 'publish') {
$comment = $this->commentStorage
->load($cid);
$comment
->setPublished(TRUE);
$comment
->save();
}
}
drupal_set_message($this
->t('The update has been performed.'));
$form_state
->setRedirect('comment.admin');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommentAdminOverview:: |
protected | property | The comment storage. | |
CommentAdminOverview:: |
protected | property | The date formatter service. | |
CommentAdminOverview:: |
protected | property | The entity storage. | |
CommentAdminOverview:: |
protected | property | The module handler. | |
CommentAdminOverview:: |
public | function |
Form constructor for the comment overview administration form. Overrides FormInterface:: |
|
CommentAdminOverview:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
CommentAdminOverview:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
CommentAdminOverview:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
CommentAdminOverview:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
CommentAdminOverview:: |
public | function | Creates a CommentAdminOverview form. | |
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. | 3 |
FormBase:: |
protected | property | The logger factory. | |
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. | 3 |
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:: |
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. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | |
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. | |
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:: |
protected | function | Returns a redirect response object for the specified route. | |
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. |