class UserNameFormatter

Same name in other branches
  1. 9 core/modules/user/src/Plugin/Field/FieldFormatter/UserNameFormatter.php \Drupal\user\Plugin\Field\FieldFormatter\UserNameFormatter
  2. 8.9.x core/modules/user/src/Plugin/Field/FieldFormatter/UserNameFormatter.php \Drupal\user\Plugin\Field\FieldFormatter\UserNameFormatter
  3. 11.x core/modules/user/src/Plugin/Field/FieldFormatter/UserNameFormatter.php \Drupal\user\Plugin\Field\FieldFormatter\UserNameFormatter

Plugin implementation of the 'user_name' formatter.

Hierarchy

Expanded class hierarchy of UserNameFormatter

File

core/modules/user/src/Plugin/Field/FieldFormatter/UserNameFormatter.php, line 15

Namespace

Drupal\user\Plugin\Field\FieldFormatter
View source
class UserNameFormatter extends FormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        $options = parent::defaultSettings();
        $options['link_to_entity'] = TRUE;
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $form = parent::settingsForm($form, $form_state);
        $form['link_to_entity'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Link to the user'),
            '#default_value' => $this->getSetting('link_to_entity'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        foreach ($items as $delta => $item) {
            
            /** @var \Drupal\user\UserInterface $user */
            if ($user = $item->getEntity()) {
                if ($this->getSetting('link_to_entity')) {
                    $elements[$delta] = [
                        '#theme' => 'username',
                        '#account' => $user,
                        '#link_options' => [
                            'attributes' => [
                                'rel' => 'user',
                            ],
                        ],
                        '#cache' => [
                            'tags' => $user->getCacheTags(),
                        ],
                    ];
                }
                else {
                    $elements[$delta] = [
                        '#markup' => $user->getDisplayName(),
                        '#cache' => [
                            'tags' => $user->getCacheTags(),
                        ],
                    ];
                }
            }
        }
        return $elements;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function isApplicable(FieldDefinitionInterface $field_definition) {
        return $field_definition->getTargetEntityTypeId() === 'user' && $field_definition->getName() === 'name';
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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 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 Overrides FormatterInterface::prepareView 2
FormatterBase::settingsSummary public function Overrides FormatterInterface::settingsSummary 23
FormatterBase::view public function Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. 13
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
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
UserNameFormatter::defaultSettings public static function Overrides PluginSettingsBase::defaultSettings
UserNameFormatter::isApplicable public static function Overrides FormatterBase::isApplicable
UserNameFormatter::settingsForm public function Overrides FormatterBase::settingsForm
UserNameFormatter::viewElements public function Overrides FormatterInterface::viewElements

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