CommentController
class CommentController extends ControllerBase (View source)
Controller for the comment entity.
Traits
Wrapper methods for the Link Generator.
Wrapper methods for the logger factory service.
Provides a trait for the messenger service.
Wrapper methods for the Redirect Destination.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Wrapper methods for the Url Generator.
Properties
| protected LinkGeneratorInterface | $linkGenerator | The link generator. |
from LinkGeneratorTrait |
| protected LoggerChannelFactoryInterface | $loggerFactory | The logger channel factory service. |
from LoggerChannelTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected RedirectDestinationInterface | $redirectDestination | The redirect destination service. |
from RedirectDestinationTrait |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected UrlGeneratorInterface | $urlGenerator | The url generator. |
from UrlGeneratorTrait |
| protected EntityManagerInterface | $entityManager | The entity manager. |
from ControllerBase |
| protected EntityTypeManagerInterface | $entityTypeManager | The entity type manager. |
from ControllerBase |
| protected EntityFormBuilderInterface | $entityFormBuilder | The entity form builder. |
from ControllerBase |
| protected LanguageManagerInterface | $languageManager | The language manager. |
from ControllerBase |
| protected ConfigFactoryInterface | $configFactory | The configuration factory. |
from ControllerBase |
| protected KeyValueStoreInterface | $keyValue | The key-value storage. |
from ControllerBase |
| protected AccountInterface | $currentUser | The current user service. |
from ControllerBase |
| protected StateInterface | $stateService | The state service. |
from ControllerBase |
| protected ModuleHandlerInterface | $moduleHandler | The module handler. |
from ControllerBase |
| protected FormBuilderInterface | $formBuilder | The form builder. |
from ControllerBase |
| protected HttpKernelInterface | $httpKernel | The HTTP kernel. |
|
| protected CommentManagerInterface | $commentManager | The comment manager service. |
|
| protected EntityFieldManagerInterface | $entityFieldManager | The entity field manager. |
|
| protected EntityRepositoryInterface | $entityRepository | The entity repository. |
Methods
Gets the logger for a specific channel.
Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
Returns the redirect destination service.
Sets the redirect destination service.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Generates a URL or path for a specific route based on the given parameters.
Returns a redirect response object for the specified route.
Instantiates a new instance of this class.
Retrieves the entity type manager.
Retrieves the entity form builder.
Returns the requested cache bin.
Returns a key/value storage collection.
Returns the language manager service.
Constructs a CommentController object.
Redirects comment links to the correct page depending on comment settings.
The _title_callback for the page that renders the comment permalink.
Form constructor for the comment reply form.
Access check for the reply form.
Returns a set of nodes' last read timestamps.
Details
protected GeneratedLink
l($text, Url $url)
deprecated
deprecated
Renders a link to a route given a route name and its parameters.
For details on the arguments, usage, and possible exceptions see \Drupal\Core\Utility\LinkGeneratorInterface::generate().
protected LinkGeneratorInterface
getLinkGenerator()
deprecated
deprecated
Returns the link generator.
$this
setLinkGenerator(LinkGeneratorInterface $generator)
deprecated
deprecated
Sets the link generator service.
protected LoggerInterface
getLogger(string $channel)
Gets the logger for a specific channel.
$this
setLoggerFactory(LoggerChannelFactoryInterface $logger_factory)
Injects the logger channel factory.
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
protected array
getDestinationArray()
Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
protected RedirectDestinationInterface
getRedirectDestination()
Returns the redirect destination service.
$this
setRedirectDestination(RedirectDestinationInterface $redirect_destination)
Sets the redirect destination service.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
protected string
url($route_name, $route_parameters = [], $options = [])
deprecated
deprecated
Generates a URL or path for a specific route based on the given parameters.
For details on the arguments, usage, and possible exceptions see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute().
protected RedirectResponse
redirect(string $route_name, array $route_parameters = [], array $options = [], int $status = 302)
deprecated
deprecated
Returns a redirect response object for the specified route.
protected UrlGeneratorInterface
getUrlGenerator()
deprecated
deprecated
Returns the URL generator service.
$this
setUrlGenerator(UrlGeneratorInterface $generator)
deprecated
deprecated
Sets the URL generator service.
static
create(ContainerInterface $container)
Instantiates a new instance of this class.
This is a factory method that returns a new instance of this class. The factory should pass any needed dependencies into the constructor of this class, but not the container itself. Every call to this method must return a new instance of this class; that is, it may not implement a singleton.
protected EntityManagerInterface
entityManager()
deprecated
deprecated
Retrieves the entity manager service.
protected EntityTypeManagerInterface
entityTypeManager()
Retrieves the entity type manager.
protected EntityFormBuilderInterface
entityFormBuilder()
Retrieves the entity form builder.
protected CacheBackendInterface
cache(string $bin = 'default')
Returns the requested cache bin.
protected Config
config(string $name)
Retrieves a configuration object.
This is the main entry point to the configuration API. Calling
protected KeyValueStoreInterface
keyValue(string $collection)
Returns a key/value storage collection.
protected StateInterface
state()
Returns the state storage service.
Use this to store machine-generated data, local to a specific environment that does not need deploying and does not need human editing; for example, the last time cron was run. Data which needs to be edited by humans and needs to be the same across development, production, etc. environments (for example, the system maintenance message) should use config() instead.
protected ModuleHandlerInterface
moduleHandler()
Returns the module handler.
protected FormBuilderInterface
formBuilder()
Returns the form builder service.
protected AccountInterface
currentUser()
Returns the current user.
protected LanguageManagerInterface
languageManager()
Returns the language manager service.
__construct(HttpKernelInterface $http_kernel, CommentManagerInterface $comment_manager, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager = NULL, EntityRepositoryInterface $entity_repository = NULL)
Constructs a CommentController object.
RedirectResponse
commentApprove(CommentInterface $comment)
Publishes the specified comment.
Response
commentPermalink(Request $request, CommentInterface $comment)
Redirects comment links to the correct page depending on comment settings.
Since comments are paged there is no way to guarantee which page a comment appears on. Comment paging and threading settings may be changed at any time. With threaded comments, an individual comment may move between pages as comments can be added either before or after it in the overall discussion. Therefore we use a central routing function for comment links, which calculates the page number based on current comment settings and returns the full comment view with the pager set dynamically.
string
commentPermalinkTitle(CommentInterface $comment)
The _title_callback for the page that renders the comment permalink.
RedirectResponse
redirectNode(EntityInterface $node)
Redirects legacy node links to the new path.
array|RedirectResponse
getReplyForm(Request $request, EntityInterface $entity, string $field_name, int $pid = NULL)
Form constructor for the comment reply form.
There are several cases that have to be handled, including:
- replies to comments
- replies to entities
AccessResultInterface
replyFormAccess(EntityInterface $entity, string $field_name, int $pid = NULL)
Access check for the reply form.
JsonResponse
renderNewCommentsNodeLinks(Request $request)
Returns a set of nodes' last read timestamps.