StringFormatterTest.php in Zircon Profile 8

Contains \Drupal\field\Tests\String\StringFormatterTest.

Namespace

Drupal\field\Tests\String

File

core/modules/field/src/Tests/String/StringFormatterTest.php

<?php

/**
 * @file
 * Contains \Drupal\field\Tests\String\StringFormatterTest.
 */
namespace Drupal\field\Tests\String;

use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\entity_test\Entity\EntityTestRev;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\simpletest\KernelTestBase;

/**
 * Tests the creation of text fields.
 *
 * @group field
 */
class StringFormatterTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'field',
    'text',
    'entity_test',
    'system',
    'filter',
    'user',
  );

  /**
   * @var string
   */
  protected $entityType;

  /**
   * @var string
   */
  protected $bundle;

  /**
   * @var string
   */
  protected $fieldName;

  /**
   * @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface
   */
  protected $display;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Configure the theme system.
    $this
      ->installConfig(array(
      'system',
      'field',
    ));
    $this
      ->installSchema('system', 'router');
    \Drupal::service('router.builder')
      ->rebuild();
    $this
      ->installEntitySchema('entity_test_rev');
    $this->entityType = 'entity_test_rev';
    $this->bundle = $this->entityType;
    $this->fieldName = Unicode::strtolower($this
      ->randomMachineName());
    $field_storage = FieldStorageConfig::create(array(
      'field_name' => $this->fieldName,
      'entity_type' => $this->entityType,
      'type' => 'string',
    ));
    $field_storage
      ->save();
    $instance = FieldConfig::create(array(
      'field_storage' => $field_storage,
      'bundle' => $this->bundle,
      'label' => $this
        ->randomMachineName(),
    ));
    $instance
      ->save();
    $this->display = entity_get_display($this->entityType, $this->bundle, 'default')
      ->setComponent($this->fieldName, array(
      'type' => 'string',
      'settings' => array(),
    ));
    $this->display
      ->save();
  }

  /**
   * Renders fields of a given entity with a given display.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The entity object with attached fields to render.
   * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display
   *   The display to render the fields in.
   *
   * @return string
   *   The rendered entity fields.
   */
  protected function renderEntityFields(FieldableEntityInterface $entity, EntityViewDisplayInterface $display) {
    $content = $display
      ->build($entity);
    $content = $this
      ->render($content);
    return $content;
  }

  /**
   * Tests string formatter output.
   */
  public function testStringFormatter() {
    $value = $this
      ->randomString();
    $value .= "\n\n<strong>" . $this
      ->randomString() . '</strong>';
    $value .= "\n\n" . $this
      ->randomString();
    $entity = EntityTestRev::create(array());
    $entity->{$this->fieldName}->value = $value;

    // Verify that all HTML is escaped and newlines are retained.
    $this
      ->renderEntityFields($entity, $this->display);
    $this
      ->assertNoRaw($value);
    $this
      ->assertRaw(nl2br(Html::escape($value)));

    // Verify the cache tags.
    $build = $entity->{$this->fieldName}
      ->view();
    $this
      ->assertTrue(!isset($build[0]['#cache']), 'The string formatter has no cache tags.');
    $value = $this
      ->randomMachineName();
    $entity->{$this->fieldName}->value = $value;
    $entity
      ->save();

    // Set the formatter to link to the entity.
    $this->display
      ->setComponent($this->fieldName, [
      'type' => 'string',
      'settings' => [
        'link_to_entity' => TRUE,
      ],
    ]);
    $this->display
      ->save();
    $this
      ->renderEntityFields($entity, $this->display);
    $this
      ->assertLink($value, 0);
    $this
      ->assertLinkByHref($entity
      ->url());

    // $entity->url('revision') falls back to the canonical URL if this is no
    // revision.
    $this
      ->assertLinkByHref($entity
      ->url('revision'));

    // Make the entity a new revision.
    $old_revision_id = $entity
      ->getRevisionId();
    $entity
      ->setNewRevision(TRUE);
    $value2 = $this
      ->randomMachineName();
    $entity->{$this->fieldName}->value = $value2;
    $entity
      ->save();
    $entity_new_revision = \Drupal::entityManager()
      ->getStorage('entity_test_rev')
      ->loadRevision($old_revision_id);
    $this
      ->renderEntityFields($entity, $this->display);
    $this
      ->assertLink($value2, 0);
    $this
      ->assertLinkByHref($entity
      ->url('revision'));
    $this
      ->renderEntityFields($entity_new_revision, $this->display);
    $this
      ->assertLink($value, 0);
    $this
      ->assertLinkByHref('/entity_test_rev/' . $entity_new_revision
      ->id() . '/revision/' . $entity_new_revision
      ->getRevisionId() . '/view');
  }

}

Classes

Name	Description
StringFormatterTest	Tests the creation of text fields.