class AuthorNameFormatter

Same name and namespace in other branches

8.9.x core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php \Drupal\comment\Plugin\Field\FieldFormatter\AuthorNameFormatter
10 core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php \Drupal\comment\Plugin\Field\FieldFormatter\AuthorNameFormatter
11.x core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php \Drupal\comment\Plugin\Field\FieldFormatter\AuthorNameFormatter

Plugin implementation of the 'comment_username' formatter.

Plugin annotation


@FieldFormatter(
  id = "comment_username",
  label = @Translation("Author name"),
  description = @Translation("Display the author name."),
  field_types = {
    "string"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\Core\Field\FormatterBase extends \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Field\PluginSettingsBase
      - class \Drupal\comment\Plugin\Field\FieldFormatter\AuthorNameFormatter implements \Drupal\Core\Field\FormatterBase

Expanded class hierarchy of AuthorNameFormatter

File

core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php, line 21

Namespace

Drupal\comment\Plugin\Field\FieldFormatter

View on git.drupalcode.org

View source

class AuthorNameFormatter extends FormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      /** @var \Drupal\comment\CommentInterface $comment */
      $comment = $item->getEntity();
      $account = $comment->getOwner();
      $elements[$delta] = [
        '#theme' => 'username',
        '#account' => $account,
        '#cache' => [
          'tags' => $account->getCacheTags() + $comment->getCacheTags(),
        ],
      ];
    }
    return $elements;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    return $field_definition->getName() === 'name' && $field_definition->getTargetEntityTypeId() === 'comment';
  }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
AuthorNameFormatter::isApplicable	public static	function	Returns if the formatter can be used for the provided field.	Overrides FormatterBase::isApplicable
AuthorNameFormatter::viewElements	public	function	Builds a renderable array for a field value.	Overrides FormatterInterface::viewElements
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function			2
DependencySerializationTrait::__wakeup	public	function	#[\ReturnTypeWillChange]		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::create	public static	function	Creates an instance of the plugin.	Overrides ContainerFactoryPluginInterface::create	13
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed.	Overrides FormatterInterface::prepareView	2
FormatterBase::settingsForm	public	function	Returns a form to configure settings for the formatter.	Overrides FormatterInterface::settingsForm	25
FormatterBase::settingsSummary	public	function	Returns a short summary for the current formatter settings.	Overrides FormatterInterface::settingsSummary	23
FormatterBase::view	public	function	Builds a renderable array for a fully themed field.	Overrides FormatterInterface::view	1
FormatterBase::__construct	public	function	Constructs a FormatterBase object.	Overrides PluginBase::__construct	13
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::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::defaultSettings	public static	function	Defines the default settings for this plugin.	Overrides PluginSettingsInterface::defaultSettings	43
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.		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.

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

Breadcrumb