View source
<?php
namespace Drupal\formatter_suite\Plugin\Field\FieldFormatter;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FormatterBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Xss;
use Drupal\link\LinkItemInterface;
use Drupal\Core\Url;
use Drupal\formatter_suite\Branding;
class GeneralLinkFormatter extends FormatterBase {
protected static function getTitleStyles() {
return [
'text_from_link' => t("Use the link field's title"),
'text_from_url' => t("Use the link field's URL"),
'text_custom' => t('Use custom text'),
];
}
protected static function getTitleStylesFieldNoTitle() {
return [
'text_from_url' => t("Use the link field's URL"),
'text_custom' => t('Use custom text'),
];
}
protected static function getOpenLinkInValues() {
return [
'_self' => t('Open the linked item in the same tab/window'),
'_blank' => t('Open the linked item in a new tab/window'),
'download' => t('Download the linked item'),
];
}
protected static function getLinkTopicValues() {
return [
'any' => t('- Unspecified -'),
'alternate' => t('Alternate form of this item'),
'author' => t('Author information'),
'bookmark' => t('Bookmarkable permalink'),
'canonical' => t('Canonical (preferred) form of this item'),
'help' => t('Help information'),
'license' => t('License information'),
];
}
protected static function getListStyles() {
return [
'span' => t('Single line list'),
'ol' => t('Numbered list'),
'ul' => t('Bulleted list'),
'div' => t('Non-bulleted block list'),
];
}
public static function defaultSettings() {
return array_merge([
'titleStyle' => 'text_from_link',
'titleCustomText' => '',
'classes' => '',
'showLink' => TRUE,
'openLinkIn' => '_self',
'noreferrer' => FALSE,
'noopener' => FALSE,
'nofollow' => FALSE,
'linkTopic' => 'any',
'listStyle' => 'span',
'listSeparator' => ', ',
], parent::defaultSettings());
}
public function settingsSummary() {
$this
->sanitizeSettings();
$isMultiple = $this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple();
$summary = [];
switch ($this
->getSetting('titleStyle')) {
case 'text_from_link':
$summary[] = $this
->t('Show field title');
break;
case 'text_from_url':
$summary[] = $this
->t('Show field URL');
break;
case 'text_custom':
$summary[] = $this
->t('Show custom text');
break;
}
if ($this
->getSetting('showLink') === FALSE) {
$summary[] = $this
->t('No link');
}
else {
switch ($this
->getSetting('openLinkIn')) {
case '_self':
$summary[] = $this
->t('Open in current tab/window');
break;
case '_blank':
$summary[] = $this
->t('Open in new tab/window');
break;
case 'download':
$summary[] = $this
->t('Download');
break;
}
$text = '';
if ($this
->getSetting('noreferrer') === TRUE) {
$text .= 'noreferrer ';
}
if ($this
->getSetting('noopener') === TRUE) {
$text .= 'noopener ';
}
if ($this
->getSetting('nofollow') === TRUE) {
$text .= 'nofollow ';
}
if (empty($text) === FALSE) {
$summary[] = $text;
}
}
if ($isMultiple === TRUE) {
$listStyles = $this
->getListStyles();
$listStyle = $this
->getSetting('listStyle');
$listSeparator = $this
->getSetting('listSeparator');
$text = $listStyles[$listStyle];
if ($listStyle === 'span' && empty($listSeparator) === FALSE) {
$text .= $this
->t(', with separator');
}
$summary[] = $text;
}
return $summary;
}
protected function getDescription() {
$isMultiple = $this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple();
if ($isMultiple === TRUE) {
return $this
->t("Format field values as links that show the title or URL. Multiple field values are shown as a list on one line, bulleted, numbered, or in blocks.");
}
return $this
->t("Format a field value as a link that shows a title or URL.");
}
public function settingsForm(array $form, FormStateInterface $formState) {
$this
->sanitizeSettings();
$fieldSettings = $this
->getFieldSettings();
$isMultiple = $this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple();
$linkIsInternalOnly = FALSE;
if ($fieldSettings['link_type'] === LinkItemInterface::LINK_INTERNAL) {
$linkIsInternalOnly = TRUE;
}
$linkTitleDisabled = FALSE;
if ($fieldSettings['title'] === DRUPAL_DISABLED) {
$linkTitleDisabled = TRUE;
}
$marker = rand();
$elements = [];
$elements = Branding::addFieldFormatterBranding($elements);
$elements['#attached']['library'][] = 'formatter_suite/formatter_suite.fieldformatter';
$elements['description'] = [
'#type' => 'html_tag',
'#tag' => 'div',
'#value' => $this
->getDescription(),
'#weight' => -1000,
'#attributes' => [
'class' => [
'formatter_suite-settings-description',
],
],
];
$weight = 0;
if ($linkTitleDisabled === TRUE) {
$titleStyles = $this
->getTitleStylesFieldNoTitle();
}
else {
$titleStyles = $this
->getTitleStyles();
}
$elements['titleStyle'] = [
'#title' => $this
->t('Link title'),
'#type' => 'select',
'#options' => $titleStyles,
'#default_value' => $this
->getSetting('titleStyle'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-title-style',
],
],
'#attributes' => [
'class' => [
'titleStyle-' . $marker,
],
],
];
$elements['titleCustomText'] = [
'#title' => $this
->t('Custom text'),
'#type' => 'textfield',
'#size' => 10,
'#default_value' => $this
->getSetting('titleCustomText'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-title-custom-text',
],
],
'#states' => [
'visible' => [
'.titleStyle-' . $marker => [
'value' => 'text_custom',
],
],
],
];
$elements['sectionBreak1'] = [
'#markup' => '<div class="formatter_suite-section-break"></div>',
'#weight' => $weight++,
];
$elements['classes'] = [
'#title' => $this
->t('Custom classes'),
'#type' => 'textfield',
'#size' => 10,
'#default_value' => $this
->getSetting('classes'),
'#weight' => $weight++,
'#attributes' => [
'autocomplete' => 'off',
'autocapitalize' => 'none',
'spellcheck' => 'false',
'autocorrect' => 'off',
],
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-classes',
],
],
];
$elements['sectionBreak2'] = [
'#markup' => '<div class="formatter_suite-section-break"></div>',
'#weight' => $weight++,
];
$elements['showLink'] = [
'#title' => $this
->t('Link to the item'),
'#type' => 'checkbox',
'#default_value' => $this
->getSetting('showLink'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-show-link',
],
],
'#attributes' => [
'class' => [
'showLink-' . $marker,
],
],
];
$elements['openLinkIn'] = [
'#title' => $this
->t('Use link to'),
'#type' => 'select',
'#options' => $this
->getOpenLinkInValues(),
'#default_value' => $this
->getSetting('openLinkIn'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-open-link-in',
],
],
'#states' => [
'visible' => [
'.showLink-' . $marker => [
'checked' => TRUE,
],
],
],
];
$elements['linkTopic'] = [
'#title' => $this
->t('Annotate link as'),
'#type' => 'select',
'#options' => $this
->getLinkTopicValues(),
'#default_value' => $this
->getSetting('linkTopic'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-link-topic',
],
],
'#states' => [
'visible' => [
'.showLink-' . $marker => [
'checked' => TRUE,
],
],
],
];
if ($linkIsInternalOnly === FALSE) {
$elements['noreferrer'] = [
'#title' => $this
->t('Do not pass the current site as the referrer ("noreferrer")'),
'#type' => 'checkbox',
'#default_value' => $this
->getSetting('noreferrer'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-noreferrer',
],
],
'#states' => [
'visible' => [
'.showLink-' . $marker => [
'checked' => TRUE,
],
],
],
];
$elements['noopener'] = [
'#title' => $this
->t('Do not share the current page context ("noopener")'),
'#type' => 'checkbox',
'#default_value' => $this
->getSetting('noopener'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-noopener',
],
],
'#states' => [
'visible' => [
'.showLink-' . $marker => [
'checked' => TRUE,
],
],
],
];
}
if ($linkIsInternalOnly === FALSE) {
$elements['nofollow'] = [
'#title' => $this
->t('Do not treat the link as an endorsement ("nofollow")'),
'#type' => 'checkbox',
'#default_value' => $this
->getSetting('nofollow'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-nofollow',
],
],
'#states' => [
'visible' => [
'.showLink-' . $marker => [
'checked' => TRUE,
],
],
],
];
}
if ($isMultiple === TRUE) {
$elements['sectionBreak3'] = [
'#markup' => '<div class="formatter_suite-section-break"></div>',
'#weight' => $weight++,
];
$elements['listStyle'] = [
'#title' => $this
->t('List style'),
'#type' => 'select',
'#options' => $this
->getListStyles(),
'#default_value' => $this
->getSetting('listStyle'),
'#weight' => $weight++,
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-list-style',
],
],
'#attributes' => [
'class' => [
'listStyle-' . $marker,
],
],
];
$elements['listSeparator'] = [
'#title' => $this
->t('Separator'),
'#type' => 'textfield',
'#size' => 10,
'#default_value' => $this
->getSetting('listSeparator'),
'#weight' => $weight++,
'#attributes' => [
'autocomplete' => 'off',
'autocapitalize' => 'none',
'spellcheck' => 'false',
'autocorrect' => 'off',
],
'#wrapper_attributes' => [
'class' => [
'formatter_suite-general-link-list-separator',
],
],
'#states' => [
'visible' => [
'.listStyle-' . $marker => [
'value' => 'span',
],
],
],
];
}
return $elements;
}
protected function sanitizeSettings() {
$fieldSettings = $this
->getFieldSettings();
$isMultiple = $this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple();
$linkIsInternalOnly = FALSE;
if ($fieldSettings['link_type'] === LinkItemInterface::LINK_INTERNAL) {
$linkIsInternalOnly = TRUE;
}
$linkTitleDisabled = FALSE;
if ($fieldSettings['title'] === DRUPAL_DISABLED) {
$linkTitleDisabled = TRUE;
}
$titleStyle = $this
->getSetting('titleStyle');
$showLink = $this
->getSetting('showLink');
$openLinkIn = $this
->getSetting('openLinkIn');
$noreferrer = $this
->getSetting('noreferrer');
$noopener = $this
->getSetting('noopener');
$nofollow = $this
->getSetting('nofollow');
$linkTopic = $this
->getSetting('linkTopic');
if ($linkIsInternalOnly === TRUE) {
$noreferrer = FALSE;
$noopener = FALSE;
$nofollow = FALSE;
}
$defaults = $this
->defaultSettings();
if ($linkTitleDisabled === TRUE) {
$titleStyles = $this
->getTitleStylesFieldNoTitle();
}
else {
$titleStyles = $this
->getTitleStyles();
}
if (empty($titleStyle) === TRUE || isset($titleStyles[$titleStyle]) === FALSE) {
if ($linkTitleDisabled === TRUE) {
$titleStyle = 'text_from_url';
}
else {
$titleStyle = $defaults['titleStyle'];
}
$this
->setSetting('titleStyle', $titleStyle);
}
$openLinkInValues = $this
->getOpenLinkInValues();
if (empty($openLinkIn) === TRUE || isset($openLinkInValues[$openLinkIn]) === FALSE) {
$openLinkIn = $defaults['openLinkIn'];
$this
->setSetting('openLinkIn', $openLinkIn);
}
$linkTopicValues = $this
->getLinkTopicValues();
if (empty($linkTopic) === TRUE || isset($linkTopicValues[$linkTopic]) === FALSE) {
$linkTopic = $defaults['linkTopic'];
$this
->setSetting('linkTopic', $linkTopic);
}
$showLink = boolval($showLink);
$noreferrer = boolval($noreferrer);
$noopener = boolval($noopener);
$nofollow = boolval($nofollow);
$this
->setSetting('showLink', $showLink);
$this
->setSetting('noreferrer', $noreferrer);
$this
->setSetting('noopener', $noopener);
$this
->setSetting('nofollow', $nofollow);
$listStyle = $this
->getSetting('listStyle');
$listStyles = $this
->getListStyles();
if ($isMultiple === TRUE) {
if (empty($listStyle) === TRUE || isset($listStyles[$listStyle]) === FALSE) {
$listStyle = $defaults['listStyle'];
$this
->setSetting('listStyle', $listStyle);
}
}
}
public function viewElements(FieldItemListInterface $items, $langcode) {
if ($items
->isEmpty() === TRUE) {
return [];
}
$this
->sanitizeSettings();
$showLink = $this
->getSetting('showLink');
$entity = $items
->getEntity();
$classes = $this
->getSetting('classes');
if (empty($classes) === TRUE) {
$classes = [];
}
else {
$classes = strip_tags($classes);
$classes = mb_ereg_replace('[^_a-zA-Z0-9- ]', '', $classes);
if ($classes === FALSE) {
$classes = [];
}
$classes = explode(' ', $classes);
}
$elements = [];
foreach ($items as $delta => $item) {
$url = $item
->getUrl();
if (empty($url) === TRUE) {
$url = Url::fromRoute('<none>');
}
$urlOptions = $item->options + $url
->getOptions();
$url
->setOptions($urlOptions);
switch ($this
->getSetting('titleStyle')) {
case 'text_custom':
$title = Xss::filterAdmin($this
->getSetting('titleCustomText'));
if (empty($title) === FALSE) {
$title = new FormattableMarkup($title, []);
break;
}
default:
case 'text_from_link':
$title = $item->title;
if (empty($title) === FALSE) {
$title = new FormattableMarkup($title, []);
break;
}
case 'text_from_url':
$title = $url
->toString();
break;
}
if ($showLink === FALSE) {
$elements[$delta] = [
'#type' => 'html_tag',
'#tag' => 'span',
'#value' => $title,
'#attributes' => [
'class' => $classes,
],
'#cache' => [
'tags' => $entity
->getCacheTags(),
],
];
}
else {
$rel = '';
$target = '';
$download = FALSE;
switch ($this
->getSetting('openLinkIn')) {
case '_self':
$target = '_self';
break;
case '_blank':
$target = '_blank';
break;
case 'download':
$download = TRUE;
break;
}
if ($this
->getSetting('noreferrer') === TRUE) {
$rel .= 'noreferrer ';
}
if ($this
->getSetting('noopener') === TRUE) {
$rel .= 'noopener ';
}
if ($this
->getSetting('nofollow') === TRUE) {
$rel .= 'nofollow ';
}
$topic = $this
->getSetting('linkTopic');
if ($topic !== 'any') {
$rel .= $topic;
}
if (empty($rel) === FALSE) {
$urlOptions['attributes']['rel'] = $rel;
}
if (empty($target) === FALSE) {
$urlOptions['attributes']['target'] = $target;
}
if ($download === TRUE) {
$urlOptions['attributes']['download'] = '';
}
$url
->setOptions($urlOptions);
$elements[$delta] = [
'#type' => 'link',
'#title' => $title,
'#options' => $url
->getOptions(),
'#url' => $url,
'#attributes' => [
'class' => $classes,
],
'#cache' => [
'tags' => $entity
->getCacheTags(),
],
];
if (empty($items[$delta]->_attributes) === FALSE) {
$elements[$delta]['#options'] += [
'attributes' => $items[$delta]->_attributes,
];
unset($items[$delta]->_attributes);
}
}
}
if (empty($elements) === TRUE) {
return [];
}
$isMultiple = $this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple();
if ($isMultiple === TRUE) {
$elements['#theme'] = 'formatter_suite_field_list';
$elements['#list_style'] = $this
->getSetting('listStyle');
$listSeparator = Xss::filterAdmin($this
->getSetting('listSeparator'));
$elements['#list_separator'] = new FormattableMarkup($listSeparator, []);
}
return $elements;
}
}