class CommentUserSignature in Display Suite 8.2
Same name and namespace in other branches
- 8.4 src/Plugin/DsField/Comment/CommentUserSignature.php \Drupal\ds\Plugin\DsField\Comment\CommentUserSignature
- 8.3 src/Plugin/DsField/Comment/CommentUserSignature.php \Drupal\ds\Plugin\DsField\Comment\CommentUserSignature
Plugin that renders the user signature of a comment.
Plugin annotation
@DsField(
id = "comment_user_signature",
title = @Translation("User signature"),
entity_type = "comment",
provider = "comment"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\ds\Plugin\DsField\DsFieldBase implements DsFieldInterface
- class \Drupal\ds\Plugin\DsField\Markup
- class \Drupal\ds\Plugin\DsField\User\UserSignature
- class \Drupal\ds\Plugin\DsField\Comment\CommentUserSignature
- class \Drupal\ds\Plugin\DsField\User\UserSignature
- class \Drupal\ds\Plugin\DsField\Markup
- class \Drupal\ds\Plugin\DsField\DsFieldBase implements DsFieldInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of CommentUserSignature
File
- src/
Plugin/ DsField/ Comment/ CommentUserSignature.php, line 18
Namespace
Drupal\ds\Plugin\DsField\CommentView source
class CommentUserSignature extends UserSignature {
/**
* {@inheritdoc}
*/
public function build() {
$comment = $this
->entity();
$user_id = $comment->uid->target_id;
$user = User::load($user_id);
$key = $this
->key();
if (isset($user->{$key}->value)) {
$format = $this
->format();
return array(
'#type' => 'processed_text',
'#text' => $user->{$key}->value,
'#format' => $user->{$format}->value,
'#filter_types_to_skip' => array(),
'#langcode' => '',
);
}
return array();
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommentUserSignature:: |
public | function |
Renders a field. Overrides Markup:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DsFieldBase:: |
public | function |
Gets the current bundle. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
DsFieldBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
7 |
DsFieldBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurablePluginInterface:: |
6 |
DsFieldBase:: |
public | function |
Gets the current entity. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Returns a list of possible formatters for this field. Overrides DsFieldInterface:: |
4 |
DsFieldBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurablePluginInterface:: |
1 |
DsFieldBase:: |
public | function |
Gets the current entity type. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Gets the field configuration. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Gets the field name. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Returns the title of the field. Overrides DsFieldInterface:: |
1 |
DsFieldBase:: |
public | function |
Defines if we are dealing with a multivalue field. Overrides DsFieldInterface:: |
1 |
DsFieldBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface:: |
1 |
DsFieldBase:: |
public | function |
The form that holds the settings for this plugin. Overrides DsFieldInterface:: |
7 |
DsFieldBase:: |
public | function |
Returns the summary of the chosen settings. Overrides DsFieldInterface:: |
6 |
DsFieldBase:: |
public | function |
Gets the view mode. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
8 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UserSignature:: |
public | function |
Gets the text format. Overrides Markup:: |
|
UserSignature:: |
public | function |
Returns if the field is allowed on the field UI screen. Overrides DsFieldBase:: |
|
UserSignature:: |
public | function |
Gets the key of the field that needs to be rendered. Overrides Markup:: |