class LinkSeparateFormatter

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

Plugin implementation of the 'link_separate' formatter.

@todo https://www.drupal.org/node/1829202 Merge into 'link' formatter once there is a #type like 'item' that can render a compound label and content outside of a form context.

Hierarchy

Expanded class hierarchy of LinkSeparateFormatter

File

core/modules/link/src/Plugin/Field/FieldFormatter/LinkSeparateFormatter.php, line 17

Namespace

Drupal\link\Plugin\Field\FieldFormatter
View source
class LinkSeparateFormatter extends LinkFormatter {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'trim_length' => 80,
            'rel' => '',
            'target' => '',
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $element = [];
        $entity = $items->getEntity();
        $settings = $this->getSettings();
        foreach ($items as $delta => $item) {
            // By default use the full URL as the link text.
            $url = $this->buildUrl($item);
            $link_title = $url->toString();
            // If the link text field value is available, use it for the text.
            if (empty($settings['url_only']) && !empty($item->title)) {
                // Unsanitized token replacement here because the entire link title
                // gets auto-escaped during link generation in
                // \Drupal\Core\Utility\LinkGenerator::generate().
                $link_title = \Drupal::token()->replace($item->title, [
                    $entity->getEntityTypeId() => $entity,
                ], [
                    'clear' => TRUE,
                ]);
            }
            // The link_separate formatter has two titles; the link text (as in the
            // field values) and the URL itself. If there is no link text value,
            // $link_title defaults to the URL, so it needs to be unset.
            // The URL version may need to be trimmed as well.
            if (empty($item->title)) {
                $link_title = NULL;
            }
            $url_title = $url->toString();
            if (!empty($settings['trim_length'])) {
                $link_title = $link_title !== NULL ? Unicode::truncate($link_title, $settings['trim_length'], FALSE, TRUE) : NULL;
                $url_title = Unicode::truncate($url_title, $settings['trim_length'], FALSE, TRUE);
            }
            $element[$delta] = [
                '#theme' => 'link_formatter_link_separate',
                '#title' => $link_title,
                '#url_title' => $url_title,
                '#url' => $url,
            ];
            if (!empty($item->_attributes)) {
                // Set our attributes on the <a> element that is being built.
                $url->setOption('attributes', $item->_attributes);
                // Unset field item attributes since they have been included in the
                // formatter output and should not be rendered in the field template.
                unset($item->_attributes);
            }
        }
        return $element;
    }

}

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::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 12
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
LinkFormatter::$pathValidator protected property The path validator service.
LinkFormatter::buildUrl protected function Builds the \Drupal\Core\Url object for a link field item.
LinkFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
LinkFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
LinkFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
LinkFormatter::__construct public function Constructs a new LinkFormatter. Overrides FormatterBase::__construct
LinkSeparateFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides LinkFormatter::defaultSettings
LinkSeparateFormatter::viewElements public function Builds a renderable array for a field value. Overrides LinkFormatter::viewElements
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 Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
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

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