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.

Plugin annotation

@FieldFormatter(
  id = "comment_permalink",
  label = @Translation("Comment Permalink"),
  field_types = {
    "string",
    "uri",
  },
  quickedit = {
    "editor" = "plain_text"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \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 extends \Drupal\Component\Plugin\PluginBase
    • class \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface extends \Drupal\Core\Plugin\PluginBase
      • class \Drupal\Core\Field\FormatterBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Field\PluginSettingsBase
        • class \Drupal\Core\Field\Plugin\Field\FieldFormatter\StringFormatter extends \Drupal\Core\Field\FormatterBase
          • class \Drupal\comment\Plugin\Field\FieldFormatter\CommentPermalinkFormatter extends \Drupal\Core\Field\Plugin\Field\FieldFormatter\StringFormatter

Expanded class hierarchy of CommentPermalinkFormatter

File

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

Namespace

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