You are here

class CommentPostActivityFormatter in Open Social 10.2.x

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_post/src/Plugin/Field/FieldFormatter/CommentPostActivityFormatter.php \Drupal\social_post\Plugin\Field\FieldFormatter\CommentPostActivityFormatter
  2. 8.6 modules/social_features/social_post/src/Plugin/Field/FieldFormatter/CommentPostActivityFormatter.php \Drupal\social_post\Plugin\Field\FieldFormatter\CommentPostActivityFormatter
  3. 8.7 modules/social_features/social_post/src/Plugin/Field/FieldFormatter/CommentPostActivityFormatter.php \Drupal\social_post\Plugin\Field\FieldFormatter\CommentPostActivityFormatter
  4. 8.8 modules/social_features/social_post/src/Plugin/Field/FieldFormatter/CommentPostActivityFormatter.php \Drupal\social_post\Plugin\Field\FieldFormatter\CommentPostActivityFormatter
  5. 10.3.x modules/social_features/social_post/src/Plugin/Field/FieldFormatter/CommentPostActivityFormatter.php \Drupal\social_post\Plugin\Field\FieldFormatter\CommentPostActivityFormatter
  6. 10.0.x modules/social_features/social_post/src/Plugin/Field/FieldFormatter/CommentPostActivityFormatter.php \Drupal\social_post\Plugin\Field\FieldFormatter\CommentPostActivityFormatter
  7. 10.1.x modules/social_features/social_post/src/Plugin/Field/FieldFormatter/CommentPostActivityFormatter.php \Drupal\social_post\Plugin\Field\FieldFormatter\CommentPostActivityFormatter

Provides a post comment activity formatter.

Plugin annotation


@FieldFormatter(
  id = "comment_post_activity",
  module = "social_post",
  label = @Translation("Last two comments on post"),
  field_types = {
    "comment"
  },
  quickedit = {
    "editor" = "disabled"
  }
)

Hierarchy

Expanded class hierarchy of CommentPostActivityFormatter

File

modules/social_features/social_post/src/Plugin/Field/FieldFormatter/CommentPostActivityFormatter.php, line 23

Namespace

Drupal\social_post\Plugin\Field\FieldFormatter
View source
class CommentPostActivityFormatter extends CommentPostFormatter {

  /**
   * {@inheritdoc}
   *
   * @see Drupal\comment\CommentStorage::loadThead()
   */
  public function loadThread(EntityInterface $entity, $field_name, $mode, $comments_per_page = 0, $pager_id = 0) {

    // @todo Refactor this to use CommentDefaultFormatter->loadThread with dependency injection instead.
    $query = \Drupal::database()
      ->select('comment_field_data', 'c');
    $query
      ->addField('c', 'cid');
    $query
      ->condition('c.entity_id', $entity
      ->id())
      ->condition('c.entity_type', $entity
      ->getEntityTypeId())
      ->condition('c.field_name', $field_name)
      ->condition('c.default_langcode', 1)
      ->addTag('entity_access')
      ->addTag('comment_filter')
      ->addMetaData('base_table', 'comment')
      ->addMetaData('entity', $entity)
      ->addMetaData('field_name', $field_name);
    if (!$this->currentUser
      ->hasPermission('administer comments')) {
      $query
        ->condition('c.status', CommentInterface::PUBLISHED);
    }
    $query
      ->orderBy('c.cid', 'DESC');

    // Limit The number of results.
    if ($comments_per_page) {
      $query
        ->range(0, $comments_per_page);
    }
    $cids = $query
      ->execute()
      ->fetchCol();
    $comments = [];
    if ($cids) {
      krsort($cids);
      $comments = $this->storage
        ->loadMultiple($cids);
    }
    return $comments;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommentDefaultFormatter::$currentUser protected property The current user.
CommentDefaultFormatter::$entityDisplayRepository protected property The entity display repository.
CommentDefaultFormatter::$entityFormBuilder protected property The entity form builder.
CommentDefaultFormatter::$routeMatch protected property
CommentDefaultFormatter::$storage protected property The comment storage.
CommentDefaultFormatter::$viewBuilder protected property The comment render controller.
CommentDefaultFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
CommentDefaultFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
CommentDefaultFormatter::getViewModes protected function Provides a list of comment view modes for the configured comment type.
CommentDefaultFormatter::__construct public function Constructs a new CommentDefaultFormatter. Overrides FormatterBase::__construct
CommentPostActivityFormatter::loadThread public function Overrides CommentPostFormatter::loadThread
CommentPostFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides CommentDefaultFormatter::defaultSettings
CommentPostFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides CommentDefaultFormatter::settingsForm
CommentPostFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides CommentDefaultFormatter::settingsSummary
CommentPostFormatter::viewElements public function Builds a renderable array for a field value. Overrides CommentDefaultFormatter::viewElements
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
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 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.