Field.php in Display Suite 8.2

Namespace

Drupal\ds\Plugin\DsField

File

src/Plugin/DsField/Field.php

<?php

namespace Drupal\ds\Plugin\DsField;

use Drupal\Core\Template\Attribute;

/**
 * The base plugin to create DS fields.
 */
abstract class Field extends DsFieldBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $config = $this
      ->getConfiguration();

    // Initialize output.
    $output = '';

    // Basic string.
    $entity_render_key = $this
      ->entityRenderKey();
    if (isset($config['link text'])) {
      $output = $this
        ->t($config['link text']);
    }
    elseif (!empty($entity_render_key) && isset($this
      ->entity()->{$entity_render_key})) {
      if ($this
        ->getEntityTypeId() == 'user' && $entity_render_key == 'name') {
        $output = $this
          ->entity()
          ->getUsername();
      }
      else {
        $output = $this
          ->entity()->{$entity_render_key}->value;
      }
    }
    if (empty($output)) {
      return array();
    }
    $template = <<<TWIG
{% if wrapper %}
<{{ wrapper }}{{ attributes }}>
{% endif %}
{% if is_link %}
  {{ link(output, entity_url) }}
{% else %}
  {{ output }}
{% endif %}
{% if wrapper %}
</{{ wrapper }}>
{% endif %}
TWIG;
    $entity_url = $this
      ->entity()
      ->toUrl();
    if (!empty($config['link class'])) {
      $entity_url
        ->setOption('attributes', [
        'class' => explode(' ', $config['link class']),
      ]);
    }

    // Build the attributes
    $attributes = new Attribute();
    if (!empty($config['class'])) {
      $attributes
        ->addClass($config['class']);
    }
    return [
      '#type' => 'inline_template',
      '#template' => $template,
      '#context' => [
        'is_link' => !empty($config['link']),
        'wrapper' => !empty($config['wrapper']) ? $config['wrapper'] : '',
        'attributes' => $attributes,
        'entity_url' => $this
          ->entity()
          ->toUrl(),
        'output' => $output,
      ],
    ];
  }

  /**
   * Returns the entity render key for this field.
   */
  protected function entityRenderKey() {
    return '';
  }

}

Classes

Name	Description
Field	The base plugin to create DS fields.