StatisticsLastCommentName.php

Same filename in this branch
  1. 10 core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php
Same filename in other branches
  1. 9 core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php
  2. 9 core/modules/comment/src/Plugin/views/field/StatisticsLastCommentName.php
  3. 8.9.x core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php
  4. 8.9.x core/modules/comment/src/Plugin/views/field/StatisticsLastCommentName.php
  5. 11.x core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php
  6. 11.x core/modules/comment/src/Plugin/views/field/StatisticsLastCommentName.php

Namespace

Drupal\comment\Plugin\views\field

File

core/modules/comment/src/Plugin/views/field/StatisticsLastCommentName.php

View source
<?php

namespace Drupal\comment\Plugin\views\field;

use Drupal\user\Entity\User;
use Drupal\views\Attribute\ViewsField;
use Drupal\views\Plugin\views\field\FieldPluginBase;
use Drupal\views\ResultRow;

/**
 * Field handler to present the name of the last comment poster.
 *
 * @ingroup views_field_handlers
 */
class StatisticsLastCommentName extends FieldPluginBase {
    
    /**
     * The users table.
     */
    // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
    protected ?string $user_table;
    
    /**
     * The user name field.
     */
    // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
    protected string $user_field;
    
    /**
     * The user id.
     */
    public string $uid;
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        // last_comment_name only contains data if the user is anonymous. So we
        // have to join in a specially related user table.
        $this->ensureMyTable();
        // Join 'users' to this table via vid
        $definition = [
            'table' => 'users_field_data',
            'field' => 'uid',
            'left_table' => 'comment_entity_statistics',
            'left_field' => 'last_comment_uid',
            'extra' => [
                [
                    'field' => 'uid',
                    'operator' => '!=',
                    'value' => '0',
                ],
            ],
        ];
        $join = \Drupal::service('plugin.manager.views.join')->createInstance('standard', $definition);
        // nes_user alias so this can work with the sort handler, below.
        $this->user_table = $this->query
            ->ensureTable('ces_users', $this->relationship, $join);
        $this->field_alias = $this->query
            ->addField(NULL, "COALESCE({$this->user_table}.name, {$this->tableAlias}.{$this->field})", $this->tableAlias . '_' . $this->field);
        $this->user_field = $this->query
            ->addField($this->user_table, 'name');
        $this->uid = $this->query
            ->addField($this->tableAlias, 'last_comment_uid');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['link_to_user'] = [
            'default' => TRUE,
        ];
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function render(ResultRow $values) {
        if (!empty($this->options['link_to_user'])) {
            $account = User::create();
            $account->name = $this->getValue($values);
            $account->uid = $values->{$this->uid};
            $username = [
                '#theme' => 'username',
                '#account' => $account,
            ];
            return \Drupal::service('renderer')->render($username);
        }
        else {
            return $this->sanitizeValue($this->getValue($values));
        }
    }

}

Classes

Title Deprecated Summary
StatisticsLastCommentName Field handler to present the name of the last comment poster.

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