class FieldResolverTest

Same name and namespace in other branches
  1. 10 core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php \Drupal\Tests\jsonapi\Kernel\Context\FieldResolverTest
  2. 11.x core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php \Drupal\Tests\jsonapi\Kernel\Context\FieldResolverTest
  3. 9 core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php \Drupal\Tests\jsonapi\Kernel\Context\FieldResolverTest
  4. 8.9.x core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php \Drupal\Tests\jsonapi\Kernel\Context\FieldResolverTest

Tests Drupal\jsonapi\Context\FieldResolver.

@internal

Attributes

#[CoversClass(FieldResolver::class)] #[Group('jsonapi')] #[RunTestsInSeparateProcesses]

Hierarchy

Expanded class hierarchy of FieldResolverTest

File

core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php, line 23

Namespace

Drupal\Tests\jsonapi\Kernel\Context
View source
class FieldResolverTest extends JsonapiKernelTestBase {
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'entity_test',
    'field',
    'jsonapi_test_field_aliasing',
    'jsonapi_test_field_filter_access',
    'serialization',
    'text',
    'user',
  ];
  
  /**
   * The subject under test.
   *
   * @var \Drupal\jsonapi\Context\FieldResolver
   */
  protected $sut;
  
  /**
   * The JSON:API resource type repository.
   *
   * @var \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface
   */
  protected $resourceTypeRepository;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->installEntitySchema('entity_test_with_bundle');
    $this->sut = \Drupal::service('jsonapi.field_resolver');
    $this->makeBundle('bundle1');
    $this->makeBundle('bundle2');
    $this->makeBundle('bundle3');
    $this->makeField('string', 'field_test1', 'entity_test_with_bundle', [
      'bundle1',
    ]);
    $this->makeField('string', 'field_test2', 'entity_test_with_bundle', [
      'bundle1',
    ]);
    $this->makeField('string', 'field_test3', 'entity_test_with_bundle', [
      'bundle2',
      'bundle3',
    ]);
    // Provides entity reference fields.
    $settings = [
      'target_type' => 'entity_test_with_bundle',
    ];
    $this->makeField('entity_reference', 'field_test_ref1', 'entity_test_with_bundle', [
      'bundle1',
    ], $settings, [
      'handler_settings' => [
        'target_bundles' => [
          'bundle2',
          'bundle3',
        ],
      ],
    ]);
    $this->makeField('entity_reference', 'field_test_ref2', 'entity_test_with_bundle', [
      'bundle1',
    ], $settings);
    $this->makeField('entity_reference', 'field_test_ref3', 'entity_test_with_bundle', [
      'bundle2',
      'bundle3',
    ], $settings);
    // Add a field with multiple properties.
    $this->makeField('text', 'field_test_text', 'entity_test_with_bundle', [
      'bundle1',
      'bundle2',
    ]);
    // Add two fields that have different internal names but have the same
    // public name.
    $this->makeField('entity_reference', 'field_test_alias_a', 'entity_test_with_bundle', [
      'bundle2',
    ], $settings);
    $this->makeField('entity_reference', 'field_test_alias_b', 'entity_test_with_bundle', [
      'bundle3',
    ], $settings);
    $this->resourceTypeRepository = $this->container
      ->get('jsonapi.resource_type.repository');
  }
  
  /**
   * Tests resolve internal include path.
   *
   * @legacy-covers ::resolveInternalEntityQueryPath
   */
  public function testResolveInternalIncludePath(array $expect, string $external_path, $entity_type_id = 'entity_test_with_bundle', $bundle = 'bundle1') : void {
    $path_parts = explode('.', $external_path);
    $resource_type = $this->resourceTypeRepository
      ->get($entity_type_id, $bundle);
    $this->assertEquals($expect, $this->sut
      ->resolveInternalIncludePath($resource_type, $path_parts));
  }
  
  /**
   * Provides test cases for resolveInternalEntityQueryPath.
   */
  public static function resolveInternalIncludePathProvider() : array {
    return [
      'entity reference' => [
        [
          [
            'field_test_ref2',
          ],
        ],
        'field_test_ref2',
      ],
      'entity reference with multi target bundles' => [
        [
          [
            'field_test_ref1',
          ],
        ],
        'field_test_ref1',
      ],
      'entity reference then another entity reference' => [
        [
          [
            'field_test_ref1',
            'field_test_ref3',
          ],
        ],
        'field_test_ref1.field_test_ref3',
      ],
      'entity reference with multiple target bundles, each with different field, but the same public field name' => [
        [
          [
            'field_test_ref1',
            'field_test_alias_a',
          ],
          [
            'field_test_ref1',
            'field_test_alias_b',
          ],
        ],
        'field_test_ref1.field_test_alias',
      ],
    ];
  }
  
  /**
   * Expects an error when an invalid field is provided for include.
   *
   * @param string $entity_type
   *   The entity type for which to test field resolution.
   * @param string $bundle
   *   The entity bundle for which to test field resolution.
   * @param string $external_path
   *   The external field path to resolve.
   * @param string $expected_message
   *   (optional) An expected exception message.
   */
  public function testResolveInternalIncludePathError(string $entity_type, string $bundle, string $external_path, string $expected_message = '') : void {
    $path_parts = explode('.', $external_path);
    $this->expectException(CacheableBadRequestHttpException::class);
    if (!empty($expected_message)) {
      $this->expectExceptionMessage($expected_message);
    }
    $resource_type = $this->resourceTypeRepository
      ->get($entity_type, $bundle);
    $this->sut
      ->resolveInternalIncludePath($resource_type, $path_parts);
  }
  
  /**
   * Provides test cases for ::testResolveInternalIncludePathError.
   */
  public static function resolveInternalIncludePathErrorProvider() : array {
    return [
      // Should fail because none of these bundles have these fields.
[
        'entity_test_with_bundle',
        'bundle1',
        'host.fail!!.deep',
      ],
      [
        'entity_test_with_bundle',
        'bundle2',
        'field_test_ref2',
      ],
      [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref3',
      ],
      // Should fail because the nested fields don't exist on the targeted
      // resource types.
[
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test1',
      ],
      [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test2',
      ],
      [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test_ref1',
      ],
      [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test_ref2',
      ],
      // Should fail because the nested fields is not a valid relationship
      // field name.
[
        'entity_test_with_bundle',
        'bundle1',
        'field_test1',
        '`field_test1` is not a valid relationship field name.',
      ],
      // Should fail because the nested fields is not a valid include path.
[
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test3',
        '`field_test_ref1.field_test3` is not a valid include path.',
      ],
    ];
  }
  
  /**
   * Tests resolve internal entity query path.
   */
  public function testResolveInternalEntityQueryPath(string $expect, string $external_path, string $entity_type_id = 'entity_test_with_bundle', string $bundle = 'bundle1') : void {
    $resource_type = $this->resourceTypeRepository
      ->get($entity_type_id, $bundle);
    $this->assertEquals($expect, $this->sut
      ->resolveInternalEntityQueryPath($resource_type, $external_path));
  }
  
  /**
   * Provides test cases for ::testResolveInternalEntityQueryPath.
   */
  public static function resolveInternalEntityQueryPathProvider() : array {
    return [
      'config entity as base' => [
        'uuid',
        'id',
        'entity_test_bundle',
        'entity_test_bundle',
      ],
      'config entity as target' => [
        'type.entity:entity_test_bundle.uuid',
        'type.id',
      ],
      'primitive field; variation A' => [
        'field_test1',
        'field_test1',
      ],
      'primitive field; variation B' => [
        'field_test2',
        'field_test2',
      ],
      'entity reference then a primitive field; variation A' => [
        'field_test_ref2.entity:entity_test_with_bundle.field_test1',
        'field_test_ref2.field_test1',
      ],
      'entity reference then a primitive field; variation B' => [
        'field_test_ref2.entity:entity_test_with_bundle.field_test2',
        'field_test_ref2.field_test2',
      ],
      'entity reference then a complex field with property specifier `value`' => [
        'field_test_ref2.entity:entity_test_with_bundle.field_test_text.value',
        'field_test_ref2.field_test_text.value',
      ],
      'entity reference then a complex field with property specifier `format`' => [
        'field_test_ref2.entity:entity_test_with_bundle.field_test_text.format',
        'field_test_ref2.field_test_text.format',
      ],
      'entity reference then no delta with property specifier `id`' => [
        'field_test_ref1.entity:entity_test_with_bundle.uuid',
        'field_test_ref1.id',
      ],
      'entity reference then delta 0 with property specifier `id`' => [
        'field_test_ref1.0.entity:entity_test_with_bundle.uuid',
        'field_test_ref1.0.id',
      ],
      'entity reference then delta 1 with property specifier `id`' => [
        'field_test_ref1.1.entity:entity_test_with_bundle.uuid',
        'field_test_ref1.1.id',
      ],
      'entity reference then no reference property and a complex field with property specifier `value`' => [
        'field_test_ref1.entity:entity_test_with_bundle.field_test_text.value',
        'field_test_ref1.field_test_text.value',
      ],
      'entity reference then a reference property and a complex field with property specifier `value`' => [
        'field_test_ref1.entity.field_test_text.value',
        'field_test_ref1.entity.field_test_text.value',
      ],
      'entity reference then no reference property and a complex field with property specifier `format`' => [
        'field_test_ref1.entity:entity_test_with_bundle.field_test_text.format',
        'field_test_ref1.field_test_text.format',
      ],
      'entity reference then a reference property and a complex field with property specifier `format`' => [
        'field_test_ref1.entity.field_test_text.format',
        'field_test_ref1.entity.field_test_text.format',
      ],
      'entity reference then property specifier `entity:entity_test_with_bundle` then a complex field with property specifier `value`' => [
        'field_test_ref1.entity:entity_test_with_bundle.field_test_text.value',
        'field_test_ref1.entity:entity_test_with_bundle.field_test_text.value',
      ],
      'entity reference with a delta and no reference property then a complex field and property specifier `value`' => [
        'field_test_ref1.0.entity:entity_test_with_bundle.field_test_text.value',
        'field_test_ref1.0.field_test_text.value',
      ],
      'entity reference with a delta and a reference property then a complex field and property specifier `value`' => [
        'field_test_ref1.0.entity.field_test_text.value',
        'field_test_ref1.0.entity.field_test_text.value',
      ],
      'entity reference with no reference property then another entity reference with no reference property a complex field with property specifier `value`' => [
        'field_test_ref1.entity:entity_test_with_bundle.field_test_ref3.entity:entity_test_with_bundle.field_test_text.value',
        'field_test_ref1.field_test_ref3.field_test_text.value',
      ],
      'entity reference with a reference property then another entity reference with no reference property a complex field with property specifier `value`' => [
        'field_test_ref1.entity.field_test_ref3.entity:entity_test_with_bundle.field_test_text.value',
        'field_test_ref1.entity.field_test_ref3.field_test_text.value',
      ],
      'entity reference with no reference property then another entity reference with a reference property a complex field with property specifier `value`' => [
        'field_test_ref1.entity:entity_test_with_bundle.field_test_ref3.entity.field_test_text.value',
        'field_test_ref1.field_test_ref3.entity.field_test_text.value',
      ],
      'entity reference with a reference property then another entity reference with a reference property a complex field with property specifier `value`' => [
        'field_test_ref1.entity.field_test_ref3.entity.field_test_text.value',
        'field_test_ref1.entity.field_test_ref3.entity.field_test_text.value',
      ],
      'entity reference with target bundles then property specifier `entity:entity_test_with_bundle` then a primitive field on multiple bundles' => [
        'field_test_ref1.entity:entity_test_with_bundle.field_test3',
        'field_test_ref1.entity:entity_test_with_bundle.field_test3',
      ],
      'entity reference without target bundles then property specifier `entity:entity_test_with_bundle` then a primitive field on a single bundle' => [
        'field_test_ref2.entity:entity_test_with_bundle.field_test1',
        'field_test_ref2.entity:entity_test_with_bundle.field_test1',
      ],
      'entity reference without target bundles then property specifier `entity:entity_test_with_bundle` then a primitive field on multiple bundles' => [
        'field_test_ref3.entity:entity_test_with_bundle.field_test3',
        'field_test_ref3.entity:entity_test_with_bundle.field_test3',
        'entity_test_with_bundle',
        'bundle2',
      ],
      'entity reference without target bundles then property specifier `entity:entity_test_with_bundle` then a primitive field on a single bundle starting from a different resource type' => [
        'field_test_ref3.entity:entity_test_with_bundle.field_test2',
        'field_test_ref3.entity:entity_test_with_bundle.field_test2',
        'entity_test_with_bundle',
        'bundle3',
      ],
      'entity reference then property specifier `entity:entity_test_with_bundle` then another entity reference before a primitive field' => [
        'field_test_ref1.entity:entity_test_with_bundle.field_test_ref3.entity:entity_test_with_bundle.field_test2',
        'field_test_ref1.entity:entity_test_with_bundle.field_test_ref3.field_test2',
      ],
    ];
  }
  
  /**
   * Expects an error when an invalid field is provided for filter and sort.
   *
   * @param string $entity_type
   *   The entity type for which to test field resolution.
   * @param string $bundle
   *   The entity bundle for which to test field resolution.
   * @param string $external_path
   *   The external field path to resolve.
   * @param string $expected_message
   *   (optional) An expected exception message.
   */
  public function testResolveInternalEntityQueryPathError(string $entity_type, string $bundle, string $external_path, string $expected_message = '') : void {
    $this->expectException(CacheableBadRequestHttpException::class);
    if (!empty($expected_message)) {
      $this->expectExceptionMessage($expected_message);
    }
    $resource_type = $this->resourceTypeRepository
      ->get($entity_type, $bundle);
    $this->sut
      ->resolveInternalEntityQueryPath($resource_type, $external_path);
  }
  
  /**
   * Provides test cases for ::testResolveInternalEntityQueryPathError.
   */
  public static function resolveInternalEntityQueryPathErrorProvider() : array {
    return [
      'nested fields' => [
        'entity_test_with_bundle',
        'bundle1',
        'none.of.these.exist',
      ],
      'field does not exist on bundle' => [
        'entity_test_with_bundle',
        'bundle2',
        'field_test_ref2',
      ],
      'field does not exist on different bundle' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref3',
      ],
      'field does not exist on targeted bundle' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test1',
      ],
      'different field does not exist on same targeted bundle' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test2',
      ],
      'entity reference field does not exist on targeted bundle' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test_ref1',
      ],
      'different entity reference field does not exist on same targeted bundle' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test_ref2',
      ],
      'message correctly identifies missing field' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.entity:entity_test_with_bundle.field_test1',
        'Invalid nested filtering. The field `field_test1`, given in the path `field_test_ref1.entity:entity_test_with_bundle.field_test1`, does not exist.',
      ],
      'message correctly identifies different missing field' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.entity:entity_test_with_bundle.field_test2',
        'Invalid nested filtering. The field `field_test2`, given in the path `field_test_ref1.entity:entity_test_with_bundle.field_test2`, does not exist.',
      ],
      'message correctly identifies missing entity reference field' => [
        'entity_test_with_bundle',
        'bundle2',
        'field_test_ref1.entity:entity_test_with_bundle.field_test2',
        'Invalid nested filtering. The field `field_test_ref1`, given in the path `field_test_ref1.entity:entity_test_with_bundle.field_test2`, does not exist.',
      ],
      'entity reference then a complex field with no property specifier' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref2.field_test_text',
        'Invalid nested filtering. The field `field_test_text`, given in the path `field_test_ref2.field_test_text` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.',
      ],
      'entity reference then no delta with property specifier `target_id`' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.target_id',
        'Invalid nested filtering. The field `target_id`, given in the path `field_test_ref1.target_id`, does not exist.',
      ],
      'entity reference then delta 0 with property specifier `target_id`' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.0.target_id',
        'Invalid nested filtering. The field `target_id`, given in the path `field_test_ref1.0.target_id`, does not exist.',
      ],
      'entity reference then delta 1 with property specifier `target_id`' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.1.target_id',
        'Invalid nested filtering. The field `target_id`, given in the path `field_test_ref1.1.target_id`, does not exist.',
      ],
      'entity reference then no reference property then a complex field' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.field_test_text',
        'Invalid nested filtering. The field `field_test_text`, given in the path `field_test_ref1.field_test_text` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.',
      ],
      'entity reference then reference property then a complex field' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.entity.field_test_text',
        'Invalid nested filtering. The field `field_test_text`, given in the path `field_test_ref1.entity.field_test_text` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.',
      ],
      'entity reference then property specifier `entity:entity_test_with_bundle` then a complex field' => [
        'entity_test_with_bundle',
        'bundle1',
        'field_test_ref1.entity:entity_test_with_bundle.field_test_text',
        'Invalid nested filtering. The field `field_test_text`, given in the path `field_test_ref1.entity:entity_test_with_bundle.field_test_text` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.',
      ],
    ];
  }
  
  /**
   * Create a simple bundle.
   *
   * @param string $name
   *   The name of the bundle to create.
   */
  protected function makeBundle($name) : void {
    EntityTestBundle::create([
      'id' => $name,
    ])->save();
  }
  
  /**
   * Creates a field for a specified entity type/bundle.
   *
   * @param string $type
   *   The field type.
   * @param string $name
   *   The name of the field to create.
   * @param string $entity_type
   *   The entity type to which the field will be attached.
   * @param string[] $bundles
   *   The entity bundles to which the field will be attached.
   * @param array $storage_settings
   *   Custom storage settings for the field.
   * @param array $config_settings
   *   Custom configuration settings for the field.
   */
  protected function makeField($type, $name, $entity_type, array $bundles, array $storage_settings = [], array $config_settings = []) : void {
    $storage_config = [
      'field_name' => $name,
      'type' => $type,
      'entity_type' => $entity_type,
      'settings' => $storage_settings,
    ];
    FieldStorageConfig::create($storage_config)->save();
    foreach ($bundles as $bundle) {
      FieldConfig::create([
        'field_name' => $name,
        'entity_type' => $entity_type,
        'bundle' => $bundle,
        'settings' => $config_settings,
      ])->save();
    }
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content.
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::getTestMethodCaller protected function Retrieves the current calling line in the class under test. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DrupalTestCaseTrait::$root protected property The Drupal root directory.
DrupalTestCaseTrait::checkErrorHandlerOnTearDown public function Checks the test error handler after test execution. 1
DrupalTestCaseTrait::getDrupalRoot protected static function Returns the Drupal root directory. 1
DrupalTestCaseTrait::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldResolverTest::$modules protected static property Modules to install. Overrides JsonapiKernelTestBase::$modules
FieldResolverTest::$resourceTypeRepository protected property The JSON:API resource type repository.
FieldResolverTest::$sut protected property The subject under test.
FieldResolverTest::makeBundle protected function Create a simple bundle.
FieldResolverTest::makeField protected function Creates a field for a specified entity type/bundle.
FieldResolverTest::resolveInternalEntityQueryPathErrorProvider public static function Provides test cases for ::testResolveInternalEntityQueryPathError.
FieldResolverTest::resolveInternalEntityQueryPathProvider public static function Provides test cases for ::testResolveInternalEntityQueryPath.
FieldResolverTest::resolveInternalIncludePathErrorProvider public static function Provides test cases for ::testResolveInternalIncludePathError.
FieldResolverTest::resolveInternalIncludePathProvider public static function Provides test cases for resolveInternalEntityQueryPath.
FieldResolverTest::setUp protected function Overrides KernelTestBase::setUp
FieldResolverTest::testResolveInternalEntityQueryPath public function Tests resolve internal entity query path.
FieldResolverTest::testResolveInternalEntityQueryPathError public function Expects an error when an invalid field is provided for filter and sort.
FieldResolverTest::testResolveInternalIncludePath public function Tests resolve internal include path.
FieldResolverTest::testResolveInternalIncludePathError public function Expects an error when an invalid field is provided for include.
HttpKernelUiHelperTrait::$mink protected property Mink session manager.
HttpKernelUiHelperTrait::assertSession public function Returns WebAssert object.
HttpKernelUiHelperTrait::buildUrl protected function Builds a URL from a system path or a URL object.
HttpKernelUiHelperTrait::clickLink protected function Follows a link by complete name.
HttpKernelUiHelperTrait::drupalGet protected function Retrieves a Drupal path.
HttpKernelUiHelperTrait::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
HttpKernelUiHelperTrait::getNodeElementsByXpath protected function Performs an xpath search on the contents of the internal browser.
HttpKernelUiHelperTrait::getSession public function Returns Mink session.
HttpKernelUiHelperTrait::getUrl protected function Gets the current URL from the browser.
HttpKernelUiHelperTrait::initMink protected function Initializes Mink sessions.
JsonapiKernelTestBase::createTextField protected function Creates a field of a text field storage on the bundle.
KernelTestBase::$classLoader protected property The class loader.
KernelTestBase::$configImporter protected property The configuration importer.
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property The test container.
KernelTestBase::$databasePrefix protected property The test database prefix.
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$siteDirectory protected property The relative path to the test site directory.
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 1
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 2
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function Gets the database prefix used for test isolation.
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable protected static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 40
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 10
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.