class CommentManager in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/comment/src/CommentManager.php \Drupal\comment\CommentManager
Comment manager contains common functions to manage comment fields.
Hierarchy
- class \Drupal\comment\CommentManager implements CommentManagerInterface uses UrlGeneratorTrait, StringTranslationTrait
Expanded class hierarchy of CommentManager
1 file declares its use of CommentManager
- CommentManagerTest.php in core/
modules/ comment/ tests/ src/ Unit/ CommentManagerTest.php - Contains \Drupal\Tests\comment\Unit\CommentManagerTest.
1 string reference to 'CommentManager'
- comment.services.yml in core/
modules/ comment/ comment.services.yml - core/modules/comment/comment.services.yml
1 service uses CommentManager
- comment.manager in core/
modules/ comment/ comment.services.yml - Drupal\comment\CommentManager
File
- core/
modules/ comment/ src/ CommentManager.php, line 28 - Contains \Drupal\comment\CommentManager.
Namespace
Drupal\commentView source
class CommentManager implements CommentManagerInterface {
use StringTranslationTrait;
use UrlGeneratorTrait;
/**
* The entity manager service.
*
* @var \Drupal\Core\Entity\EntityManagerInterface
*/
protected $entityManager;
/**
* The entity query factory.
*
* @var \Drupal\Core\Entity\Query\QueryFactory
*/
protected $queryFactory;
/**
* Whether the \Drupal\user\RoleInterface::AUTHENTICATED_ID can post comments.
*
* @var bool
*/
protected $authenticatedCanPostComments;
/**
* The user settings config object.
*
* @var \Drupal\Core\Config\Config
*/
protected $userConfig;
/**
* The module handler service.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* Construct the CommentManager object.
*
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* The entity manager service.
* @param \Drupal\Core\Entity\Query\QueryFactory $query_factory
* The entity query factory.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* The string translation service.
* @param \Drupal\Core\Routing\UrlGeneratorInterface $url_generator
* The url generator service.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler service.
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
*/
public function __construct(EntityManagerInterface $entity_manager, QueryFactory $query_factory, ConfigFactoryInterface $config_factory, TranslationInterface $string_translation, UrlGeneratorInterface $url_generator, ModuleHandlerInterface $module_handler, AccountInterface $current_user) {
$this->entityManager = $entity_manager;
$this->queryFactory = $query_factory;
$this->userConfig = $config_factory
->get('user.settings');
$this->stringTranslation = $string_translation;
$this->urlGenerator = $url_generator;
$this->moduleHandler = $module_handler;
$this->currentUser = $current_user;
}
/**
* {@inheritdoc}
*/
public function getFields($entity_type_id) {
$entity_type = $this->entityManager
->getDefinition($entity_type_id);
if (!$entity_type
->isSubclassOf('\\Drupal\\Core\\Entity\\FieldableEntityInterface')) {
return array();
}
$map = $this->entityManager
->getFieldMapByFieldType('comment');
return isset($map[$entity_type_id]) ? $map[$entity_type_id] : array();
}
/**
* {@inheritdoc}
*/
public function addBodyField($comment_type_id) {
if (!FieldConfig::loadByName('comment', $comment_type_id, 'comment_body')) {
// Attaches the body field by default.
$field = $this->entityManager
->getStorage('field_config')
->create(array(
'label' => 'Comment',
'bundle' => $comment_type_id,
'required' => TRUE,
'field_storage' => FieldStorageConfig::loadByName('comment', 'comment_body'),
));
$field
->save();
// Assign widget settings for the 'default' form mode.
entity_get_form_display('comment', $comment_type_id, 'default')
->setComponent('comment_body', array(
'type' => 'text_textarea',
))
->save();
// Assign display settings for the 'default' view mode.
entity_get_display('comment', $comment_type_id, 'default')
->setComponent('comment_body', array(
'label' => 'hidden',
'type' => 'text_default',
'weight' => 0,
))
->save();
}
}
/**
* {@inheritdoc}
*/
public function forbiddenMessage(EntityInterface $entity, $field_name) {
if (!isset($this->authenticatedCanPostComments)) {
// We only output a link if we are certain that users will get the
// permission to post comments by logging in.
$this->authenticatedCanPostComments = $this->entityManager
->getStorage('user_role')
->load(RoleInterface::AUTHENTICATED_ID)
->hasPermission('post comments');
}
if ($this->authenticatedCanPostComments) {
// We cannot use the redirect.destination service here because these links
// sometimes appear on /node and taxonomy listing pages.
if ($entity
->get($field_name)
->getFieldDefinition()
->getSetting('form_location') == CommentItemInterface::FORM_SEPARATE_PAGE) {
$comment_reply_parameters = [
'entity_type' => $entity
->getEntityTypeId(),
'entity' => $entity
->id(),
'field_name' => $field_name,
];
$destination = array(
'destination' => $this
->url('comment.reply', $comment_reply_parameters, array(
'fragment' => 'comment-form',
)),
);
}
else {
$destination = array(
'destination' => $entity
->url('canonical', array(
'fragment' => 'comment-form',
)),
);
}
if ($this->userConfig
->get('register') != USER_REGISTER_ADMINISTRATORS_ONLY) {
// Users can register themselves.
return $this
->t('<a href=":login">Log in</a> or <a href=":register">register</a> to post comments', array(
':login' => $this->urlGenerator
->generateFromRoute('user.login', array(), array(
'query' => $destination,
)),
':register' => $this->urlGenerator
->generateFromRoute('user.register', array(), array(
'query' => $destination,
)),
));
}
else {
// Only admins can add new users, no public registration.
return $this
->t('<a href=":login">Log in</a> to post comments', array(
':login' => $this->urlGenerator
->generateFromRoute('user.login', array(), array(
'query' => $destination,
)),
));
}
}
return '';
}
/**
* {@inheritdoc}
*/
public function getCountNewComments(EntityInterface $entity, $field_name = NULL, $timestamp = 0) {
// @todo Replace module handler with optional history service injection
// after https://www.drupal.org/node/2081585.
if ($this->currentUser
->isAuthenticated() && $this->moduleHandler
->moduleExists('history')) {
// Retrieve the timestamp at which the current user last viewed this entity.
if (!$timestamp) {
if ($entity
->getEntityTypeId() == 'node') {
$timestamp = history_read($entity
->id());
}
else {
$function = $entity
->getEntityTypeId() . '_last_viewed';
if (function_exists($function)) {
$timestamp = $function($entity
->id());
}
else {
// Default to 30 days ago.
// @todo Remove once https://www.drupal.org/node/1029708 lands.
$timestamp = COMMENT_NEW_LIMIT;
}
}
}
$timestamp = $timestamp > HISTORY_READ_LIMIT ? $timestamp : HISTORY_READ_LIMIT;
// Use the timestamp to retrieve the number of new comments.
$query = $this->queryFactory
->get('comment')
->condition('entity_type', $entity
->getEntityTypeId())
->condition('entity_id', $entity
->id())
->condition('created', $timestamp, '>')
->condition('status', CommentInterface::PUBLISHED);
if ($field_name) {
// Limit to a particular field.
$query
->condition('field_name', $field_name);
}
return $query
->count()
->execute();
}
return FALSE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommentManager:: |
protected | property | Whether the \Drupal\user\RoleInterface::AUTHENTICATED_ID can post comments. | |
CommentManager:: |
protected | property | The current user. | |
CommentManager:: |
protected | property | The entity manager service. | |
CommentManager:: |
protected | property | The module handler service. | |
CommentManager:: |
protected | property | The entity query factory. | |
CommentManager:: |
protected | property | The user settings config object. | |
CommentManager:: |
public | function |
Creates a comment_body field. Overrides CommentManagerInterface:: |
|
CommentManager:: |
public | function |
Provides a message if posting comments is forbidden. Overrides CommentManagerInterface:: |
|
CommentManager:: |
public | function |
Returns the number of new comments available on a given entity for a user. Overrides CommentManagerInterface:: |
|
CommentManager:: |
public | function |
Utility function to return an array of comment fields. Overrides CommentManagerInterface:: |
|
CommentManager:: |
public | function | Construct the CommentManager object. | |
CommentManagerInterface:: |
constant | Comments are displayed in a flat list - expanded. | ||
CommentManagerInterface:: |
constant | Comments are displayed as a threaded list - expanded. | ||
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. |