class CommentPermalinkFormatter

Plugin implementation of the 'comment_permalink' formatter.

All the other entities use 'canonical' or 'revision' links to link the entity to itself but comments use permalink URL.

Attributes

#[FieldFormatter(id: 'comment_permalink', label: new TranslatableMarkup('Comment Permalink'), field_types: [ 'string', 'uri', ])]

Hierarchy

Expanded class hierarchy of CommentPermalinkFormatter

File

View on git.drupalcode.org

core/modules/comment/src/Plugin/Field/FieldFormatter/CommentPermalinkFormatter.php, line 18

Namespace

Drupal\comment\Plugin\Field\FieldFormatter
View source 
class CommentPermalinkFormatter extends StringFormatter {
  
  /**
   * {@inheritdoc}
   */
  protected function getEntityUrl(EntityInterface $comment) {
    /** @var \Drupal\comment\CommentInterface $comment */
    $comment_permalink = $comment->permalink();
    if ($comment->hasField('comment_body') && $body = $comment->get('comment_body')->value) {
      $attributes = $comment_permalink->getOption('attributes') ?: [];
      $attributes += [
        'title' => Unicode::truncate($body, 128),
      ];
      $comment_permalink->setOption('attributes', $attributes);
    }
    return $comment_permalink;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    return parent::isApplicable($field_definition) && $field_definition->getTargetEntityTypeId() === 'comment' && $field_definition->getName() === 'subject';
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
CommentPermalinkFormatter::getEntityUrl protected function Overrides StringFormatter::getEntityUrl
CommentPermalinkFormatter::isApplicable public static function Overrides FormatterBase::isApplicable
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::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::prepareView public function Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Overrides FormatterInterface::view 1
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
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 Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function 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 Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringFormatter::$entityTypeManager protected property The entity type manager.
StringFormatter::create public static function Overrides FormatterBase::create 1
StringFormatter::defaultSettings public static function Overrides PluginSettingsBase::defaultSettings 1
StringFormatter::settingsForm public function Overrides FormatterBase::settingsForm 1
StringFormatter::settingsSummary public function Overrides FormatterBase::settingsSummary 1
StringFormatter::viewElements public function Overrides FormatterInterface::viewElements
StringFormatter::viewValue protected function Generate the output appropriate for one field item. 1
StringFormatter::__construct public function Constructs a StringFormatter instance. Overrides FormatterBase::__construct 1
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.