class UnapprovedComments

Same name in other branches
  1. 9 core/modules/comment/src/Plugin/Menu/LocalTask/UnapprovedComments.php \Drupal\comment\Plugin\Menu\LocalTask\UnapprovedComments
  2. 8.9.x core/modules/comment/src/Plugin/Menu/LocalTask/UnapprovedComments.php \Drupal\comment\Plugin\Menu\LocalTask\UnapprovedComments
  3. 10 core/modules/comment/src/Plugin/Menu/LocalTask/UnapprovedComments.php \Drupal\comment\Plugin\Menu\LocalTask\UnapprovedComments

Provides a local task that shows the amount of unapproved comments.

Hierarchy

Expanded class hierarchy of UnapprovedComments

1 string reference to 'UnapprovedComments'
comment.links.task.yml in core/modules/comment/comment.links.task.yml
core/modules/comment/comment.links.task.yml

File

core/modules/comment/src/Plugin/Menu/LocalTask/UnapprovedComments.php, line 15

Namespace

Drupal\comment\Plugin\Menu\LocalTask
View source
class UnapprovedComments extends LocalTaskDefault implements ContainerFactoryPluginInterface {
    use StringTranslationTrait;
    
    /**
     * The comment storage service.
     *
     * @var \Drupal\comment\CommentStorageInterface
     */
    protected $commentStorage;
    
    /**
     * Construct the UnapprovedComments object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param array $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\comment\CommentStorageInterface $comment_storage
     *   The comment storage service.
     */
    public function __construct(array $configuration, $plugin_id, array $plugin_definition, CommentStorageInterface $comment_storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->commentStorage = $comment_storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager')
            ->getStorage('comment'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTitle(?Request $request = NULL) {
        return $this->t('Unapproved comments (@count)', [
            '@count' => $this->commentStorage
                ->getUnapprovedCount(),
        ]);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
LocalTaskDefault::$active protected property TRUE if this plugin is forced active for options attributes.
LocalTaskDefault::$routeProvider protected property The route provider to load routes by name.
LocalTaskDefault::getActive public function Gets the active status. Overrides LocalTaskInterface::getActive
LocalTaskDefault::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
LocalTaskDefault::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
LocalTaskDefault::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 1
LocalTaskDefault::getOptions public function Returns options for rendering a link to the local task. Overrides LocalTaskInterface::getOptions
LocalTaskDefault::getRouteName public function Get the route name from the settings. Overrides LocalTaskInterface::getRouteName
LocalTaskDefault::getRouteParameters public function Returns the route parameters needed to render a link for the local task. Overrides LocalTaskInterface::getRouteParameters 1
LocalTaskDefault::getWeight public function Returns the weight of the local task. Overrides LocalTaskInterface::getWeight
LocalTaskDefault::routeProvider protected function Returns the route provider.
LocalTaskDefault::setActive public function Sets the active status. Overrides LocalTaskInterface::setActive
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin ID.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UnapprovedComments::$commentStorage protected property The comment storage service.
UnapprovedComments::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UnapprovedComments::getTitle public function Returns the localized title to be shown for this tab. Overrides LocalTaskDefault::getTitle
UnapprovedComments::__construct public function Construct the UnapprovedComments object. Overrides PluginBase::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.