FieldTypePluginManagerTest.php in Drupal 8

Namespace

Drupal\Tests\field\Kernel

File

core/modules/field/tests/src/Kernel/FieldTypePluginManagerTest.php

<?php

namespace Drupal\Tests\field\Kernel;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Extension\ExtensionDiscovery;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\entity_test\Entity\EntityTest;
use Drupal\Tests\DeprecatedModulesTestTrait;

/**
 * Tests the field type manager.
 *
 * @group field
 */
class FieldTypePluginManagerTest extends FieldKernelTestBase {
  use DeprecatedModulesTestTrait;

  /**
   * Tests the default settings convenience methods.
   */
  public function testDefaultSettings() {
    $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
    foreach ([
      'test_field',
      'shape',
      'hidden_test_field',
    ] as $type) {
      $definition = $field_type_manager
        ->getDefinition($type);
      $this
        ->assertIdentical($field_type_manager
        ->getDefaultStorageSettings($type), $definition['class']::defaultStorageSettings(), new FormattableMarkup("%type storage settings were returned", [
        '%type' => $type,
      ]));
      $this
        ->assertIdentical($field_type_manager
        ->getDefaultFieldSettings($type), $definition['class']::defaultFieldSettings(), new FormattableMarkup(" %type field settings were returned", [
        '%type' => $type,
      ]));
    }
  }

  /**
   * Tests creation of field item instances.
   */
  public function testCreateInstance() {

    /** @var \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager */
    $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
    foreach ([
      'test_field',
      'shape',
      'hidden_test_field',
    ] as $type) {
      $definition = $field_type_manager
        ->getDefinition($type);
      $class = $definition['class'];
      $field_name = 'field_' . $type;
      $field_definition = BaseFieldDefinition::create($type);
      $configuration = [
        'field_definition' => $field_definition,
        'name' => $field_name,
        'parent' => NULL,
      ];
      $instance = $field_type_manager
        ->createInstance($type, $configuration);
      $this
        ->assertInstanceOf($class, $instance);
      $this
        ->assertEqual($field_name, $instance
        ->getName(), new FormattableMarkup('Instance name is @name', [
        '@name' => $field_name,
      ]));
    }
  }

  /**
   * Tests creation of field item instances.
   */
  public function testCreateInstanceWithConfig() {

    /** @var \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager */
    $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
    $type = 'test_field';
    $definition = $field_type_manager
      ->getDefinition($type);
    $class = $definition['class'];
    $field_name = 'field_' . $type;
    $field_definition = BaseFieldDefinition::create($type)
      ->setLabel('Jenny')
      ->setDefaultValue(8675309);
    $configuration = [
      'field_definition' => $field_definition,
      'name' => $field_name,
      'parent' => NULL,
    ];
    $entity = EntityTest::create();
    $instance = $field_type_manager
      ->createInstance($type, $configuration);
    $this
      ->assertInstanceOf($class, $instance);
    $this
      ->assertEqual($field_name, $instance
      ->getName(), new FormattableMarkup('Instance name is @name', [
      '@name' => $field_name,
    ]));
    $this
      ->assertEqual($instance
      ->getFieldDefinition()
      ->getLabel(), 'Jenny', 'Instance label is Jenny');
    $this
      ->assertEqual($instance
      ->getFieldDefinition()
      ->getDefaultValue($entity), [
      [
        'value' => 8675309,
      ],
    ], 'Instance default_value is 8675309');
  }

  /**
   * Tests all field items provide an existing main property.
   */
  public function testMainProperty() {

    // Let's enable all Drupal modules in Drupal core, so we test any field
    // type plugin.
    $this
      ->enableAllCoreModules();

    /** @var \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager */
    $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
    foreach ($field_type_manager
      ->getDefinitions() as $plugin_id => $definition) {
      $class = $definition['class'];
      $property = $class::mainPropertyName();
      $storage_definition = BaseFieldDefinition::create($plugin_id);
      $property_definitions = $class::propertyDefinitions($storage_definition);
      $properties = implode(', ', array_keys($property_definitions));
      if (!empty($property_definitions)) {
        $message = sprintf("%s property %s found in %s", $plugin_id, $property, $properties);
        $this
          ->assertArrayHasKey($property, $class::propertyDefinitions($storage_definition), $message);
      }
    }
  }

  /**
   * Enable all core modules.
   */
  protected function enableAllCoreModules() {
    $listing = new ExtensionDiscovery($this->root);
    $module_list = $listing
      ->scan('module', FALSE);

    /** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
    $module_handler = $this->container
      ->get('module_handler');
    $module_list = array_filter(array_keys($module_list), function ($module) use ($module_handler, $module_list) {
      return !$module_handler
        ->moduleExists($module) && substr($module_list[$module]
        ->getPath(), 0, 4) === 'core';
    });
    $this
      ->enableModules($module_list);
  }

}

Classes

Name	Description
FieldTypePluginManagerTest	Tests the field type manager.