EntityClassFormatterTest.php in Entity Class Formatter 8

Namespace

Drupal\Tests\entity_class_formatter\Functional

File

tests/src/Functional/EntityClassFormatterTest.php

<?php

namespace Drupal\Tests\entity_class_formatter\Functional;

use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\Tests\BrowserTestBase;

/**
 * @group entity_class_formatter
 */
class EntityClassFormatterTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'entity_class_formatter',
    'field',
    'filter',
    'node',
    'system',
    'text',
    'user',
  ];

  /**
   * Define test class for entity field.
   */
  const ENTITY_CLASS = 'test-entity-field-class';

  /**
   * Define test class for string field.
   */
  const STRING_CLASS = 'test-string-field-class';

  /**
   * Define class prefix.
   */
  const CLASS_PREFIX = 'prefix-';

  /**
   * Define class suffix.
   */
  const CLASS_SUFFIX = '-suffix';

  /**
   * Define test attribute name.
   */
  const ATTR_NAME = 'data-test-attr';

  /**
   * Define test attribute value.
   */
  const ATTR_VALUE = 'test attribute value';

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalCreateContentType([
      'type' => 'page',
      'name' => 'Basic page',
    ]);
    $account = $this
      ->drupalCreateUser([
      'access content',
    ]);
    $this
      ->drupalLogin($account);
  }

  /**
   * {@inheritdoc}
   */
  public function testEntityFieldClass() {
    $field_config = $this
      ->createField('entity_reference');
    $node = $this
      ->drupalCreateNode([
      'title' => self::ENTITY_CLASS,
    ]);
    $entity = $this
      ->drupalCreateNode([
      $field_config
        ->getName() => [
        0 => [
          'target_id' => $node
            ->id(),
        ],
      ],
    ]);
    $entity
      ->save();
    $this
      ->drupalGet($entity
      ->toUrl());
    $assert_session = $this
      ->assertSession();
    $class = self::CLASS_PREFIX . self::ENTITY_CLASS . self::CLASS_SUFFIX;
    $assert_session
      ->elementExists('css', '.node.' . $class);
  }

  /**
   * {@inheritdoc}
   */
  public function testStringFieldClass() {
    $field_config = $this
      ->createField('string');
    $entity = $this
      ->drupalCreateNode([
      $field_config
        ->getName() => [
        0 => [
          'value' => self::STRING_CLASS,
        ],
      ],
    ]);
    $entity
      ->save();
    $this
      ->drupalGet($entity
      ->toUrl());
    $assert_session = $this
      ->assertSession();
    $class = self::CLASS_PREFIX . self::STRING_CLASS . self::CLASS_SUFFIX;
    $assert_session
      ->elementExists('css', '.node.' . $class);
  }

  /**
   * {@inheritdoc}
   */
  public function testAttrValue() {
    $field_config = $this
      ->createField('string', self::ATTR_NAME);
    $entity = $this
      ->drupalCreateNode([
      $field_config
        ->getName() => [
        0 => [
          'value' => self::ATTR_VALUE,
        ],
      ],
    ]);
    $entity
      ->save();
    $this
      ->drupalGet($entity
      ->toUrl());
    $assert_session = $this
      ->assertSession();
    $class = self::CLASS_PREFIX . self::ATTR_VALUE . self::CLASS_SUFFIX;
    $selector = '.node[' . self::ATTR_NAME . '="' . $class . '"]';
    $assert_session
      ->elementExists('css', $selector);
  }

  /**
   * Creates a field and sets the formatter.
   *
   * @param string $field_type
   *   The type of field.
   * @param string $display_attr
   *   The display attribute name.
   *
   * @return \Drupal\field\Entity\FieldConfig
   *   The newly created field.
   */
  protected function createField($field_type, $display_attr = '') {
    $entity_type = 'node';
    $bundle = 'page';
    $field_name = mb_strtolower($this
      ->randomMachineName());
    $field_storage = FieldStorageConfig::create([
      'entity_type' => $entity_type,
      'field_name' => $field_name,
      'type' => $field_type,
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
    ]);
    $field_storage
      ->save();
    $field_config = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => $bundle,
    ]);
    $field_config
      ->save();
    $display = EntityViewDisplay::create([
      'targetEntityType' => $entity_type,
      'bundle' => $bundle,
      'mode' => 'full',
      'status' => TRUE,
    ]);
    $display
      ->setComponent($field_name, [
      'type' => 'entity_class_formatter',
      'settings' => [
        'prefix' => self::CLASS_PREFIX,
        'suffix' => self::CLASS_SUFFIX,
        'attr' => $display_attr,
      ],
    ]);
    $display
      ->save();
    return $field_config;
  }

}

Classes

Name	Description
EntityClassFormatterTest	@group entity_class_formatter