class StatisticsLastCommentName
Same name in this branch
- 11.x core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php \Drupal\comment\Plugin\views\sort\StatisticsLastCommentName
Same name in other branches
- 9 core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php \Drupal\comment\Plugin\views\sort\StatisticsLastCommentName
- 9 core/modules/comment/src/Plugin/views/field/StatisticsLastCommentName.php \Drupal\comment\Plugin\views\field\StatisticsLastCommentName
- 8.9.x core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php \Drupal\comment\Plugin\views\sort\StatisticsLastCommentName
- 8.9.x core/modules/comment/src/Plugin/views/field/StatisticsLastCommentName.php \Drupal\comment\Plugin\views\field\StatisticsLastCommentName
- 10 core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php \Drupal\comment\Plugin\views\sort\StatisticsLastCommentName
- 10 core/modules/comment/src/Plugin/views/field/StatisticsLastCommentName.php \Drupal\comment\Plugin\views\field\StatisticsLastCommentName
Field handler to present the name of the last comment poster.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\field\FieldPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\views\Plugin\views\field\FieldHandlerInterface
- class \Drupal\comment\Plugin\views\field\StatisticsLastCommentName extends \Drupal\views\Plugin\views\field\FieldPluginBase
- class \Drupal\views\Plugin\views\field\FieldPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\views\Plugin\views\field\FieldHandlerInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of StatisticsLastCommentName
Related topics
File
-
core/
modules/ comment/ src/ Plugin/ views/ field/ StatisticsLastCommentName.php, line 15
Namespace
Drupal\comment\Plugin\views\fieldView source
class StatisticsLastCommentName extends FieldPluginBase {
/**
* The users table.
*/
// phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
protected ?string $user_table;
/**
* The user name field.
*/
// phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
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));
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
FieldPluginBase::$additional_fields | public | property | |||
FieldPluginBase::$aliases | public | property | |||
FieldPluginBase::$field_alias | public | property | |||
FieldPluginBase::$lastRenderIndex | protected | property | Keeps track of the last render index. | ||
FieldPluginBase::$last_render | public | property | |||
FieldPluginBase::$last_render_text | public | property | |||
FieldPluginBase::$last_tokens | public | property | |||
FieldPluginBase::$linkGenerator | protected | property | The link generator. | ||
FieldPluginBase::$original_value | public | property | |||
FieldPluginBase::$renderer | protected | property | Stores the render API renderer. | Overrides PluginBase::$renderer | 1 |
FieldPluginBase::addAdditionalFields | protected | function | Add 'additional' fields to the query. | ||
FieldPluginBase::addSelfTokens | protected | function | Add any special tokens this field might use for itself. | 4 | |
FieldPluginBase::adminLabel | public | function | Return a string representing this handler's name in the UI. | Overrides HandlerBase::adminLabel | |
FieldPluginBase::adminSummary | public | function | Provide extra data to the administration form. | Overrides HandlerBase::adminSummary | |
FieldPluginBase::advancedRender | public | function | Renders a field using advanced settings. | Overrides FieldHandlerInterface::advancedRender | |
FieldPluginBase::allowAdvancedRender | protected | function | Determine if this field can allow advanced rendering. | ||
FieldPluginBase::buildOptionsForm | public | function | Default option form that provides label widget that all fields should have. | Overrides HandlerBase::buildOptionsForm | 25 |
FieldPluginBase::clickSort | public | function | Adds an ORDER BY clause to the query for click sort columns. | Overrides FieldHandlerInterface::clickSort | 1 |
FieldPluginBase::clickSortable | public | function | Determines if this field is click sortable. | Overrides FieldHandlerInterface::clickSortable | 5 |
FieldPluginBase::documentSelfTokens | protected | function | Document any special tokens this field might use for itself. | 3 | |
FieldPluginBase::elementClasses | public | function | Returns the class of the field. | Overrides FieldHandlerInterface::elementClasses | |
FieldPluginBase::elementLabelClasses | public | function | Returns the class of the field's label. | Overrides FieldHandlerInterface::elementLabelClasses | |
FieldPluginBase::elementLabelType | public | function | Returns an HTML element for the label based upon the field's element type. | Overrides FieldHandlerInterface::elementLabelType | |
FieldPluginBase::elementType | public | function | Returns an HTML element based upon the field's element type. | Overrides FieldHandlerInterface::elementType | 1 |
FieldPluginBase::elementWrapperClasses | public | function | Returns the class of the field's wrapper. | Overrides FieldHandlerInterface::elementWrapperClasses | |
FieldPluginBase::elementWrapperType | public | function | Returns a wrapper HTML element for the field.. | Overrides FieldHandlerInterface::elementWrapperType | |
FieldPluginBase::getElements | public | function | Provides a list of elements valid for field HTML. | Overrides FieldHandlerInterface::getElements | |
FieldPluginBase::getEntity | public | function | Gets the entity matching the current row and relationship. | Overrides FieldHandlerInterface::getEntity | |
FieldPluginBase::getFieldTokenPlaceholder | protected | function | Returns a token placeholder for the current field. | ||
FieldPluginBase::getPreviousFieldLabels | protected | function | Returns all field labels of fields before this field. | ||
FieldPluginBase::getRenderer | protected | function | Returns the render API renderer. | Overrides PluginBase::getRenderer | |
FieldPluginBase::getRenderTokens | public | function | Gets the 'render' tokens to use for advanced rendering. | Overrides FieldHandlerInterface::getRenderTokens | |
FieldPluginBase::getTokenValuesRecursive | protected | function | Recursive function to add replacements for nested query string parameters. | ||
FieldPluginBase::getValue | public | function | Gets the value that's supposed to be rendered. | Overrides FieldHandlerInterface::getValue | 2 |
FieldPluginBase::init | public | function | Initialize the plugin. | Overrides HandlerBase::init | 13 |
FieldPluginBase::isValueEmpty | public | function | Checks if a field value is empty. | Overrides FieldHandlerInterface::isValueEmpty | |
FieldPluginBase::label | public | function | Gets this field's label. | Overrides FieldHandlerInterface::label | |
FieldPluginBase::linkGenerator | protected | function | Gets the link generator. | ||
FieldPluginBase::postRender | public | function | Runs after every field has been rendered. | Overrides FieldHandlerInterface::postRender | |
FieldPluginBase::preRender | public | function | Runs before any fields are rendered. | Overrides FieldHandlerInterface::preRender | 10 |
FieldPluginBase::renderAltered | protected | function | Render this field as user-defined altered text. | ||
FieldPluginBase::renderAsLink | protected | function | Render this field as a link, with the info from a fieldset set by the user. | ||
FieldPluginBase::renderText | public | function | Performs an advanced text render for the item. | Overrides FieldHandlerInterface::renderText | |
FieldPluginBase::renderTrimText | protected | function | Trims the field down to the specified length. | ||
FieldPluginBase::RENDER_TEXT_PHASE_COMPLETELY | constant | Indicator of the renderText() method for rendering the whole element. | |||
FieldPluginBase::RENDER_TEXT_PHASE_EMPTY | constant | Indicator of the renderText() method for rendering the empty text. | |||
FieldPluginBase::RENDER_TEXT_PHASE_SINGLE_ITEM | constant | Indicator of the renderText() method for rendering a single item. | |||
FieldPluginBase::submitOptionsForm | public | function | Performs some cleanup tasks on the options array before saving it. | Overrides PluginBase::submitOptionsForm | 1 |
FieldPluginBase::theme | public | function | Renders row values using $this->themeFunctions() as #theme. | Overrides FieldHandlerInterface::theme | |
FieldPluginBase::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides PluginBase::themeFunctions | |
FieldPluginBase::tokenizeValue | public | function | Replaces a value with tokens from the last field. | Overrides FieldHandlerInterface::tokenizeValue | |
FieldPluginBase::trimText | public static | function | Trims the field down to the specified length. | ||
FieldPluginBase::useStringGroupBy | public | function | Determines if this field can be grouped in the results. | Overrides FieldHandlerInterface::useStringGroupBy | |
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | ||
HandlerBase::$is_handler | public | property | |||
HandlerBase::$moduleHandler | protected | property | The module handler. | 2 | |
HandlerBase::$query | public | property | Where the $query object will reside. | 7 | |
HandlerBase::$realField | public | property | The real field. | ||
HandlerBase::$relationship | public | property | The relationship used for this field. | ||
HandlerBase::$table | public | property | The table this handler is attached to. | ||
HandlerBase::$tableAlias | public | property | The alias of the table of this handler which is used in the query. | ||
HandlerBase::$viewsData | protected | property | The views data service. | ||
HandlerBase::acceptExposedInput | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | |
HandlerBase::access | public | function | Check whether given user has access to this handler. | Overrides ViewsHandlerInterface::access | 5 |
HandlerBase::breakString | public static | function | Breaks x,y,z and x+y+z into an array. | Overrides ViewsHandlerInterface::breakString | |
HandlerBase::broken | public | function | Determines if the handler is considered 'broken'. | Overrides ViewsHandlerInterface::broken | |
HandlerBase::buildExposedForm | public | function | Render our chunk of the exposed handler form when selecting. | 1 | |
HandlerBase::buildExposeForm | public | function | Form for exposed handler options. | 2 | |
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 2 | |
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | |
HandlerBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides PluginBase::calculateDependencies | 11 |
HandlerBase::canExpose | public | function | Determine if a handler can be exposed. | 2 | |
HandlerBase::caseTransform | protected | function | Transform a string by a certain method. | ||
HandlerBase::defaultExposeOptions | public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 | |
HandlerBase::defineExtraOptions | public | function | Provide defaults for the handler. | ||
HandlerBase::displayExposedForm | public | function | Displays the Expose form. | ||
HandlerBase::ensureMyTable | public | function | Ensures that the main table for this handler is in the query. | Overrides ViewsHandlerInterface::ensureMyTable | 2 |
HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | |
HandlerBase::getDateField | public | function | Creates cross-database SQL dates. | 2 | |
HandlerBase::getDateFormat | public | function | Creates cross-database SQL date formatting. | 2 | |
HandlerBase::getEntityType | public | function | Determines the entity type used by this handler. | Overrides ViewsHandlerInterface::getEntityType | |
HandlerBase::getField | public | function | Shortcut to get a handler's raw field value. | Overrides ViewsHandlerInterface::getField | |
HandlerBase::getJoin | public | function | Get the join object that should be used for this handler. | Overrides ViewsHandlerInterface::getJoin | |
HandlerBase::getModuleHandler | protected | function | Gets the module handler. | ||
HandlerBase::getTableJoin | public static | function | Fetches a handler to join one table to a primary table from the data cache. | Overrides ViewsHandlerInterface::getTableJoin | |
HandlerBase::getViewsData | protected | function | Gets views data service. | ||
HandlerBase::hasExtraOptions | public | function | Determines if the handler has extra options. | 2 | |
HandlerBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | |
HandlerBase::isExposed | public | function | Determine if this item is 'exposed'. | ||
HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. | 1 | |
HandlerBase::placeholder | protected | function | Provides a unique placeholders for handlers. | ||
HandlerBase::postExecute | public | function | Run after the view is executed, before the result is cached. | Overrides ViewsHandlerInterface::postExecute | |
HandlerBase::preQuery | public | function | Run before the view is built. | Overrides ViewsHandlerInterface::preQuery | 2 |
HandlerBase::sanitizeValue | public | function | Sanitize the value for output. | Overrides ViewsHandlerInterface::sanitizeValue | |
HandlerBase::setModuleHandler | public | function | Sets the module handler. | ||
HandlerBase::setRelationship | public | function | Sets up any needed relationship. | Overrides ViewsHandlerInterface::setRelationship | |
HandlerBase::setViewsData | public | function | |||
HandlerBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | 2 | |
HandlerBase::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | |
HandlerBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | 1 | |
HandlerBase::submitExposed | public | function | Submit the exposed handler form. | ||
HandlerBase::submitExposeForm | public | function | Perform any necessary changes to the form exposes prior to storage. | ||
HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | |
HandlerBase::submitFormCalculateOptions | public | function | Calculates options stored on the handler. | 1 | |
HandlerBase::submitGroupByForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | |
HandlerBase::submitTemporaryForm | public | function | Submits a temporary form. | ||
HandlerBase::usesGroupBy | public | function | Provides the handler some groupby. | 13 | |
HandlerBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | 2 |
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 5 | |
HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | |
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | 1 | |
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 43 |
PluginBase::$definition | public | property | Plugins' definition. | ||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | ||
PluginBase::$options | public | property | Options for this plugin will be held here. | ||
PluginBase::$position | public | property | The handler position. | ||
PluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | 8 | |
PluginBase::$view | public | property | The top object of a view. | 1 | |
PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 61 |
PluginBase::destroy | public | function | Clears a plugin. | Overrides ViewsPluginInterface::destroy | 2 |
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | ||
PluginBase::filterByDefinedOptions | public | function | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | |
PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |
PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | |
PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | |
PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | Overrides ViewsPluginInterface::globalTokenReplace | |
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | |||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | |||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | ||
PluginBase::pluginTitle | public | function | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | |
PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |
PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | Overrides ViewsPluginInterface::preRenderFlattenData | |
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | ||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | ||
PluginBase::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 |
PluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides TrustedCallbackInterface::trustedCallbacks | 6 |
PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | |
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 |
PluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides ViewsPluginInterface::validateOptionsForm | 15 |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | |
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | |||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
StatisticsLastCommentName::$uid | public | property | The user id. | ||
StatisticsLastCommentName::$user_field | protected | property | |||
StatisticsLastCommentName::$user_table | protected | property | |||
StatisticsLastCommentName::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides FieldPluginBase::defineOptions | |
StatisticsLastCommentName::query | public | function | Called to add the field to a query. | Overrides FieldPluginBase::query | |
StatisticsLastCommentName::render | public | function | Renders the field. | Overrides FieldPluginBase::render | |
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.